Document the DisableSentryHttpMessageHandler configuration option#17012
Merged
jamescrosswell merged 4 commits intomasterfrom Apr 15, 2026
Merged
Conversation
…try HTTP instrumentation When using OpenTelemetry.Instrumentation.Http with AddHttpClientInstrumentation(), Sentry's built-in SentryHttpMessageHandler would also instrument HTTP requests, resulting in duplicate spans. The DisableSentryHttpMessageHandler option (added in 5.1.0) prevents this, but was not documented on the OpenTelemetry setup page. - Add OpenTelemetry.Instrumentation.Http package installation instructions - Update setup example to include AddHttpClientInstrumentation() and DisableSentryHttpMessageHandler = true - Add an alert explaining when and why to set this option Fixes GH-4399
Document the DisableSentryHttpMessageHandler option in the .NET tracing options reference page, including its default value, purpose, and the version it was introduced (5.1.0). Refs GH-4399
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
dingsdax
approved these changes
Apr 15, 2026
dingsdax
approved these changes
Apr 15, 2026
Comment on lines
17
to
+26
| // options.SendDefaultPii = true; | ||
| options.TracesSampleRate = 1.0; | ||
| options.UseOpenTelemetry(); // <-- Configure Sentry to use OpenTelemetry trace information | ||
| options.DisableSentryHttpMessageHandler = true; // <-- Disable Sentry's HttpClient instrumentation to avoid duplicate spans | ||
| }); | ||
| ``` | ||
|
|
||
| <Alert level="info" title="HTTP Client Instrumentation"> | ||
| When using `AddHttpClientInstrumentation()` from `OpenTelemetry.Instrumentation.Http`, you **must** set `DisableSentryHttpMessageHandler = true` in the Sentry options. This prevents Sentry's built-in `SentryHttpMessageHandler` from also instrumenting HTTP requests and creating duplicate spans. | ||
| </Alert> |
There was a problem hiding this comment.
Bug: The OpenTelemetry setup example unconditionally includes optional HTTP instrumentation, potentially misleading users into adding unnecessary dependencies and configuration.
Severity: LOW
Suggested Fix
Update the documentation to clarify that HTTP instrumentation is optional. Either remove AddHttpClientInstrumentation() and DisableSentryHttpMessageHandler = true from the main example and show it as a separate, optional step, or add a prominent note above the code block explaining its optional nature.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: platform-includes/performance/opentelemetry-setup/dotnet.mdx#L17-L26
Potential issue: The main OpenTelemetry setup documentation in `dotnet.mdx` includes
`AddHttpClientInstrumentation()` and `DisableSentryHttpMessageHandler = true` in the
basic example. This is misleading because HTTP client instrumentation is an optional
feature. Users following the guide may unnecessarily add the
`OpenTelemetry.Instrumentation.Http` package, call `AddHttpClientInstrumentation()`, and
disable the Sentry message handler, leading to unnecessary dependencies and
configuration overhead. While an alert box clarifies the conditional requirement, the
code example itself presents these optional settings as standard.
jamescrosswell
deleted the
jamescrosswell/docs/disable-sentry-http-message-handler
branch
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves getsentry/sentry-dotnet#4399
DisableSentryHttpMessageHandlersentry-dotnet#4399PRIORITY
SLA
cc: @Flash0ver
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: