feat: Add support to send OTEL traces via OTLP

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add support to send OTEL traces via OTLP ([#4899](https://github.com/getsentry/sentry-dotnet/pull/4899))
+
 ## 6.2.0-alpha.0
 
 ### Features

samples/Sentry.Samples.AspNetCore.Blazor.Server/Sentry.Samples.AspNetCore.Blazor.Server.csproj

@@ -22,9 +22,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="OpenTelemetry" Version="1.14.0" />
-    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.14.0" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.14.0" />
+    <PackageReference Include="OpenTelemetry" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.15.0" />
   </ItemGroup>
 
 </Project>

samples/Sentry.Samples.GraphQL.Server/Sentry.Samples.GraphQL.Server.csproj

@@ -14,9 +14,9 @@
     <PackageReference Include="GraphQL.Server.Transports.AspNetCore" Version="7.6.0" />
     <PackageReference Include="GraphQL.Server.Ui.Altair" Version="7.6.0" />
     <PackageReference Include="GraphQL.SystemTextJson" Version="7.6.0" />
-    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.0" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.8.1" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.7.0" />
   </ItemGroup>
 

samples/Sentry.Samples.OpenTelemetry.AspNetCore/Program.cs

@@ -7,6 +7,14 @@
 
 var builder = WebApplication.CreateBuilder(args);
 
+// Read the Sentry DSN from the environment variable if it's not already set in code.
+#if SENTRY_DSN_DEFINED_IN_ENV
+var dsn = Environment.GetEnvironmentVariable("SENTRY_DSN")
+          ?? throw new InvalidOperationException("SENTRY_DSN environment variable is not set");
+#else
+var dsn = SamplesShared.Dsn;
+#endif
+
 // OpenTelemetry Configuration
 // See https://opentelemetry.io/docs/instrumentation/net/getting-started/
 builder.Services.AddOpenTelemetry()
@@ -20,8 +28,8 @@
             // The two lines below take care of configuring sources for ASP.NET Core and HttpClient
             .AddAspNetCoreInstrumentation()
             .AddHttpClientInstrumentation()
-            // Finally we configure OpenTelemetry to send traces to Sentry
-            .AddSentry()
+            // Finally, we configure OpenTelemetry over OTLP to send traces to Sentry
+            .AddSentryOtlp(dsn)
     );
 
 builder.WebHost.UseSentry(options =>
@@ -35,7 +43,7 @@
     options.Debug = builder.Environment.IsDevelopment();
     options.SendDefaultPii = true;
     options.TracesSampleRate = 1.0;
-    options.UseOpenTelemetry(); // <-- Configure Sentry to use OpenTelemetry trace information
+    options.UseOtlp(); // <-- Configure Sentry to use OpenTelemetry trace information
 });
 
 builder.Services

samples/Sentry.Samples.OpenTelemetry.AspNetCore/Sentry.Samples.OpenTelemetry.AspNetCore.csproj

@@ -7,10 +7,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.8.0" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.8.1" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.8.1" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.8.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.15.0" />
   </ItemGroup>
 
   <PropertyGroup Condition="'$(Configuration)' == 'Release'">

samples/Sentry.Samples.OpenTelemetry.AzureFunctions/Sentry.Samples.OpenTelemetry.AzureFunctions.csproj

@@ -10,9 +10,9 @@
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.3.0" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Timer" Version="4.3.1" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="2.0.7" />
-        <PackageReference Include="OpenTelemetry" Version="1.14.0" />
-        <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.14.0" />
-        <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.14.0" />
+        <PackageReference Include="OpenTelemetry" Version="1.15.0" />
+        <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
+        <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
     </ItemGroup>
 
     <ItemGroup>

samples/Sentry.Samples.OpenTelemetry.Console/Program.cs

@@ -42,7 +42,7 @@
         task?.SetTag("Answer", 42);
         Thread.Sleep(100); // simulate some work
         Console.WriteLine("Task 1 completed");
-        task?.SetStatus(Status.Ok);
+        task?.SetStatus(ActivityStatusCode.Ok);
     }
 
     // Since we use `AddHttpClientInstrumentation` when initializing OpenTelemetry, the following Http request will also

samples/Sentry.Samples.OpenTelemetry.Console/Sentry.Samples.OpenTelemetry.Console.csproj

@@ -8,8 +8,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="OpenTelemetry" Version="1.8.0" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.8.1" />
+    <PackageReference Include="OpenTelemetry" Version="1.15.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
   </ItemGroup>
 
   <PropertyGroup Condition="'$(Configuration)' == 'Release'">

