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.

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

add user agent to OTLP exporter spec #2684

Merged
merged 12 commits into from
Sep 20, 2022

Conversation

codeboten
Copy link
Contributor

Changes

The following PR adds a section to the OTLP exporter about setting a user agent. This was implemented in the otel collector and provides users with additional information to troubleshoot their telemetry pipelines with. This was discussed in the context of #2501. It's worth noting that the OpenTelemetry collector is currently setting a user agent in the format:

OpenTelemetry Collector Contrib/0.53.0 (linux/amd64) grpc-go/1.47.0

Additionally, existing exporters are already sending this header (using whatever the underlying library is setting), it's just not set to anything OpenTelemetry specific.

Related issues #2501

@codeboten codeboten requested review from a team July 21, 2022 19:33
@codeboten codeboten force-pushed the codeboten/user-agent branch from 707b95f to 84bcb39 Compare July 21, 2022 19:35
@arminru arminru added area:sdk Related to the SDK spec:protocol Related to the specification/protocol directory labels Aug 2, 2022
@carlosalberto
Copy link
Contributor

Overall good, but we need more eyes on this.

@open-telemetry/specs-approvers please take a look.

The following PR adds a section to the OTLP exporter about setting a user agent. This was implemented in the otel collector and provides users with additional information to troubleshoot their telemetry pipelines with.
@codeboten codeboten force-pushed the codeboten/user-agent branch from f5a5afa to e950aef Compare August 8, 2022 14:18
@bogdandrutu
Copy link
Member

I would make this an "option" maybe opt-out.

@codeboten
Copy link
Contributor Author

codeboten commented Aug 9, 2022

I would make this an "option" maybe opt-out.

@bogdandrutu today most (i believe at least all grpc and many http) OTLP exporters already have a user agent header, something like grpc-go/1.47.0, and there is no way to opt out. This PR is suggesting that the exporters should provide something more meaningful.

specification/protocol/exporter.md Show resolved Hide resolved
specification/protocol/exporter.md Show resolved Hide resolved
specification/protocol/exporter.md Outdated Show resolved Hide resolved
@carlosalberto
Copy link
Contributor

@bogdandrutu Any further opinion on this?

specification/protocol/exporter.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Sep 6, 2022

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Sep 6, 2022
@reyang reyang removed the Stale label Sep 15, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@carlosalberto carlosalberto merged commit c7ce609 into open-telemetry:main Sep 20, 2022
@codeboten codeboten deleted the codeboten/user-agent branch September 26, 2022 16:53
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
* add user agent to OTLP exporter spec

The following PR adds a section to the OTLP exporter about setting a user agent. This was implemented in the otel collector and provides users with additional information to troubleshoot their telemetry pipelines with.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:sdk Related to the SDK spec:protocol Related to the specification/protocol directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.