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

correct exporter user-agent example #3052

Merged
merged 3 commits into from
Jan 4, 2023

Conversation

robbkidd
Copy link
Member

Changes

Removes spaces from the example exporter User-Agent string to conform to header field value component definition.

While this section about a User-Agent references RFC7231 for format, the example provided includes spaces in the product identifier. The format for product is as a token, defined in RFC7230, which does not include space in the set of valid characters. Including spaces here will throw off most existing user-agent parsing.

Related issues: example added in #2684

While this section about a User-Agent references RFC7231[1] for format, the
example provided includes spaces in the product identifier. The product
identifier comes in the form of a token, defined in RFC7230[2]. Including
spaces will throw off most existing user-agent parsing.

[1] https://datatracker.ietf.org/doc/html/rfc7231#section-5.5.3
[2] https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6
@robbkidd robbkidd requested review from a team December 21, 2022 00:08
@arminru arminru added spec:protocol Related to the specification/protocol directory area:sdk Related to the SDK bug Something isn't working labels Dec 21, 2022
@arminru
Copy link
Member

arminru commented Dec 21, 2022

Thank you!

Please also add an entry in CHANGELOG.md so SDK and exporter implementors are made aware of the fix, even if it's just in the example.

@carlosalberto
Copy link
Contributor

cc @codeboten

@github-actions
Copy link

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

@robbkidd
Copy link
Member Author

I am unclear on what change I should make: remove the changelog entry or move it to a different section?

If a different section, which section? OpenTelemetry Protocol because this is about OTLP exporters?

@carlosalberto
Copy link
Contributor

@robbkidd Oh, I meant removing the entry from the Changelog basically. On a second though, we want to be explicit to SIGs about updating their user agents, so leets keep keep the entry.

@carlosalberto carlosalberto merged commit 7e9ba16 into open-telemetry:main Jan 4, 2023
@robbkidd robbkidd deleted the patch-1 branch April 25, 2023 18:41
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
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 bug Something isn't working spec:protocol Related to the specification/protocol directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants