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 doc should be modified to make it less tied to tracing singnal #3674

Closed
cijothomas opened this issue Dec 11, 2023 · 4 comments · Fixed by #4692
Closed

Baggage doc should be modified to make it less tied to tracing singnal #3674

cijothomas opened this issue Dec 11, 2023 · 4 comments · Fixed by #4692
Assignees
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@cijothomas
Copy link
Member

What needs to be changed?

Baggage doc is tied too much to tracing. We need to modify it making it clear that Baggage is applicable across all signals, and potentially show examples on Baggage can be used across signals.

What is the name + path of the page that needs changed?
https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/concepts/signals/baggage.md

Additional context: Noticed in #3657 (comment).

@cijothomas cijothomas added the bug Something isn't working label Dec 11, 2023
@svrnm
Copy link
Member

svrnm commented Dec 13, 2023

Thanks for raising this, I agree, this page needs some attention

@svrnm svrnm added the help wanted Extra attention is needed label Dec 13, 2023
@theletterf theletterf self-assigned this Dec 15, 2023
@theletterf
Copy link
Member

Thanks for raising this. We had a similar conversation on this @flands and I.

@cijothomas
Copy link
Member Author

#1878 Old issue talking about this.

Couple of statements from the same doc that feels incorrect/misleading:

  1. However, spans in OpenTelemetry are immutable once created
  2. attach information from your application to a span and retrieve that information much later - There is no "read" API to read from span, as per https://opentelemetry.io/docs/specs/otel/trace/api/#span which says "Spans are not meant to be used to propagate information within a process. To prevent misuse, implementations SHOULD NOT provide access to a Span’s attributes besides its SpanContext."

@svrnm
Copy link
Member

svrnm commented Jun 10, 2024

Yeah, the baggage doc needs some attention...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants