docs: add documentation on ContextManagers and Zone.js #386
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MustafaHaddara
force-pushed
the
mh/context-docs
branch
from
3c9d350
to
f837eb3
Compare
MustafaHaddara
commented
Nov 8, 2024
Comment on lines
+137
to
+152
| ### Context Management | ||
| OpenTelemetry uses the concept of a [Context Manager](https://opentelemetry.io/docs/languages/js/context/#context-manager) to store propagate global span context through your system. OpenTelemetry provides a context manager for browser instrumentation based on the [Zone.js](https://github.com/angular/angular/tree/main/packages/zone.js) library to track global context across asynchronous execution threads. This context manager can be plugged into this instrumentation like so: | ||
|
|
||
| ```js | ||
| import { ZoneContextManager } from '@opentelemetry/context-zone'; | ||
|
|
||
| const sdk = new HoneycombWebSDK({ | ||
| // other config options omitted... | ||
| contextManager: new ZoneContextManager() | ||
| }); | ||
| sdk.start(); | ||
| ``` | ||
|
|
||
| Zone.js has known limitations with async/await code, and [requires](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-context-zone-peer-dep#installation) your code to be transpiled down to ES2015. It also may carry a performance penalty. | ||
|
|
||
| For these reasons, we do not enable ZoneContextManager by default. |
There was a problem hiding this comment.
This is the primary change, the rest is reformatting the tables to be easier to read in plain text.
MustafaHaddara
added
type: documentation
wolfgangcodes
approved these changes
Nov 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Adds documentation on supplying your own context manager
References:
How to verify that this has the expected result
read the docs