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

Incompatibility between the W3C Baggage spec version used in the Resource spec and the Baggage spec #2639

Closed
lgfa29 opened this issue Jul 1, 2022 · 2 comments · Fixed by #2670
Assignees
Labels
spec:resource Related to the specification/resource directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal

Comments

@lgfa29
Copy link
Contributor

lgfa29 commented Jul 1, 2022

What are you trying to achieve?

When defining the value for the OTEL_RESOURCE_ATTRIBUTES environment variable, the resource specification links to the version fdc7a5c4f4a31ba2a36717541055e551c2b032e4 of the W3C Baggage format, while the OpenTelemetry Baggage specification doesn't specify any particular version.

This causes an incompatibly in how baggage values are handled between the two specifications because the latest W3C Baggage spec defines that:

Any characters outside of the baggage-octet range of characters MUST be percent-encoded.
https://w3c.github.io/baggage/#value

But the version used by the Resource spec doesn't have this requirement.

The effect of this difference is that, when using a library that follows the OpenTelemetry Baggage spec (such as go.opentelemetry.io/otel/baggage) to generate the value for the OTEL_RESOURCE_ATTRIBUTES environment variable, the baggage values will be encoded by the library but not decoded by the SDK.

Additional context.

@MrAlias noticed this difference in open-telemetry/opentelemetry-go#2963.

@jsuereth
Copy link
Contributor

jsuereth commented Jul 8, 2022

It looks like we should take the time to update our specification to account for changes in the Baggage specification. Feel free to open a PR to address this.

@jsuereth jsuereth added the triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal label Jul 8, 2022
@lgfa29
Copy link
Contributor Author

lgfa29 commented Jul 16, 2022

Thank you @jsuereth, I opened #2670 to update the spec 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:resource Related to the specification/resource directory triaged-accepted The issue is triaged and accepted by the OTel community, one can proceed with creating a PR proposal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants