Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(instrumentation): add option to overwrite otlp service name/namespace/version with env var #29583

Merged
merged 7 commits into from
Jun 12, 2024
Merged

feat(instrumentation): add option to overwrite otlp service name/namespace/version with env var #29583

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5c2fde8
add option to overwrite otlp service name/namespace/version with env var
KyriosGN0 Jun 10, 2024
c63247d
simplifed if condition
KyriosGN0 Jun 11, 2024
a05f82f
added docs for new env var
KyriosGN0 Jun 11, 2024
959215f
add default to docs
KyriosGN0 Jun 11, 2024
987cfa8
reformat docs
KyriosGN0 Jun 11, 2024
99a439b
Update docs/usage/opentelemetry.md
KyriosGN0 Jun 11, 2024
98330de
Update docs/usage/opentelemetry.md
secustor Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/usage/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ This means that Renovate sends traces via [OTLP/HTTP](https://opentelemetry.io/d
To activate the instrumentation, you must set the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable.
This variable controls the endpoint for the telemetry data.
Once this endpoint is set, you can use all environment variables listed in the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md).
You can also set the following environment variables:
OTEL_SERVICE_NAME: to control the service name that will be emitted in traces, defaults to `renovate`
OTEL_SERVICE_NAMESPACE: to control the service namespace that will be emitted in traces, defaults to `renovatebot.com`
OTEL_SERVICE_VERSION: to control the service version that will be emitted in traces, defaults to using the pkg version
KyriosGN0 marked this conversation as resolved.
Show resolved Hide resolved

## Debugging

Expand Down
9 changes: 6 additions & 3 deletions lib/instrumentation/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@ export function init(): void {
const traceProvider = new NodeTracerProvider({
resource: new Resource({
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value
[SemanticResourceAttributes.SERVICE_NAME]: 'renovate',
[SemanticResourceAttributes.SERVICE_NAMESPACE]: 'renovatebot.com',
[SemanticResourceAttributes.SERVICE_VERSION]: pkg.version,
[SemanticResourceAttributes.SERVICE_NAME]:
process.env.OTEL_SERVICE_NAME ?? 'renovate',
[SemanticResourceAttributes.SERVICE_NAMESPACE]:
process.env.OTEL_SERVICE_NAMESPACE ?? 'renovatebot.com',
[SemanticResourceAttributes.SERVICE_VERSION]:
process.env.OTEL_SERVICE_VERSION ?? pkg.version,
}),
});

Expand Down