Support transaction finishing automatically with 'idle timeout'

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Symbolication for Single File Apps ([#2425](https://github.com/getsentry/sentry-dotnet/pull/2425))
 - Add binding to `SwiftAsyncStacktraces` on iOS ([#2436](https://github.com/getsentry/sentry-dotnet/pull/2436))
+- Support transaction finishing automatically with 'idle timeout' ([#2452](https://github.com/getsentry/sentry-dotnet/pull/2452))
 
 ### Fixes
 

src/Sentry/Internal/Hub.cs

@@ -116,7 +116,7 @@ internal ITransaction StartTransaction(
         IReadOnlyDictionary<string, object?> customSamplingContext,
         DynamicSamplingContext? dynamicSamplingContext)
     {
-        var transaction = new TransactionTracer(this, context);
+        var transaction = new TransactionTracer(this, context, _options.IdleTimeout);
 
         // If the hub is disabled, we will always sample out.  In other words, starting a transaction
         // after disposing the hub will result in that transaction not being sent to Sentry.

src/Sentry/SentryOptions.cs

@@ -982,6 +982,11 @@ public bool JsonPreserveReferences
     /// </summary>
     internal bool InitNativeSdks { get; set; } = true;
 
+    /// <summary>
+    /// Idling transaction timeout after which transaction will be finished automatically.
+    /// </summary>
+    public TimeSpan? IdleTimeout { get; set; }
+
     /// <summary>
     /// Creates a new instance of <see cref="SentryOptions"/>
     /// </summary>

src/Sentry/TransactionTracer.cs

@@ -6,9 +6,11 @@ namespace Sentry;
 /// <summary>
 /// Transaction tracer.
 /// </summary>
-public class TransactionTracer : ITransaction, IHasDistribution, IHasTransactionNameSource, IHasMeasurements
+public class TransactionTracer : ITransaction, IHasDistribution, IHasTransactionNameSource, IHasMeasurements, IDisposable
 {
     private readonly IHub _hub;
+    private readonly TimeSpan? _idleTimeout;
+    private readonly Timer? _idleTimer;
     private readonly SentryStopwatch _stopwatch = SentryStopwatch.StartNew();
 
     /// <inheritdoc />
@@ -198,9 +200,15 @@ public TransactionTracer(IHub hub, string name, string operation, TransactionNam
     /// <summary>
     /// Initializes an instance of <see cref="TransactionTracer"/>.
     /// </summary>
-    public TransactionTracer(IHub hub, ITransactionContext context)
+    public TransactionTracer(IHub hub, ITransactionContext context) : this (hub, context, null) {}
+
+    /// <summary>
+    /// Initializes an instance of <see cref="TransactionTracer"/>.
+    /// </summary>
+    public TransactionTracer(IHub hub, ITransactionContext context, TimeSpan? idleTimeout)
     {
         _hub = hub;
+        _idleTimeout = idleTimeout;
         Name = context.Name;
         NameSource = context is IHasTransactionNameSource c ? c.NameSource : TransactionNameSource.Custom;
         Operation = context.Operation;
@@ -210,6 +218,19 @@ public TransactionTracer(IHub hub, ITransactionContext context)
         Description = context.Description;
         Status = context.Status;
         IsSampled = context.IsSampled;
+
+        if (idleTimeout != null)
+        {
+            _idleTimer = new Timer(state =>
+            {
+                if (state is not TransactionTracer transactionTracer)
+                {
+                    return;
+                }
+
+                transactionTracer.Finish(Status ?? SpanStatus.Ok);
+            }, this, TimeSpan.Zero, idleTimeout.Value);
+        }
     }
 
     /// <inheritdoc />
@@ -260,6 +281,8 @@ public ISpan StartChild(string operation) =>
     /// <inheritdoc />
     public void Finish()
     {
+        _idleTimer?.Change(Timeout.InfiniteTimeSpan, Timeout.InfiniteTimeSpan);
+
         TransactionProfiler?.Finish();
         Status ??= SpanStatus.Ok;
         EndTimestamp = _stopwatch.CurrentDateTimeOffset;
@@ -307,4 +330,20 @@ public void Finish(Exception exception) =>
         TraceId,
         SpanId,
         IsSampled);
+
+    /// <summary>Releases the unmanaged resources.</summary>
+    protected virtual void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _idleTimer?.Dispose();
+        }
+    }
+
+    /// <inheritdoc />
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
 }

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

@@ -615,6 +615,7 @@ namespace Sentry
         public System.Collections.Generic.IList<Sentry.SubstringOrRegexPattern> FailedRequestTargets { get; set; }
         public System.TimeSpan FlushTimeout { get; set; }
         public System.Net.IWebProxy? HttpProxy { get; set; }
+        public System.TimeSpan? IdleTimeout { get; set; }
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
@@ -1060,9 +1061,10 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> CustomSamplingContext { get; }
         public Sentry.ITransactionContext TransactionContext { get; }
     }
-    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext
+    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext, System.IDisposable
     {
         public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context) { }
+        public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context, System.TimeSpan? idleTimeout) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation, Sentry.TransactionNameSource nameSource) { }
         public System.Collections.Generic.IReadOnlyCollection<Sentry.Breadcrumb> Breadcrumbs { get; }
@@ -1095,6 +1097,8 @@ namespace Sentry
         public Sentry.SentryId TraceId { get; }
         public Sentry.User User { get; set; }
         public void AddBreadcrumb(Sentry.Breadcrumb breadcrumb) { }
+        public void Dispose() { }
+        protected virtual void Dispose(bool disposing) { }
         public void Finish() { }
         public void Finish(Sentry.SpanStatus status) { }
         public void Finish(System.Exception exception) { }

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

@@ -616,6 +616,7 @@ namespace Sentry
         public System.Collections.Generic.IList<Sentry.SubstringOrRegexPattern> FailedRequestTargets { get; set; }
         public System.TimeSpan FlushTimeout { get; set; }
         public System.Net.IWebProxy? HttpProxy { get; set; }
+        public System.TimeSpan? IdleTimeout { get; set; }
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
@@ -1061,9 +1062,10 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> CustomSamplingContext { get; }
         public Sentry.ITransactionContext TransactionContext { get; }
     }
-    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext
+    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext, System.IDisposable
     {
         public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context) { }
+        public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context, System.TimeSpan? idleTimeout) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation, Sentry.TransactionNameSource nameSource) { }
         public System.Collections.Generic.IReadOnlyCollection<Sentry.Breadcrumb> Breadcrumbs { get; }
