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

Baggage API: Expand the API for accessing metadata #3972

Open
pellared opened this issue Apr 2, 2024 · 8 comments
Open

Baggage API: Expand the API for accessing metadata #3972

pellared opened this issue Apr 2, 2024 · 8 comments
Assignees
Labels
spec:baggage Related to the specification/baggage directory triage:accepted:ready-with-sponsor Ready to be implemented and has a specification sponsor assigned

Comments

@pellared
Copy link
Member

pellared commented Apr 2, 2024

What are you trying to achieve?

The OTel spec does not even have the "Members" and "Property" distinction reflecting W3C definitions. I would even say that the OTel spec "properties" reflects "members" in W3C which makes it very confusing.

If for some reason it is intended to NOT handle properties (also known as metadata) like in W3C then it would be good to call it out in the specification.

Additional context.

Related PR: open-telemetry/opentelemetry-go#5132 (comment)

@pellared pellared added the spec:baggage Related to the specification/baggage directory label Apr 2, 2024
@pellared
Copy link
Member Author

pellared commented Apr 2, 2024

The Baggage API in Python, .NET, C++ does NOT support "properties" (also known as metadata).

The Baggage API in Java, Go, Rust supports "properties" (also known as metadata).

@pellared
Copy link
Member Author

pellared commented Apr 2, 2024

CC @open-telemetry/rust-approvers

@jack-berg
Copy link
Member

Discussed in the 4/2/24 Spec SIG meeting and determined we ought to improve the spec. We currently do mention properties / metadata, but only for the Set Value operation, and we only mention that it is an opaque value. We should:

  • Expand the API to add getters for accessing properties / metadata
  • Add helper functions so that properties / metadata isn't opaque. I.e. give helpers for reading / writing multiple entries.

@pellared pellared changed the title Baggage API: Define "properties" from W3C Baggage API: Expand the API to add getters for accessing metadata Apr 2, 2024
@pellared
Copy link
Member Author

pellared commented Apr 2, 2024

CC @open-telemetry/dotnet-approvers @open-telemetry/python-approvers @open-telemetry/cpp-approvers (as the API does not even accept the metadata)

@pellared pellared changed the title Baggage API: Expand the API to add getters for accessing metadata Baggage API: Expand the API for accessing metadata Apr 2, 2024
@trask trask added the triage:accepted:ready Ready to be implemented. Small enough or uncontroversial enough to be implemented without sponsor label Apr 2, 2024
@austinlparker austinlparker moved this to Spec Icebox in 🔭 Main Backlog Apr 16, 2024
@danielgblanco danielgblanco added triage:accepted:needs-sponsor Ready to be implemented, but does not yet have a specification sponsor and removed triage:accepted:ready Ready to be implemented. Small enough or uncontroversial enough to be implemented without sponsor labels Jul 15, 2024
@danielgblanco
Copy link
Contributor

This is probably a meaningful change that would benefit from having a TC sponsor. @jack-berg considering your comment above, are you sponsoring this?

@jack-berg
Copy link
Member

No I don't have the capacity. But now that we have the formalized the idea of spec sponsors, which includes the issue author @pellared, perhaps Robert is willing to sponsor.

@pellared
Copy link
Member Author

I can be a sponsor and help another collaborator to make the specification changes.

@danielgblanco
Copy link
Contributor

Thank you both. I'll add labels as appropriate then!

@danielgblanco danielgblanco added triage:accepted:ready-with-sponsor Ready to be implemented and has a specification sponsor assigned and removed triage:accepted:needs-sponsor Ready to be implemented, but does not yet have a specification sponsor labels Jul 16, 2024
@pellared pellared self-assigned this Jul 16, 2024
@austinlparker austinlparker moved this from Spec - Accepted to Spec - In Progress in 🔭 Main Backlog Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:baggage Related to the specification/baggage directory triage:accepted:ready-with-sponsor Ready to be implemented and has a specification sponsor assigned
Projects
Status: Spec - In Progress
Development

No branches or pull requests

4 participants