docs: Add missing OTLP integration docs and fix drift across SDKs#18441
docs: Add missing OTLP integration docs and fix drift across SDKs#18441dingsdax wants to merge 16 commits into
Conversation
Document the OTLPIntegration for the PHP SDK, covering install, configuration, behavior, options (setup_otlp_traces_exporter, collector_url), and supported versions. The integration was added in sentry-php 4.23.0 (PR getsentry/sentry-php#2030) but had no corresponding documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Document the new Sentry.OpenTelemetry.Exporter NuGet package with AddSentryOtlpExporter(dsn) and UseOtlp() extension methods. The package was added in sentry-dotnet PR getsentry/sentry-dotnet#4899 (May 2026) but had no corresponding documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Document Symfony-specific configuration for the OTLPIntegration introduced in sentry-symfony 5.4 (PR getsentry/sentry-symfony#1014). References the PHP OTLP integration docs for shared behavior and options. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Document Laravel-specific configuration for the OTLPIntegration introduced in sentry-laravel 4.15 (PR getsentry/sentry-laravel#1122). References the PHP OTLP integration docs for shared behavior and options. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update the alert from "New Integration Option" to a deprecation warning. OpenTelemetryIntegration was formally deprecated in favor of OTLPIntegration in sentry-python PR getsentry/sentry-python#6494 (June 2026). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Mark the Sentry.OpenTelemetry SpanProcessor approach as deprecated in favor of the new Sentry.OpenTelemetry.Exporter OTLP package, matching the deprecation pattern used on the Python and Ruby legacy OTel pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove the "Coming Soon" section and add .NET, Go, Java, PHP, Laravel, and Symfony to the OTLP Integration list alongside the existing Node.js, Python, and Ruby entries. All listed SDKs now have shipped OTLP support and have corresponding documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix wrong package name open-telemetry/transport-grumphp in PHP, Symfony, and Laravel install sections (package does not exist) - Fix undeclared serviceName variable in .NET code example - Add missing Supported Versions section to .NET OTLP page - Fix missing trailing slash on Python PlatformLink - Mark Ruby legacy OTel page as deprecated (was still using soft "New Integration Option" alert) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix Symfony minimum version: ^5.10 not ^5.4 (OTLPIntegration service registration was added in 5.10.0) - Fix Laravel minimum version: ^4.25 not ^4.15 (OTLPIntegration support was added in 4.25.0) - Fix PHP version requirement: 8.1+ not 7.2+ (OpenTelemetry SDK requires PHP 8.1) - Use camelCase option names to match actual PHP constructor params (setupOtlpTracesExporter, collectorUrl) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Go: - Update version requirements: Go 1.25+, sentry-go 0.47.0+, OTel 1.43.0+ (were 1.18, 0.18.0, 1.11.0) - Update alert: NewSentrySpanProcessor/NewSentryPropagator were removed in v0.47.0, not just deprecated Java: - Add tracecontext,baggage to otel.propagators alongside sentry in both plain Java and Spring Boot examples, matching official SDK samples. Without these, W3C traceparent propagation is lost. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Change "Legacy OpenTelemetry Support" to "OpenTelemetry Support (Deprecated)" for consistency with the Python and Ruby deprecated OTel pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
The anchor #instrumentation doesn't exist on the getting-started page. Use the dedicated instrumentation page URL instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Without fallbackPlatform="php", PlatformLink resolves relative to the guide URL instead of the parent platform, producing broken links. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Order platforms by adoption/maturity and group PHP SDKs (PHP, Laravel, Symfony) together instead of scattering them alphabetically. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Flash0ver
left a comment
There was a problem hiding this comment.
Review for docs/platforms/dotnet/:
| --- | ||
| title: OpenTelemetry (OTLP) | ||
| description: "Learn about using OTLP to automatically send OpenTelemetry Traces to Sentry." | ||
| sidebar_order: 21 |
There was a problem hiding this comment.
issue (low): order
The order is unexpected ... there is another item between the new and the old OTEL integration:
performance-metrics.mdx also has sidebar_order: 20, just like opentelemetry.mdx does.
I suggest
- keep
performance-metrics.mdxatsidebar_order: 20 - change the old
opentelemetry.mdxtosidebar_order: 21 - and change this new document to
sidebar_order: 22
So that both OTEL pages are next to each other.
| Add the `Sentry.OpenTelemetry.Exporter` NuGet package to your project: | ||
|
|
||
| ```shell {tabTitle:.NET Core CLI} | ||
| dotnet add package Sentry.OpenTelemetry.Exporter |
There was a problem hiding this comment.
suggestion: add version
Inject current version for consistency with other sentry-dotnet docs:
| dotnet add package Sentry.OpenTelemetry.Exporter | |
| dotnet add package Sentry.OpenTelemetry.Exporter -v {{@inject packages.version('sentry.dotnet') }} |
| ``` | ||
|
|
||
| ```powershell {tabTitle:Package Manager} | ||
| Install-Package Sentry.OpenTelemetry.Exporter |
There was a problem hiding this comment.
suggestion: add version
Inject current version for consistency with other sentry-dotnet docs:
| Install-Package Sentry.OpenTelemetry.Exporter | |
| Install-Package Sentry.OpenTelemetry.Exporter -Version {{@inject packages.version('sentry.dotnet') }} |
| ``` | ||
|
|
||
| This package includes the standard OpenTelemetry OTLP exporter as a transitive dependency. |
There was a problem hiding this comment.
suggestion: add Packet
I suggest to also add a Paket install tab, to be consistent with docs of deprecated OTEL integration for .NET:
| ``` | |
| This package includes the standard OpenTelemetry OTLP exporter as a transitive dependency. | |
| ``` | |
| ```shell {tabTitle:Paket CLI} | |
| paket add Sentry.OpenTelemetry.Exporter --version {{@inject packages.version('sentry.dotnet') }} | |
| ``` | |
| This package includes the standard OpenTelemetry OTLP exporter as a transitive dependency. |
| ## Supported Versions | ||
|
|
||
| - .NET: 6.0+ | ||
| - Sentry.OpenTelemetry.Exporter: 5.0.0+ | ||
| - OpenTelemetry: 1.15.0+ |
There was a problem hiding this comment.
issue: wrong versions
suggestion: remove Supported Versions section
The versions are wrong:
## Supported Versions
-- .NET: 6.0+
+- .NET Standard 2.0 and compatible
-- Sentry.OpenTelemetry.Exporter: 5.0.0+
+- Sentry.OpenTelemetry.Exporter: 6.5.0+
-- OpenTelemetry: 1.15.0+
+- OpenTelemetry: 1.10.0+I do understand that these versions are added to be globally consistent with the OTLP docs from other platforms/SDKs.
I do suggest, however, to remove this section altogether, to be locally consistent with the rest of our .NET docs, as we usually don't have such a trailing section in other sentry-dotnet documentation pages.
| <Alert> | ||
|
|
||
| The Sentry Go OpenTelemetry integration requires `go.opentelemetry.io/otel` (and its submodules), version `1.11.0` or higher. | ||
| The OTLP-based OpenTelemetry integration requires `sentry-go` v0.47.0+, Go >= 1.25, and `go.opentelemetry.io/otel` v1.43.0+. |
There was a problem hiding this comment.
| The OTLP-based OpenTelemetry integration requires `sentry-go` v0.47.0+, Go >= 1.25, and `go.opentelemetry.io/otel` v1.43.0+. | |
| The OTLP-based OpenTelemetry integration requires `sentry-go` v0.45.0+, Go >= 1.25, and `go.opentelemetry.io/otel` v1.40.0+. |
These are the minimum ones for the integration.
closes getsentry/sentry-dotnet#5190
DESCRIBE YOUR PR
Overview of changes
New documentation pages:
docs/platforms/php/common/integrations/otlp/)docs/platforms/dotnet/common/tracing/instrumentation/opentelemetry-otlp.mdx)docs/platforms/php/guides/symfony/integrations/otlp.mdx)docs/platforms/php/guides/laravel/integrations/otlp.mdx)Deprecation alerts added:
Hub page updated:
docs/concepts/otlp/sentry-with-otel.mdx: removed "Coming Soon" section, added .NET, Go, Java, PHP, Laravel, Symfony (9 SDKs total, alphabetical)Existing docs corrected:
NewSentrySpanProcessorotel.propagatorsfromsentrytotracecontext,baggage,sentry(matching official SDK samples)Per-SDK changes
PHP (
sentry-php,sentry-symfony,sentry-laravel)New pages:
docs/platforms/php/common/integrations/otlp/index.mdxOTLPIntegrationclassopen-telemetry/sdk,open-telemetry/exporter-otlpsetupOtlpTracesExporter,collectorUrldocs/platforms/php/guides/symfony/integrations/otlp.mdxdocs/platforms/php/guides/laravel/integrations/otlp.mdxconfig/sentry.phpconfig using::classpatternVerification: all code examples checked against
sentry-phpOTLPIntegration.phpconstructor,sentry-symfonytest fixtures, andsentry-laravelServiceProvidersource..NET (
sentry-dotnet)New page:
docs/platforms/dotnet/common/tracing/instrumentation/opentelemetry-otlp.mdxSentry.OpenTelemetry.ExporterNuGet packageAddSentryOtlpExporter(dsn)andUseOtlp()extension methodsdsnString,collectorUrl(Uri),defaultTextMapPropagatorUpdated page:
docs/platforms/dotnet/common/tracing/instrumentation/opentelemetry.mdxVerification: checked against
SentryTracerProviderBuilderExtensions.cs,SentryOptionsExtensions.cs, and official console/ASP.NET Core samples.Python (
sentry-python)Updated page:
docs/platforms/python/tracing/instrumentation/opentelemetry.mdxOpenTelemetryIntegrationwas deprecated in chore: Deprecate OpenTelemetryIntegration in favor of OTLPIntegration and no-op for span first sentry-python#6494 (June 2026)Verification: existing OTLP docs confirmed correct against
sentry_sdk/integrations/otlp.py.Ruby (
sentry-ruby)Updated page:
docs/platforms/ruby/common/tracing/instrumentation/opentelemetry.mdxVerification: existing OTLP docs confirmed correct against
sentry-opentelemetrygem source.Go (
sentry-go)Updated pages:
platform-includes/performance/opentelemetry-install/go.mdxdocs/platforms/go/common/tracing/instrumentation/opentelemetry.mdxNewSentrySpanProcessorandNewSentryPropagatorwere fully removed in v0.47.0Verification: checked against
otel/otlp/span_exporter.go,otel/go.mod, and_examples/otlp/main.go.Java (
sentry-java)Updated page:
docs/platforms/java/common/opentelemetry/setup/otlp.mdxotel.propagatorsin both plain Java and Spring Boot examples:sentrytracecontext,baggage,sentrytracecontext,baggage, W3C traceparent propagation is lostVerification: all code examples confirmed correct against
sentry-opentelemetry-otlpmodule source and sample apps.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: