Skip to content

feat(exporters): add user-agent enrichment #4560

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(exporters): add user-agent enrichment #4560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions specification/protocol/exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,21 @@ OTel-OTLP-Exporter-Python/1.2.3

The format of the header SHOULD follow [RFC 7231][rfc-7231]. The conventions used for specifying the OpenTelemetry SDK language and version are available in the [Resource semantic conventions][resource-semconv].

Exporters MAY expose a configuration option to append a product identifier to the User-Agent
header as defined in [RFC 7231][rfc-7231]. Such option should not be available as
an environment variable since is meant to be used by [distributions][opentelemetry-distribution]
to append their product identifier along with the exporter's one.

SDKs MAY expose a similar configuration option if exporters have it. This configuration
MUST be overridable by a signal specific option.

As an example setting the option to `MyDistribution/x.y.z` in the exporter from the
above example would report the following:

```
OTel-OTLP-Exporter-Python/1.2.3 MyDistribution/x.y.z
```

[Boolean]: ../configuration/sdk-environment-variables.md#boolean
[Timeout]: ../configuration/sdk-environment-variables.md#timeout
[String]: ../configuration/sdk-environment-variables.md#string
Expand All @@ -221,3 +236,4 @@ The format of the header SHOULD follow [RFC 7231][rfc-7231]. The conventions use
[otlp-http]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md#otlphttp
[retryable-grpc-status-codes]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md#failures
[retryable-http-status-codes]: https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md#failures-1
[opentelemetry-distribution]: https://github.com/open-telemetry/opentelemetry.io/edit/main/content/en/docs/concepts/distributions.md#what-is-a-distribution
Loading