src/Sentry.DiagnosticSource/Internal/DiagnosticSource/SentryDiagnosticListenerIntegration.cs

@@ -3,7 +3,7 @@
 
 namespace Sentry.Internal.DiagnosticSource;
 
-internal class SentryDiagnosticListenerIntegration : ISdkIntegration
+internal class SentryDiagnosticListenerIntegration : ISdkIntegration, ISentryTracingIntegration
 {
     public void Register(IHub hub, SentryOptions options)
     {

src/Sentry.EntityFramework/DbInterceptionIntegration.cs

@@ -1,6 +1,6 @@
 namespace Sentry.EntityFramework;
 
-internal class DbInterceptionIntegration : ISdkIntegration
+internal class DbInterceptionIntegration : ISdkIntegration, ISentryTracingIntegration
 {
     // Internal for testing.
     internal IDbInterceptor? SqlInterceptor { get; private set; }

src/Sentry.Maui.CommunityToolkit.Mvvm/SentryOptionsExtensions.cs

@@ -1,3 +1,4 @@
+using Sentry.Extensibility;
 using Sentry.Maui.CommunityToolkit.Mvvm;
 
 namespace Sentry.Maui;
@@ -12,7 +13,14 @@ public static class SentryOptionsExtensions
     /// </summary>
     public static SentryMauiOptions AddCommunityToolkitIntegration(this SentryMauiOptions options)
     {
-        options.AddIntegrationEventBinder<MauiCommunityToolkitMvvmEventsBinder>();
+        if (options.DisableSentryTracing)
+        {
+            options.LogWarning("Skipping CommunityToolkit.Mvvm integration because OpenTelemetry is enabled.");
+        }
+        else
+        {
+            options.AddIntegrationEventBinder<MauiCommunityToolkitMvvmEventsBinder>();
+        }
         return options;
     }
 }

src/Sentry.OpenTelemetry/OpenTelemetryTransactionProcessor.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Internal.OpenTelemetry;
 
 namespace Sentry.OpenTelemetry;
 

src/Sentry.OpenTelemetry/OtelPropagationContext.cs

@@ -0,0 +1,28 @@
+using Sentry.Extensibility;
+using Sentry.Internal;
+
+namespace Sentry.OpenTelemetry;
+
+internal class OtelPropagationContext : IPropagationContext
+{
+    public DynamicSamplingContext? DynamicSamplingContext { get; private set; }
+
+    public SentryId TraceId => Activity.Current?.TraceId.AsSentryId() ?? default;
+    public SpanId SpanId => Activity.Current?.SpanId.AsSentrySpanId() ?? default;
+    public SpanId? ParentSpanId => Activity.Current?.ParentSpanId.AsSentrySpanId();
+
+    /// <summary>
+    /// Warning: this method may throw an exception if Activity.Current is null.
+    /// This method should not be used when instrumenting with OTEL.
+    /// </summary>
+    public DynamicSamplingContext GetOrCreateDynamicSamplingContext(SentryOptions options, IReplaySession replaySession)
+    {
+        if (DynamicSamplingContext is null)
+        {
+            options.LogDebug("Creating the Dynamic Sampling Context from the Propagation Context.");
+            DynamicSamplingContext = this.CreateDynamicSamplingContext(options, replaySession);
+        }
+
+        return DynamicSamplingContext;
+    }
+}

src/Sentry.OpenTelemetry/Sentry.OpenTelemetry.csproj

@@ -5,6 +5,8 @@
     <PackageTags>$(PackageTags);OpenTelemetry</PackageTags>
     <TargetFrameworks>$(CurrentTfms);netstandard2.1;netstandard2.0;net462</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <!-- Todo: work out a proper solution to this bug in the Roslyn analysers -->
+    <NoWarn>$(NoWarn);AD0001</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(EnableAot)' == 'true'">
@@ -17,7 +19,7 @@
 
   <ItemGroup>
     <!-- Version 1.6.0 is the minimum version that does not have trim warnings   -->
-    <PackageReference Include="OpenTelemetry" Version="1.6.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.10.0" />
   </ItemGroup>
 
   <ItemGroup>

src/Sentry.OpenTelemetry/SentryOptionsExtensions.cs

@@ -9,11 +9,11 @@ namespace Sentry.OpenTelemetry;
 public static class SentryOptionsExtensions
 {
     /// <summary>
-    /// Enables OpenTelemetry instrumentation with Sentry
+    /// Configures Sentry to use OpenTelemetry for distributed tracing.
     /// </summary>
-    /// <param name="options"><see cref="SentryOptions"/> instance</param>
-    /// <param name="traceProviderBuilder"><see cref="TracerProviderBuilder"/></param>
-    /// <param name="defaultTextMapPropagator">
+    /// <param name="options">The <see cref="SentryOptions"/> instance.</param>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/></param>
+    /// <param name="textMapPropagator">
     ///     <para>The default TextMapPropagator to be used by OpenTelemetry.</para>
     ///     <para>
     ///         If this parameter is not supplied, the <see cref="SentryPropagator"/> will be used, which propagates the
@@ -24,34 +24,98 @@ public static class SentryOptionsExtensions
     ///         could wrap this in a <see cref="CompositeTextMapPropagator"/> if you needed other propagators as well.
     ///     </para>
     /// </param>
-    public static void UseOpenTelemetry(
-        this SentryOptions options,
-        TracerProviderBuilder traceProviderBuilder,
-        TextMapPropagator? defaultTextMapPropagator = null
-        )
+    /// <param name="disableSentryTracing">Whether to disable traces created using Sentry's tracing instrumentation.
+    /// It's recommended that you set this to <c>true</c> since mixing OpenTelemetry and Sentry traces may yield
+    /// unexpected results. It is <c>false</c> by default for backward compatibility only.
+    /// </param>
+    /// <remarks>
+    /// This method of initialising the Sentry OpenTelemetry integration will be depricated in a future major release.
+    /// We recommend you use <see cref="UseOtlp(Sentry.SentryOptions,TracerProviderBuilder,TextMapPropagator?)"/> instead.
+    /// </remarks>
+    public static void UseOpenTelemetry(this SentryOptions options, TracerProviderBuilder builder,
+        TextMapPropagator? textMapPropagator = null, bool disableSentryTracing = false)
+    {
+        options.UseOpenTelemetry(disableSentryTracing);
+        builder.AddSentry(textMapPropagator);
+    }
+
+    /// <summary>
+    /// <para>Configures Sentry to use OpenTelemetry for distributed tracing.
+    /// </para>
+    /// <para>
+    /// Note: if you are using this overload to configure Sentry to work with OpenTelemetry, you will also have to call
+    /// <see cref="O:TracerProviderBuilderExtensions.AddSentry"/>  when building your <see cref="TracerProviderBuilder"/>
+    /// to ensure OpenTelemetry sends trace information to Sentry.
+    /// </para>
+    /// </summary>
+    /// <param name="options">The <see cref="SentryOptions"/> instance.</param>
+    /// <param name="disableSentryTracing">Whether to disable traces created using Sentry's tracing instrumentation.
+    /// It's recommended that you set this to <c>true</c> since mixing OpenTelemetry and Sentry traces may yield
+    /// unexpected results. It is <c>false</c> by default for backward compatibility only.
+    /// </param>
+    /// <remarks>
+    /// This method of initialising the Sentry OpenTelemetry integration will be depricated in a future major release.
+    /// We recommend you use <see cref="UseOtlp(Sentry.SentryOptions,TracerProviderBuilder,TextMapPropagator?)"/> instead.
+    /// </remarks>
+    public static void UseOpenTelemetry(this SentryOptions options, bool disableSentryTracing = false)
     {
         options.Instrumenter = Instrumenter.OpenTelemetry;
+        options.DisableSentryTracing = disableSentryTracing;
+        options.PropagationContextFactory = _ => new OtelPropagationContext();
         options.AddTransactionProcessor(
             new OpenTelemetryTransactionProcessor()
-            );
+        );
+    }
 
-        traceProviderBuilder.AddSentry(defaultTextMapPropagator);
+    /// <summary>
+    /// <para>Configures Sentry to use OpenTelemetry for distributed tracing. Sentry instrumented traces will be
+    /// disabled (so all tracing instrumentation must be done using the OpenTelemetry <see cref="Activity"/> classes).
+    /// </para>
+    /// <para>
+    /// This is the recommended way to set up Sentry's OpenTelemetry integration.
+    /// </para>
+    /// </summary>
+    /// <param name="options">The <see cref="SentryOptions"/> instance.</param>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/></param>
+    /// <param name="textMapPropagator">
+    ///     <para>The default TextMapPropagator to be used by OpenTelemetry.</para>
+    ///     <para>
+    ///         If this parameter is not supplied, the <see cref="SentryPropagator"/> will be used, which propagates the
+    ///         baggage header as well as Sentry trace headers.
+    ///     </para>
+    ///     <para>
+    ///         The <see cref="SentryPropagator"/> is required for Sentry's OpenTelemetry integration to work but you
+    ///         could wrap this in a <see cref="CompositeTextMapPropagator"/> if you needed other propagators as well.
+    ///     </para>
+    /// </param>
+    public static void UseOtlp(this SentryOptions options, TracerProviderBuilder builder, TextMapPropagator? textMapPropagator = null)
+    {
+        if (string.IsNullOrWhiteSpace(options.Dsn))
+        {
+            throw new ArgumentException("Sentry DSN must be set before calling `SentryOptions.UseOTLP`", nameof(options.Dsn));
+        }
+        builder.AddSentryOtlp(options.Dsn, textMapPropagator);
+        options.UseOtlp();
     }
 
     /// <summary>
-    /// <para>Configures Sentry to use OpenTelemetry for distributed tracing.</para>
+    /// <para>Configures Sentry to use OpenTelemetry for distributed tracing. Sentry instrumented traces will be
+    /// disabled (so all tracing instrumentation must be done using the OpenTelemetry <see cref="Activity"/> classes).
+    /// </para>
     /// <para>
-    /// Note: if you are using this method to configure Sentry to work with OpenTelemetry you will also have to call
-    /// <see cref="TracerProviderBuilderExtensions.AddSentry"/> when building your <see cref="TracerProviderBuilder"/>
-    /// to ensure OpenTelemetry sends trace information to Sentry.
+    /// This is the recommended way to set up Sentry's OpenTelemetry integration.
     /// </para>
     /// </summary>
-    /// <param name="options"><see cref="SentryOptions"/> instance</param>
-    public static void UseOpenTelemetry(this SentryOptions options)
+    /// <remarks>
+    /// Note: if you are using this overload to configure Sentry to work with OpenTelemetry, you will also have to call
+    /// <see cref="TracerProviderBuilderExtensions.AddSentryOtlp"/>, when building your <see cref="TracerProviderBuilder"/>
+    /// to ensure OpenTelemetry sends trace information to Sentry.
+    /// </remarks>
+    /// <param name="options">The <see cref="SentryOptions"/> instance.</param>
+    public static void UseOtlp(this SentryOptions options)
     {
         options.Instrumenter = Instrumenter.OpenTelemetry;
-        options.AddTransactionProcessor(
-            new OpenTelemetryTransactionProcessor()
-            );
+        options.DisableSentryTracing = true;
+        options.PropagationContextFactory = _ => new OtelPropagationContext();
     }
 }

src/Sentry.OpenTelemetry/SentryPropagator.cs

@@ -2,6 +2,7 @@
 using OpenTelemetry;
 using OpenTelemetry.Context.Propagation;
 using Sentry.Extensibility;
+using Sentry.Internal.OpenTelemetry;
 
 namespace Sentry.OpenTelemetry;
 
@@ -49,12 +50,12 @@ private static class OTelKeys
     }
 
     /// <inheritdoc />
