-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(otel): Add docs for Python OpenTelemetry #5962
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
Merged
antonpirker
merged 1 commit into
master
from
antonpirker/opentelementry-support-python-sdk
Dec 15, 2022
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
src/platform-includes/performance/opentelemetry-install/python.mdx
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<Note> | ||
|
||
Sentry requires `opentelemetry-distro` version `0.350b0` or higher. | ||
|
||
</Note> | ||
|
||
```bash | ||
pip install --upgrade 'sentry-sdk[opentelemetry]' | ||
``` |
26 changes: 26 additions & 0 deletions
26
src/platform-includes/performance/opentelemetry-setup/python.mdx
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Initialize Sentry for tracing and set the `instrumenter` to `otel`: | ||
|
||
```python | ||
import sentry_sdk | ||
|
||
sentry_sdk.init( | ||
dsn="___PUBLIC_DSN___", | ||
traces_sample_rate=1.0, | ||
# set the instrumenter to use OpenTelemetry instead of Sentry | ||
instrumenter="otel", | ||
) | ||
``` | ||
|
||
This disables all Sentry instrumentation and relies on the chosen OpenTelemetry tracers for creating spans. | ||
|
||
Next, configure OpenTelemetry as you need and hook in the Sentry span processor and propagator: | ||
|
||
```python | ||
from opentelemetry import trace | ||
from opentelemetry.propagate import set_global_textmap | ||
from sentry_sdk.integrations.opentelemetry import SentrySpanProcessor, SentryPropagator | ||
|
||
provider = trace.get_tracer_provider() | ||
provider.add_span_processor(SentrySpanProcessor()) | ||
set_global_textmap(SentryPropagator()) | ||
``` |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is anything else required for linking errors to OTEL transactions? e.g. adding an
EventProcessor
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other imports are below (this is in another mdx file) see the full page here in the preview: https://sentry-docs-git-antonpirker-opentelementry-support-python-sdk.sentry.dev/platforms/python/performance/instrumentation/opentelemetry/
(Previews are linked in the comment from the vercel bot above)