feat: Associate replays with errors and traces on Android (#4133)

Part of #2136

Associate Errors and Traces with the active Session Replay (if one exists) on Android.

Author: jamescrosswell

CHANGELOG.md

@@ -2,17 +2,18 @@
 
 ## Unreleased
 
+### Features
+
+- New source generator allows Sentry to see true build variables like PublishAot and PublishTrimmed to properly adapt checks in the Sentry SDK ([#4101](https://github.com/getsentry/sentry-dotnet/pull/4101))
+- Auto breadcrumbs now include all .NET MAUI gesture recognizer events ([#4124](https://github.com/getsentry/sentry-dotnet/pull/4124))
+- Associate replays with errors and traces on Android ([#4133](https://github.com/getsentry/sentry-dotnet/pull/4133))
+
 ### Fixes
 
 - Redact Authorization headers before sending events to Sentry ([#4164](https://github.com/getsentry/sentry-dotnet/pull/4164))
 - Remove Strong Naming from Sentry.Hangfire ([#4099](https://github.com/getsentry/sentry-dotnet/pull/4099))
 - Increase `RequestSize.Small` threshold from 1 kB to 4 kB to match other SDKs ([#4177](https://github.com/getsentry/sentry-dotnet/pull/4177))
 
-### Features
-
-- New source generator allows Sentry to see true build variables like PublishAot and PublishTrimmed to properly adapt checks in the Sentry SDK ([#4101](https://github.com/getsentry/sentry-dotnet/pull/4101))
-- Auto breadcrumbs now include all .NET MAUI gesture recognizer events ([#4124](https://github.com/getsentry/sentry-dotnet/pull/4124))
-
 ### Dependencies
 
 - Bump CLI from v2.43.1 to v2.45.0 ([#4169](https://github.com/getsentry/sentry-dotnet/pull/4169), [#4179](https://github.com/getsentry/sentry-dotnet/pull/4179))
@@ -23,7 +24,7 @@
 
 ### Features
 
-- When setting a transaction on the scope, the SDK will attempt to sync the transaction's trace context with the SDK on the native layer. Finishing a transaction will now also start a new trace ([#4153](https://github.com/getsentry/sentry-dotnet/pull/4153)) 
+- When setting a transaction on the scope, the SDK will attempt to sync the transaction's trace context with the SDK on the native layer. Finishing a transaction will now also start a new trace ([#4153](https://github.com/getsentry/sentry-dotnet/pull/4153))
 - Added `CaptureFeedback` overload with `configureScope` parameter ([#4073](https://github.com/getsentry/sentry-dotnet/pull/4073))
 - Custom SessionReplay masks in MAUI Android apps ([#4121](https://github.com/getsentry/sentry-dotnet/pull/4121))
 
@@ -45,7 +46,7 @@
 ### Features
 
 - Option to disable the SentryNative integration ([#4107](https://github.com/getsentry/sentry-dotnet/pull/4107), [#4134](https://github.com/getsentry/sentry-dotnet/pull/4134))
-  - To disable it, add this msbuild property: `<SentryNative>false</SentryNative>` 
+  - To disable it, add this msbuild property: `<SentryNative>false</SentryNative>`
 - Reintroduced experimental support for Session Replay on Android ([#4097](https://github.com/getsentry/sentry-dotnet/pull/4097))
 - If an incoming HTTP request has the `traceparent` header, it is now parsed and interpreted like the `sentry-trace` header. Outgoing requests now contain the `traceparent` header to facilitate integration with servesr that only support the [W3C Trace Context](https://www.w3.org/TR/trace-context/). ([#4084](https://github.com/getsentry/sentry-dotnet/pull/4084))
 

src/Sentry.AspNet/HttpContextExtensions.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Internal;
 using Sentry.Protocol;
 
 namespace Sentry.AspNet;
@@ -125,7 +126,7 @@ public static ITransactionTracer StartSentryTransaction(this HttpContext httpCon
             ["__HttpContext"] = httpContext,
         };
 
-        // Set the Dynamic Sampling Context from the baggage header, if it exists.
+        // Set the Dynamic Sampling Context from the baggage header, if it exists
         var dynamicSamplingContext = baggageHeader?.CreateDynamicSamplingContext();
 
         if (traceHeader is not null && baggageHeader is null)

src/Sentry.AspNetCore/SentryTracingMiddleware.cs

@@ -2,6 +2,7 @@
 using Microsoft.Extensions.Options;
 using Sentry.AspNetCore.Extensions;
 using Sentry.Extensibility;
+using Sentry.Internal;
 using Sentry.Internal.OpenTelemetry;
 
 namespace Sentry.AspNetCore;
@@ -64,7 +65,6 @@ public SentryTracingMiddleware(
                 ? traceHeaderObject as SentryTraceHeader : null;
             var baggageHeader = context.Items.TryGetValue(SentryMiddleware.BaggageHeaderItemKey, out var baggageHeaderObject)
                 ? baggageHeaderObject as BaggageHeader : null;
-
             var dynamicSamplingContext = baggageHeader?.CreateDynamicSamplingContext();
 
             if (traceHeader is not null && baggageHeader is null)

src/Sentry.OpenTelemetry/SentrySpanProcessor.cs

@@ -13,6 +13,7 @@ public class SentrySpanProcessor : BaseProcessor<Activity>
 {
     private readonly IHub _hub;
     internal readonly IEnumerable<IOpenTelemetryEnricher> _enrichers;
+    private readonly IReplaySession _replaySession;
     internal const string OpenTelemetryOrigin = "auto.otel";
 
     // ReSharper disable once MemberCanBePrivate.Global - Used by tests
@@ -38,7 +39,7 @@ public SentrySpanProcessor(IHub hub) : this(hub, null)
     {
     }
 
-    internal SentrySpanProcessor(IHub hub, IEnumerable<IOpenTelemetryEnricher>? enrichers)
+    internal SentrySpanProcessor(IHub hub, IEnumerable<IOpenTelemetryEnricher>? enrichers, IReplaySession? replaySession = null)
     {
         _hub = hub;
         _realHub = new Lazy<Hub?>(() =>
@@ -57,7 +58,8 @@ internal SentrySpanProcessor(IHub hub, IEnumerable<IOpenTelemetryEnricher>? enri
                 "You should use the TracerProviderBuilderExtensions to configure Sentry with OpenTelemetry");
         }
 
-        _enrichers = enrichers ?? Enumerable.Empty<IOpenTelemetryEnricher>();
+        _enrichers = enrichers ?? [];
+        _replaySession = replaySession ?? ReplaySession.Instance;
         _options = hub.GetSentryOptions();
 
         if (_options is null)
@@ -158,7 +160,7 @@ private void CreateRootSpan(Activity data)
         };
 
         var baggageHeader = data.Baggage.AsBaggageHeader();
-        var dynamicSamplingContext = baggageHeader.CreateDynamicSamplingContext();
+        var dynamicSamplingContext = baggageHeader.CreateDynamicSamplingContext(_replaySession);
         var transaction = (TransactionTracer)_hub.StartTransaction(
             transactionContext, new Dictionary<string, object?>(), dynamicSamplingContext
         );

src/Sentry/DynamicSamplingContext.cs

@@ -20,15 +20,15 @@ internal class DynamicSamplingContext
     /// </summary>
     public static readonly DynamicSamplingContext Empty = new(new Dictionary<string, string>().AsReadOnly());
 
-    private DynamicSamplingContext(
-        SentryId traceId,
+    private DynamicSamplingContext(SentryId traceId,
         string publicKey,
         bool? sampled,
         double? sampleRate = null,
         double? sampleRand = null,
         string? release = null,
         string? environment = null,
-        string? transactionName = null)
+        string? transactionName = null,
+        IReplaySession? replaySession = null)
     {
         // Validate and set required values
         if (traceId == SentryId.Empty)
@@ -51,7 +51,7 @@ private DynamicSamplingContext(
             throw new ArgumentOutOfRangeException(nameof(sampleRand), "Arg invalid if < 0.0 or >= 1.0");
         }
 
-        var items = new Dictionary<string, string>(capacity: 8)
+        var items = new Dictionary<string, string>(capacity: 9)
         {
             ["trace_id"] = traceId.ToString(),
             ["public_key"] = publicKey,
@@ -88,12 +88,29 @@ private DynamicSamplingContext(
             items.Add("transaction", transactionName);
         }
 
+        if (replaySession?.ActiveReplayId is { } replayId && replayId != SentryId.Empty)
+        {
+            items.Add("replay_id", replayId.ToString());
+        }
+
         Items = items;
     }
 
     public BaggageHeader ToBaggageHeader() => BaggageHeader.Create(Items, useSentryPrefix: true);
 
-    public static DynamicSamplingContext? CreateFromBaggageHeader(BaggageHeader baggage)
+    public DynamicSamplingContext WithReplayId(IReplaySession? replaySession)
+    {
+        if (replaySession?.ActiveReplayId is not { } replayId || replayId == SentryId.Empty)
+        {
+            return this;
+        }
+
+        var items = Items.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
+        items["replay_id"] = replayId.ToString();
+        return new DynamicSamplingContext(items);
+    }
+
+    public static DynamicSamplingContext? CreateFromBaggageHeader(BaggageHeader baggage, IReplaySession? replaySession)
     {
         var items = baggage.GetSentryMembers();
 
@@ -144,10 +161,19 @@ private DynamicSamplingContext(
             }
             items.Add("sample_rand", rand.ToString("N4", CultureInfo.InvariantCulture));
         }
+
+        if (replaySession?.ActiveReplayId is { } replayId)
+        {
+            // Any upstream replay_id will be propagated only if the current process hasn't started it's own replay session.
+            // Otherwise we have to overwrite this as it's the only way to communicate the replayId to Sentry Relay.
+            // In Mobile apps this should never be a problem.
+            items["replay_id"] = replayId.ToString();
+        }
+
         return new DynamicSamplingContext(items);
     }
 
-    public static DynamicSamplingContext CreateFromTransaction(TransactionTracer transaction, SentryOptions options)
+    public static DynamicSamplingContext CreateFromTransaction(TransactionTracer transaction, SentryOptions options, IReplaySession? replaySession)
     {
         // These should already be set on the transaction.
         var publicKey = options.ParsedDsn.PublicKey;
@@ -161,18 +187,18 @@ public static DynamicSamplingContext CreateFromTransaction(TransactionTracer tra
         var release = options.SettingLocator.GetRelease();
         var environment = options.SettingLocator.GetEnvironment();
 
-        return new DynamicSamplingContext(
-            traceId,
+        return new DynamicSamplingContext(traceId,
             publicKey,
             sampled,
             sampleRate,
             sampleRand,
             release,
             environment,
-            transactionName);
+            transactionName,
+            replaySession);
     }
 
-    public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagationContext propagationContext, SentryOptions options)
+    public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagationContext propagationContext, SentryOptions options, IReplaySession? replaySession)
     {
         var traceId = propagationContext.TraceId;
         var publicKey = options.ParsedDsn.PublicKey;
@@ -184,18 +210,20 @@ public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagat
             publicKey,
             null,
             release: release,
-            environment: environment);
+            environment: environment,
+            replaySession: replaySession
+            );
     }
 }
 
 internal static class DynamicSamplingContextExtensions
 {
-    public static DynamicSamplingContext? CreateDynamicSamplingContext(this BaggageHeader baggage)
-        => DynamicSamplingContext.CreateFromBaggageHeader(baggage);
+    public static DynamicSamplingContext? CreateDynamicSamplingContext(this BaggageHeader baggage, IReplaySession? replaySession = null)
+        => DynamicSamplingContext.CreateFromBaggageHeader(baggage, replaySession);
 
-    public static DynamicSamplingContext CreateDynamicSamplingContext(this TransactionTracer transaction, SentryOptions options)
-        => DynamicSamplingContext.CreateFromTransaction(transaction, options);
+    public static DynamicSamplingContext CreateDynamicSamplingContext(this TransactionTracer transaction, SentryOptions options, IReplaySession? replaySession)
+        => DynamicSamplingContext.CreateFromTransaction(transaction, options, replaySession);
 
-    public static DynamicSamplingContext CreateDynamicSamplingContext(this SentryPropagationContext propagationContext, SentryOptions options)
-        => DynamicSamplingContext.CreateFromPropagationContext(propagationContext, options);
+    public static DynamicSamplingContext CreateDynamicSamplingContext(this SentryPropagationContext propagationContext, SentryOptions options, IReplaySession? replaySession)
+        => DynamicSamplingContext.CreateFromPropagationContext(propagationContext, options, replaySession);
 }

src/Sentry/Internal/Hub.cs

@@ -13,6 +13,7 @@ internal class Hub : IHub, IDisposable
     private readonly ISessionManager _sessionManager;
     private readonly SentryOptions _options;
     private readonly RandomValuesFactory _randomValuesFactory;
+    private readonly IReplaySession _replaySession;
 
 #if MEMORY_DUMP_SUPPORTED
     private readonly MemoryMonitor? _memoryMonitor;
@@ -39,7 +40,8 @@ internal Hub(
         ISessionManager? sessionManager = null,
         ISystemClock? clock = null,
         IInternalScopeManager? scopeManager = null,
-        RandomValuesFactory? randomValuesFactory = null)
+        RandomValuesFactory? randomValuesFactory = null,
+        IReplaySession? replaySession = null)
     {
         if (string.IsNullOrWhiteSpace(options.Dsn))
         {
@@ -55,7 +57,7 @@ internal Hub(
         _sessionManager = sessionManager ?? new GlobalSessionManager(options);
         _clock = clock ?? SystemClock.Clock;
         client ??= new SentryClient(options, randomValuesFactory: _randomValuesFactory, sessionManager: _sessionManager);
-
+        _replaySession = replaySession ?? ReplaySession.Instance;
         ScopeManager = scopeManager ?? new SentryScopeManager(options, client);
 
         if (!options.IsGlobalModeEnabled)
@@ -178,10 +180,10 @@ _options.TransactionProfilerFactory is { } profilerFactory &&
             }
         }
 
-        // Use the provided DSC, or create one based on this transaction.
+        // Use the provided DSC (adding the active replayId if necessary), or create one based on this transaction.
         // DSC creation must be done AFTER the sampling decision has been made.
-        transaction.DynamicSamplingContext =
-            dynamicSamplingContext ?? transaction.CreateDynamicSamplingContext(_options);
+        transaction.DynamicSamplingContext = dynamicSamplingContext?.WithReplayId(_replaySession)
+            ?? transaction.CreateDynamicSamplingContext(_options, _replaySession);
 
         // A sampled out transaction still appears fully functional to the user
         // but will be dropped by the client and won't reach Sentry's servers.
@@ -224,7 +226,7 @@ public BaggageHeader GetBaggage()
         }
 
         var propagationContext = CurrentScope.PropagationContext;
-        return propagationContext.GetOrCreateDynamicSamplingContext(_options).ToBaggageHeader();
+        return propagationContext.GetOrCreateDynamicSamplingContext(_options, _replaySession).ToBaggageHeader();
     }
 
     public TransactionContext ContinueTrace(
@@ -254,7 +256,7 @@ public TransactionContext ContinueTrace(
         string? name = null,
         string? operation = null)
     {
-        var propagationContext = SentryPropagationContext.CreateFromHeaders(_options.DiagnosticLogger, traceHeader, baggageHeader);
+        var propagationContext = SentryPropagationContext.CreateFromHeaders(_options.DiagnosticLogger, traceHeader, baggageHeader, _replaySession);
         ConfigureScope(scope => scope.SetPropagationContext(propagationContext));
 
         return new TransactionContext(
@@ -382,7 +384,7 @@ private void ApplyTraceContextToEvent(SentryEvent evt, SentryPropagationContext
         evt.Contexts.Trace.TraceId = propagationContext.TraceId;
         evt.Contexts.Trace.SpanId = propagationContext.SpanId;
         evt.Contexts.Trace.ParentSpanId = propagationContext.ParentSpanId;
-        evt.DynamicSamplingContext = propagationContext.GetOrCreateDynamicSamplingContext(_options);
+        evt.DynamicSamplingContext = propagationContext.GetOrCreateDynamicSamplingContext(_options, _replaySession);
     }
 
     public bool CaptureEnvelope(Envelope envelope) => CurrentClient.CaptureEnvelope(envelope);
@@ -473,10 +475,7 @@ private SentryId CaptureEvent(SentryEvent evt, SentryHint? hint, Scope scope)
             var span = GetLinkedSpan(evt) ?? scope.Span;
             if (span is not null)
             {
-                if (span.IsSampled is not false)
-                {
-                    ApplyTraceContextToEvent(evt, span);
-                }
+                ApplyTraceContextToEvent(evt, span);
             }
             else
             {

src/Sentry/Internal/ReplaySession.cs

@@ -0,0 +1,33 @@
+#if __ANDROID__
+using Sentry.Android.Extensions;
+#endif
+
+namespace Sentry.Internal;
+
+internal interface IReplaySession
+{
+    public SentryId? ActiveReplayId { get; }
+}
+
+internal class ReplaySession : IReplaySession
+{
+    public static readonly IReplaySession Instance = new ReplaySession();
+
+    private ReplaySession()
+    {
+    }
+
+    public SentryId? ActiveReplayId
+    {
+        get
+        {
+#if __ANDROID__
+            // Check to see if a Replay ID is available
+            var replayId = JavaSdk.ScopesAdapter.Instance?.Options?.ReplayController?.ReplayId?.ToSentryId();
+            return (replayId is { } id && id != SentryId.Empty) ? id : null;
+#else
+            return null;
+#endif
+        }
+    }
+}

src/Sentry/SentryPropagationContext.cs

@@ -1,4 +1,5 @@
 using Sentry.Extensibility;
+using Sentry.Internal;
 
 namespace Sentry;
 
@@ -10,12 +11,12 @@ internal class SentryPropagationContext
 
     internal DynamicSamplingContext? _dynamicSamplingContext;
 
-    public DynamicSamplingContext GetOrCreateDynamicSamplingContext(SentryOptions options)
+    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);
+            _dynamicSamplingContext = this.CreateDynamicSamplingContext(options, replaySession);
         }
 
         return _dynamicSamplingContext;
@@ -47,7 +48,7 @@ public SentryPropagationContext(SentryPropagationContext? other)
         _dynamicSamplingContext = other?._dynamicSamplingContext;
     }
 
-    public static SentryPropagationContext CreateFromHeaders(IDiagnosticLogger? logger, SentryTraceHeader? traceHeader, BaggageHeader? baggageHeader)
+    public static SentryPropagationContext CreateFromHeaders(IDiagnosticLogger? logger, SentryTraceHeader? traceHeader, BaggageHeader? baggageHeader, IReplaySession replaySession)
     {
         logger?.LogDebug("Creating a propagation context from headers.");
 
@@ -57,7 +58,7 @@ public static SentryPropagationContext CreateFromHeaders(IDiagnosticLogger? logg
             return new SentryPropagationContext();
         }
 
-        var dynamicSamplingContext = baggageHeader?.CreateDynamicSamplingContext();
+        var dynamicSamplingContext = baggageHeader?.CreateDynamicSamplingContext(replaySession);
         return new SentryPropagationContext(traceHeader.TraceId, traceHeader.SpanId, dynamicSamplingContext);
     }
 }