Repository navigation
docs(otel): note that Sentry.OpenTelemetry doesn't apply ConfigureDataCollection - #5967
jamescrosswell wants to merge 2 commits into
Conversation
…aCollection Sentry.OpenTelemetry is deprecated in favour of Sentry.OpenTelemetry.Exporter, so it won't be moved onto the DataCollection options (#5435). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Good to approve, with optional comments
This change only touches docs. It adds <remarks> to the deprecated Sentry.OpenTelemetry entry points saying they don't apply ConfigureDataCollection. What the remarks describe matches the code (AspNetCoreEnricher gated on SendDefaultPii, QueryStringFilter using the fixed SensitiveDataFilter deny list, other attributes passed through), and nothing changes at runtime or in the public API.
- Optional: "doesn't apply
ConfigureDataCollection" reads broader than the code.SentryClientstill runsEnricher.Applyon these transactions (src/Sentry/SentryClient.cs:210), which gates the environment username and the{{auto}}IP onDataCollection.UserInfo(src/Sentry/Internal/Enricher.cs:17). Consider limiting the remark to what the integration collects itself, e.g. "The span attributes and the user that this integration collects don't followConfigureDataCollection…", inTracerProviderBuilderExtensions.cs:43andSentrySpanProcessor.cs:14. - Optional:
SentryOptionsExtensions.UseOpenTelemetry(SentryOptions, TracerProviderBuilder, …)(src/Sentry.OpenTelemetry/SentryOptionsExtensions.cs:35-41) callsAddSentryinternally. Users who start from that overload won't see the remark, so consider adding the same remark there, or a<seealso cref="TracerProviderBuilderExtensions.AddSentry"/>.
This is an automated preliminary review.
The core enricher still applies DataCollection.UserInfo to these transactions, so the remarks now cover only the user and span attributes Sentry.OpenTelemetry collects itself. The UseOpenTelemetry overload that calls AddSentry gets the same remark. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
It's really just warning people that none of the new DataCollection functionality is being built/tested for this now deprecated package. I don't think it's worth wordsmithing too much, since we're going to remove this deprecated package in the next major anyway. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5967 +/- ##
==========================================
+ Coverage 77.69% 77.70% +0.01%
==========================================
Files 535 535
Lines 19727 19727
Branches 3932 3932
==========================================
+ Hits 15326 15328 +2
+ Misses 3545 3544 -1
+ Partials 856 855 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Adds
<remarks>toTracerProviderBuilderExtensions.AddSentry, theUseOpenTelemetryoverload that calls it, andSentrySpanProcessor. They say that the user and span attributes this integration collects don't followConfigureDataCollection. The core enricher still appliesUserInfoto these transactions.Sentry.OpenTelemetryis deprecated in favour ofSentry.OpenTelemetry.Exporter, so it won't be moved onto the DataCollection options. #5435 is closed as not planned. Part of #5420.The
SentrySpanProcessorremark leaves out the user, because onlyAddSentryregisters the enricher that sets it.#skip-changelog
🤖 Generated with Claude Code