-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(otlp): Add python OTLP integration #15093
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
base: master
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 411 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
a3a3464 to
5f21a72
Compare
279511d to
68ec4fc
Compare
68ec4fc to
ef9e9f7
Compare
|
|
||
| ## Dedicated Integrations | ||
|
|
||
| The following SDKs have dedicated integrations that make setting up OTLP a breeze. |
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 this POTEL, or is there something else we've recently done to make Python specifically easier to set up?
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 original POTEL project is dead
this is the first of the OTLP SDKs which is the project that replaces POTEL leveraging our new OTLP ingestion support
| keywords: ["otlp", "otel", "opentelemetry"] | ||
| --- | ||
|
|
||
| The OTLP integration configures the Sentry SDK to automatically send trace data instrumented by an [OpenTelemetry](https://opentelemetry.io) SDK to Sentry's [OpenTelemetry Protocol](https://opentelemetry.io/docs/specs/otel/protocol/) [ingestion endpoint](/concepts/otlp). |
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.
I love links to all the information, but also having 3 in a row can make it hard to know what I'm focusing on. I suggest dropping the general one, as I assume people who land here will go to the protocol and then can dig in on otel.
| The OTLP integration configures the Sentry SDK to automatically send trace data instrumented by an [OpenTelemetry](https://opentelemetry.io) SDK to Sentry's [OpenTelemetry Protocol](https://opentelemetry.io/docs/specs/otel/protocol/) [ingestion endpoint](/concepts/otlp). | |
| The OTLP integration configures the Sentry SDK to automatically send trace data instrumented by an OpenTelemetry SDK to Sentry's [OpenTelemetry Protocol](https://opentelemetry.io/docs/specs/otel/protocol/) [ingestion endpoint](/concepts/otlp). |
|
|
||
| ### OpenTelemetry | ||
|
|
||
| For the OpenTelemetry SDK, you need to [configure instrumentation](https://opentelemetry.io/docs/languages/python/getting-started/#instrumentation) as per your needs. |
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.
| For the OpenTelemetry SDK, you need to [configure instrumentation](https://opentelemetry.io/docs/languages/python/getting-started/#instrumentation) as per your needs. | |
| For the OpenTelemetry SDK, you need to [configure instrumentation](https://opentelemetry.io/docs/languages/python/getting-started/#instrumentation) you want to capture. |
|
|
||
| For the Sentry SDK, you simply need to enable our `OTLPIntegration` along with your existing configuration. | ||
|
|
||
| <OnboardingOptionButtons |
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.
Should this also call out tracing? It sounds like tracing is also auto opt-in like error monitoring, and we should show that.
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.
people should not use our tracing when they use opentelemetry tracing, it's going to either or. Maybe we should clarify that?
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.
Yeah, I think it's a simple clarification. I added a suggestion in the behavior section below.
|
|
||
| * A [`SpanExporter`](https://opentelemetry.io/docs/concepts/components/#exporters) that will automatically setup the OTLP ingestion endpoint from your Sentry DSN | ||
| * A [`Propagator`](https://opentelemetry.io/docs/concepts/context-propagation/#propagation) that ensures [distributed tracing](/concepts/key-terms/tracing/distributed-tracing/) works | ||
| * Trace/Span linking for all other Sentry events such as Errors, Logs, Crons and Metrics |
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.
Does it make sense to call out that Logs, Crons, and Metrics require additional config?
|
|
||
| <Alert> | ||
|
|
||
| We have a dedicated <PlatformLink to="/integrations/otlp"> OTLPIntegration </PlatformLink> now that can directly ingest OpenTelemetry Traces into Sentry. We recommend moving over to the new setup since it is much simpler. |
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.
| We have a dedicated <PlatformLink to="/integrations/otlp"> OTLPIntegration </PlatformLink> now that can directly ingest OpenTelemetry Traces into Sentry. We recommend moving over to the new setup since it is much simpler. | |
| We now have a dedicated <PlatformLink to="/integrations/otlp"> OTLPIntegration</PlatformLink> that can directly ingest OpenTelemetry Traces into Sentry. We recommend moving over to the new setup since it is much simpler. |
| sidebar_order: 20 | ||
| --- | ||
|
|
||
| <Alert> |
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.
| <Alert> | |
| <Alert title="New Integration Option"> |
|
|
||
| Under the hood, the `OTLPIntegration` will setup the following parts: | ||
|
|
||
| * A [`SpanExporter`](https://opentelemetry.io/docs/concepts/components/#exporters) that will automatically setup the OTLP ingestion endpoint from your Sentry DSN |
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.
| * A [`SpanExporter`](https://opentelemetry.io/docs/concepts/components/#exporters) that will automatically setup the OTLP ingestion endpoint from your Sentry DSN | |
| * A [`SpanExporter`](https://opentelemetry.io/docs/concepts/components/#exporters) that will automatically setup the OTLP ingestion endpoint from your Sentry DSN. This enables tracing in Sentry. **Note:** _Do not_ also set up tracing via the Python SDK. |
| @@ -1,2 +1,2 @@ | |||
| --- | |||
| title: OpenTelemetry Support | |||
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.
| title: Legacy OpenTelemetry Integration Support |
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.
Generally looks good. The only thing I'd love to see changed are the clarifications on only using the OTLP integration for tracing and renaming the POTEL doc + the alert to be clearer.
merge after getsentry/sentry-python#4877 is released
Issues