@@ -1096,6 +1098,8 @@ namespace Sentry
         public Sentry.SentryId TraceId { get; }
         public Sentry.User User { get; set; }
         public void AddBreadcrumb(Sentry.Breadcrumb breadcrumb) { }
+        public void Dispose() { }
+        protected virtual void Dispose(bool disposing) { }
         public void Finish() { }
         public void Finish(Sentry.SpanStatus status) { }
         public void Finish(System.Exception exception) { }

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

@@ -616,6 +616,7 @@ namespace Sentry
         public System.Collections.Generic.IList<Sentry.SubstringOrRegexPattern> FailedRequestTargets { get; set; }
         public System.TimeSpan FlushTimeout { get; set; }
         public System.Net.IWebProxy? HttpProxy { get; set; }
+        public System.TimeSpan? IdleTimeout { get; set; }
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
@@ -1061,9 +1062,10 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> CustomSamplingContext { get; }
         public Sentry.ITransactionContext TransactionContext { get; }
     }
-    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext
+    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext, System.IDisposable
     {
         public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context) { }
+        public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context, System.TimeSpan? idleTimeout) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation, Sentry.TransactionNameSource nameSource) { }
         public System.Collections.Generic.IReadOnlyCollection<Sentry.Breadcrumb> Breadcrumbs { get; }
@@ -1096,6 +1098,8 @@ namespace Sentry
         public Sentry.SentryId TraceId { get; }
         public Sentry.User User { get; set; }
         public void AddBreadcrumb(Sentry.Breadcrumb breadcrumb) { }
+        public void Dispose() { }
+        protected virtual void Dispose(bool disposing) { }
         public void Finish() { }
         public void Finish(Sentry.SpanStatus status) { }
         public void Finish(System.Exception exception) { }

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

@@ -614,6 +614,7 @@ namespace Sentry
         public System.Collections.Generic.IList<Sentry.SubstringOrRegexPattern> FailedRequestTargets { get; set; }
         public System.TimeSpan FlushTimeout { get; set; }
         public System.Net.IWebProxy? HttpProxy { get; set; }
+        public System.TimeSpan? IdleTimeout { get; set; }
         public System.TimeSpan InitCacheFlushTimeout { get; set; }
         public bool IsEnvironmentUser { get; set; }
         public bool IsGlobalModeEnabled { get; set; }
@@ -1059,9 +1060,10 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> CustomSamplingContext { get; }
         public Sentry.ITransactionContext TransactionContext { get; }
     }
