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.

Sign up for GitHub

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

Make clear that context is not mutable when setting a span #2637

Merged
merged 6 commits into from
Jul 6, 2022
Merged

Make clear that context is not mutable when setting a span #2637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d288f0e
Make clear that context is not mutable when setting a span
Grunet Jun 30, 2022
a6cb45b
Avoid making the copy seem mutable
Grunet Jul 1, 2022
e208d2e
Update the summary line to also not sound like Context is mutable
Grunet Jul 1, 2022
fcc9b2b
Update changelog
Grunet Jul 6, 2022
6b0059b
Remove trailing space
Grunet Jul 6, 2022
d85295a
Merge branch 'main' into patch-3
carlosalberto Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ release.

- Clarify the return of `Export(batch)` in the Batch Span Processor and exporter
concurrency ([#2452](https://github.com/open-telemetry/opentelemetry-specification/pull/2452))
- Clarify that Context should not be mutable when setting a span ([#2637](https://github.com/open-telemetry/opentelemetry-specification/pull/2637))

### Metrics

Expand Down
4 changes: 2 additions & 2 deletions specification/trace/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The API MUST provide the following functionality to interact with a `Context`
instance:

- Extract the `Span` from a `Context` instance
- Insert the `Span` to a `Context` instance
- Combine the `Span` with a `Context` instance, creating a new `Context` instance

The functionality listed above is necessary because API users SHOULD NOT have
access to the [Context Key](../context/README.md#create-a-key) used by the Tracing API implementation.
Expand All @@ -173,7 +173,7 @@ If the language has support for implicitly propagated `Context` (see
the following functionality:

- Get the currently active span from the implicit context. This is equivalent to getting the implicit context, then extracting the `Span` from the context.
- Set the currently active span to the implicit context. This is equivalent to getting the implicit context, then inserting the `Span` to the context.
- Set the currently active span into a new context, and make that the implicit context. This is equivalent to combining the current implicit context's values with the `Span` to create a new context, which is then made the current implicit context.
arminru marked this conversation as resolved.
Show resolved Hide resolved

All the above functionalities operate solely on the context API, and they MAY be
exposed as either static methods on the trace module, or as static methods on a class
Expand Down