Add SentryOptions.DisableSentryHttpMessageHandler (#3879)

Author: jamescrosswell

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Added `SentryOptions.DisableSentryHttpMessageHandler`. Useful if you're using `OpenTelemetry.Instrumentation.Http` and ending up with duplicate spans. ([#3879](https://github.com/getsentry/sentry-dotnet/pull/3879))
+
 ## 5.0.1
 
 ### Features

src/Sentry.Extensions.Logging/SentryHttpMessageHandlerBuilderFilter.cs

@@ -14,7 +14,8 @@ public Action<HttpMessageHandlerBuilder> Configure(Action<HttpMessageHandlerBuil
         handlerBuilder =>
         {
             var hub = _getHub();
-            if (!handlerBuilder.AdditionalHandlers.Any(h => h is SentryHttpMessageHandler))
+            var enableHandler = hub.GetSentryOptions()?.DisableSentryHttpMessageHandler == false;
+            if (enableHandler && !handlerBuilder.AdditionalHandlers.Any(h => h is SentryHttpMessageHandler))
             {
                 handlerBuilder.AdditionalHandlers.Add(
                     new SentryHttpMessageHandler(hub)

src/Sentry/BindableSentryOptions.cs

@@ -48,6 +48,7 @@ internal partial class BindableSentryOptions
     public TimeSpan? AutoSessionTrackingInterval { get; set; }
     public bool? AutoSessionTracking { get; set; }
     public bool? UseAsyncFileIO { get; set; }
+    public bool? DisableSentryHttpMessageHandler { get; set; }
     public bool? JsonPreserveReferences { get; set; }
     public bool? EnableSpotlight { get; set; }
     public string? SpotlightUrl { get; set; }
@@ -94,6 +95,7 @@ public void ApplyTo(SentryOptions options)
         options.AutoSessionTrackingInterval = AutoSessionTrackingInterval ?? options.AutoSessionTrackingInterval;
         options.AutoSessionTracking = AutoSessionTracking ?? options.AutoSessionTracking;
         options.UseAsyncFileIO = UseAsyncFileIO ?? options.UseAsyncFileIO;
+        options.DisableSentryHttpMessageHandler = DisableSentryHttpMessageHandler ?? options.DisableSentryHttpMessageHandler;
         options.JsonPreserveReferences = JsonPreserveReferences ?? options.JsonPreserveReferences;
         options.EnableSpotlight = EnableSpotlight ?? options.EnableSpotlight;
         options.SpotlightUrl = SpotlightUrl ?? options.SpotlightUrl;

src/Sentry/SentryHttpMessageHandler.cs

@@ -5,7 +5,8 @@
 namespace Sentry;
 
 /// <summary>
-/// Special HTTP message handler that can be used to propagate Sentry headers and other contextual information.
+/// Special HTTP message handler that can be used to propagate Sentry headers and other contextual information. Will
+/// also create events for failed requests if <see cref="SentryOptions.CaptureFailedRequests"/> is enabled.
 /// </summary>
 public class SentryHttpMessageHandler : SentryMessageHandler
 {

src/Sentry/SentryOptions.cs

@@ -1066,6 +1066,14 @@ public StackTraceMode StackTraceMode
     /// </summary>
     internal Instrumenter Instrumenter { get; set; } = Instrumenter.Sentry;
 
+    /// <summary>
+    /// <para>
+    /// Set to `true` to prevents Sentry from automatically registering <see cref="SentryHttpMessageHandler"/>.
+    /// </para>
+    /// <para>Defaults to `false`. Should be set to `true` when using the OpenTelemetry.Instrumentation.Http.</para>
+    /// </summary>
+    public bool DisableSentryHttpMessageHandler { get; set; } = false;
+
     /// <summary>
     /// Adds a <see cref="JsonConverter"/> to be used when serializing or deserializing
     /// objects to JSON with this SDK.  For example, when custom context data might use

test/Sentry.Extensions.Logging.Tests/SentryHttpMessageHandlerBuilderFilterTests.cs

@@ -0,0 +1,54 @@
+using Microsoft.Extensions.Http;
+
+namespace Sentry.Extensions.Logging.Tests;
+
+public class SentryHttpMessageHandlerBuilderFilterTests
+{
+    [SkippableFact]
+    public void Configure_HandlerEnabled_ShouldAddSentryHttpMessageHandler()
+    {
+#if __ANDROID__
+        Skip.If(true, "Can't create proxies for classes without parameterless constructors on Android");
+#endif
+
+        // Arrange
+        var hub = Substitute.For<IHub>();
+        SentryClientExtensions.SentryOptionsForTestingOnly = new SentryOptions { DisableSentryHttpMessageHandler = false };
+
+        var filter = new SentryHttpMessageHandlerBuilderFilter(() => hub);
+        var handlerBuilder = Substitute.For<HttpMessageHandlerBuilder>();
+        handlerBuilder.AdditionalHandlers.Returns(new List<DelegatingHandler>());
+        Action<HttpMessageHandlerBuilder> next = _ => { };
+
+        // Act
+        var configure = filter.Configure(next);
+        configure(handlerBuilder);
+
+        // Assert
+        handlerBuilder.AdditionalHandlers.Should().ContainSingle(h => h is SentryHttpMessageHandler);
+    }
+
+    [SkippableFact]
+    public void Configure_HandlerDisabled_ShouldNotAddSentryHttpMessageHandler()
+    {
+#if __ANDROID__
+        Skip.If(true, "Can't create proxies for classes without parameterless constructors on Android");
+#endif
+
+        // Arrange
+        var hub = Substitute.For<IHub>();
+        SentryClientExtensions.SentryOptionsForTestingOnly = new SentryOptions { DisableSentryHttpMessageHandler = true };
+
+        var filter = new SentryHttpMessageHandlerBuilderFilter(() => hub);
+        var handlerBuilder = Substitute.For<HttpMessageHandlerBuilder>();
+        handlerBuilder.AdditionalHandlers.Returns(new List<DelegatingHandler>());
+        Action<HttpMessageHandlerBuilder> next = _ => { };
+
+        // Act
+        var configure = filter.Configure(next);
+        configure(handlerBuilder);
+
+        // Assert
+        handlerBuilder.AdditionalHandlers.Should().NotContain(h => h is SentryHttpMessageHandler);
+    }
+}

test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -664,6 +664,7 @@ namespace Sentry
         public Sentry.SentryLevel DiagnosticLevel { get; set; }
         public Sentry.Extensibility.IDiagnosticLogger? DiagnosticLogger { get; set; }
         public bool DisableFileWrite { get; set; }
+        public bool DisableSentryHttpMessageHandler { get; set; }
         public string? Distribution { get; set; }
         public string? Dsn { get; set; }
         public bool EnableScopeSync { get; set; }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt

@@ -664,6 +664,7 @@ namespace Sentry
         public Sentry.SentryLevel DiagnosticLevel { get; set; }
         public Sentry.Extensibility.IDiagnosticLogger? DiagnosticLogger { get; set; }
         public bool DisableFileWrite { get; set; }
+        public bool DisableSentryHttpMessageHandler { get; set; }
         public string? Distribution { get; set; }
         public string? Dsn { get; set; }
         public bool EnableScopeSync { get; set; }

test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt

@@ -651,6 +651,7 @@ namespace Sentry
         public Sentry.SentryLevel DiagnosticLevel { get; set; }
         public Sentry.Extensibility.IDiagnosticLogger? DiagnosticLogger { get; set; }
         public bool DisableFileWrite { get; set; }
+        public bool DisableSentryHttpMessageHandler { get; set; }
         public string? Distribution { get; set; }
         public string? Dsn { get; set; }
         public bool EnableScopeSync { get; set; }