-    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext
+    public class TransactionTracer : Sentry.IEventLike, Sentry.IHasBreadcrumbs, Sentry.IHasExtra, Sentry.IHasTags, Sentry.IHasTransactionNameSource, Sentry.ISpan, Sentry.ISpanContext, Sentry.ISpanData, Sentry.ITransaction, Sentry.ITransactionContext, Sentry.ITransactionData, Sentry.Protocol.ITraceContext, System.IDisposable
     {
         public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context) { }
+        public TransactionTracer(Sentry.IHub hub, Sentry.ITransactionContext context, System.TimeSpan? idleTimeout) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation) { }
         public TransactionTracer(Sentry.IHub hub, string name, string operation, Sentry.TransactionNameSource nameSource) { }
         public System.Collections.Generic.IReadOnlyCollection<Sentry.Breadcrumb> Breadcrumbs { get; }
@@ -1094,6 +1096,8 @@ namespace Sentry
         public Sentry.SentryId TraceId { get; }
         public Sentry.User User { get; set; }
         public void AddBreadcrumb(Sentry.Breadcrumb breadcrumb) { }
+        public void Dispose() { }
+        protected virtual void Dispose(bool disposing) { }
         public void Finish() { }
         public void Finish(Sentry.SpanStatus status) { }
         public void Finish(System.Exception exception) { }

test/Sentry.Tests/HubTests.cs

@@ -1132,7 +1132,7 @@ public void CaptureTransaction_HubEnabled(bool enabled)
     [Fact]
     public void CaptureTransaction_Client_Gets_Hint()
     {
-        // Arrange        
+        // Arrange
         var hub = _fixture.GetSut();
 
         // Act
@@ -1146,7 +1146,7 @@ public void CaptureTransaction_Client_Gets_Hint()
     [Fact]
     public void CaptureTransaction_Client_Gets_ScopeAttachments()
     {
-        // Arrange        
+        // Arrange
         var hub = _fixture.GetSut();
         List<Attachment> attachments = new List<Attachment> {
             AttachmentHelper.FakeAttachment("foo"),
@@ -1336,4 +1336,32 @@ public async Task WithScopeAsyncT_Works()
     }
 
     private static Scope GetCurrentScope(Hub hub) => hub.ScopeManager.GetCurrent().Key;
+
+    [Fact]
+    public async Task IdleTimeout_auto_finishes_transaction()
+    {
+        // Arrange
+        _fixture.Options.IdleTimeout = TimeSpan.FromMilliseconds(2);
+        var hub = _fixture.GetSut();
+        var context = new TransactionContext(
+            SpanId.Create(),
+            SpanId.Create(),
+            SentryId.Create(),
+            "name",
+            "operation",
+            "description",
+            SpanStatus.Ok,
+            null,
+            true,
+            TransactionNameSource.Component
+        );
+
+        // Act
+        var transaction = hub.StartTransaction(context);
+
+        await Task.Delay(TimeSpan.FromMilliseconds(5));
+
+        // Assert
+        transaction.IsFinished.Should().BeTrue();
+    }
 }

test/Sentry.Tests/Protocol/TransactionTests.cs

@@ -504,4 +504,29 @@ public void ISpan_GetTransaction_FromSpan()
         // Assert
         Assert.Same(transaction, result);
     }
+
+    [Fact]
+    public async Task Idle_transaction_should_finish_with_idle_timeout_specified()
+    {
+        // Arrange
+        var context = new TransactionContext(
+            SpanId.Create(),
+            SpanId.Create(),
+            SentryId.Create(),
+            "my name",
+            "my operation",
+            "description",
+            SpanStatus.Ok,
+            null,
+            true,
+            TransactionNameSource.Component
+        );
+        var transaction = new TransactionTracer(DisabledHub.Instance, context, TimeSpan.FromMilliseconds(2));
+
+        // Act
+        await Task.Delay(5);
+
+        // Assert
+        transaction.IsFinished.Should().BeTrue();
+    }
 }

test/Sentry.Tests/SentryOptionsTests.cs

@@ -194,4 +194,11 @@ public void FailedRequestTargets_ByDefault_MatchesAnyUrl()
         var sut = new SentryOptions();
         Assert.Contains(".*", sut.FailedRequestTargets);
     }
+
+    [Fact]
+    public void IdleTimeout_ByDefault_IsNull()
+    {
+        var sut = new SentryOptions();
+        sut.IdleTimeout.IsNull();
+    }
 }