-    public override PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>> getter)
+    public override PropagationContext Extract<T>(PropagationContext context, T carrier, Func<T, string, IEnumerable<string>?> getter)
     {
         Options?.LogDebug("SentryPropagator.Extract");
 
         var result = base.Extract(context, carrier, getter);
-        var baggage = result.Baggage; // The Otel .NET SDK takes care of baggage headers alread
+        var baggage = result.Baggage; // The Otel .NET SDK takes care of baggage headers already
 
         Options?.LogDebug("Baggage");
         foreach (var entry in baggage)
@@ -121,13 +122,17 @@ public override void Inject<T>(PropagationContext context, T carrier, Action<T,
         base.Inject(context, carrier, setter);
     }
 
-    private static SentryTraceHeader? TryGetSentryTraceHeader<T>(T carrier, Func<T, string, IEnumerable<string>> getter)
+    private static SentryTraceHeader? TryGetSentryTraceHeader<T>(T carrier, Func<T, string, IEnumerable<string>?> getter)
     {
         var headerValue = getter(carrier, SentryTraceHeader.HttpHeaderName);
+        if (headerValue is null)
+        {
+            return null;
+        }
         try
         {
             var value = new StringValues(headerValue.ToArray());
-            return SentryTraceHeader.Parse(value);
+            return SentryTraceHeader.Parse(value!);
         }
         catch (Exception)
         {