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

[Page feedback]: No actual explanation of what Context objects are intended for #6227

Open
craigsoules opened this issue Feb 5, 2025 · 1 comment

Comments

@craigsoules
Copy link

URL

https://opentelemetry.io/docs/specs/otel/context/

Description

It looks like, from the code, that Context objects are intended to be function scoped, since when the returned Token is destroyed it pop()'s it's context off the stack. But there's no explanation of what the use cases for Context is anywhere, so it's very confusing to people who aren't familiar with OTel. Please provide some example use cases, best practices, etc.

@svrnm
Copy link
Member

svrnm commented Feb 6, 2025

hey @craigsoules,

the page you are looking at is from the opentelemetry specification, which is a technical document, that requires having some understanding already. The page you might be looking for is here:

https://opentelemetry.io/docs/concepts/context-propagation/

Additionally there are some language specific pages on context & context propagation.

@open-telemetry/spec-sponsors PTAL, if this is something that can be changed in the spec, so I would move the issue to the spec repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants