- Added Hints to BeforeSendTransaction

src/Sentry/Extensibility/DisabledHub.cs

@@ -131,6 +131,13 @@ public void CaptureTransaction(Transaction transaction)
     {
     }
 
+    /// <summary>
+    /// No-Op.
+    /// </summary>
+    public void CaptureTransaction(Transaction transaction, Hint? hint)
+    {
+    }
+
     /// <summary>
     /// No-Op.
     /// </summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -215,6 +215,14 @@ public SentryId CaptureException(Exception exception)
     public void CaptureTransaction(Transaction transaction)
         => SentrySdk.CaptureTransaction(transaction);
 
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// </summary>
+    [DebuggerStepThrough]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public void CaptureTransaction(Transaction transaction, Hint? hint)
+        => SentrySdk.CaptureTransaction(transaction, hint);
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>

src/Sentry/ISentryClient.cs

@@ -44,6 +44,21 @@ public interface ISentryClient
     [EditorBrowsable(EditorBrowsableState.Never)]
     void CaptureTransaction(Transaction transaction);
 
+    /// <summary>
+    /// Captures a transaction.
+    /// </summary>
+    /// <remarks>
+    /// Note: this method is NOT meant to be called from user code!
+    /// Instead, call <see cref="ISpan.Finish()"/> on the transaction.
+    /// </remarks>
+    /// <param name="transaction">The transaction.</param>
+    /// <param name="hint">
+    /// A hint providing extra context.
+    /// This will be available in callbacks prior to processing the transaction.
+    /// </param>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    void CaptureTransaction(Transaction transaction, Hint? hint);
+
     /// <summary>
     /// Captures a session update.
     /// </summary>

src/Sentry/Internal/Hub.cs

@@ -394,7 +394,9 @@ public void CaptureUserFeedback(UserFeedback userFeedback)
         }
     }
 
-    public void CaptureTransaction(Transaction transaction)
+    public void CaptureTransaction(Transaction transaction) => CaptureTransaction(transaction, null);
+
+    public void CaptureTransaction(Transaction transaction, Hint? hint)
     {
         // Note: The hub should capture transactions even if it is disabled.
         // This allows transactions to be reported as failed when they encountered an unhandled exception,
@@ -431,7 +433,7 @@ public void CaptureTransaction(Transaction transaction)
                 }
             }
 
-            currentScope.Value.CaptureTransaction(processedTransaction);
+            currentScope.Value.CaptureTransaction(processedTransaction, hint);
         }
         catch (Exception e)
         {

src/Sentry/SentryClient.cs

@@ -100,7 +100,10 @@ public void CaptureUserFeedback(UserFeedback userFeedback)
     }
 
     /// <inheritdoc />
-    public void CaptureTransaction(Transaction transaction)
+    public void CaptureTransaction(Transaction transaction) => CaptureTransaction(transaction, null);
+
+    /// <inheritdoc />
+    public void CaptureTransaction(Transaction transaction, Hint? hint)
     {
         if (transaction.SpanId.Equals(SpanId.Empty))
         {
@@ -136,7 +139,7 @@ public void CaptureTransaction(Transaction transaction)
             return;
         }
 
-        var processedTransaction = BeforeSendTransaction(transaction);
+        var processedTransaction = BeforeSendTransaction(transaction, hint ?? new Hint());
         if (processedTransaction is null) // Rejected transaction
         {
             _options.ClientReportRecorder.RecordDiscardedEvent(DiscardReason.BeforeSend, DataCategory.Transaction);
@@ -147,9 +150,9 @@ public void CaptureTransaction(Transaction transaction)
         CaptureEnvelope(Envelope.FromTransaction(processedTransaction));
     }
 
-    private Transaction? BeforeSendTransaction(Transaction transaction)
+    private Transaction? BeforeSendTransaction(Transaction transaction, Hint hint)
     {
-        if (_options.BeforeSendTransaction is null)
+        if (_options.BeforeSendTransactionInternal is null)
         {
             return transaction;
         }
@@ -158,7 +161,7 @@ public void CaptureTransaction(Transaction transaction)
 
         try
         {
-            return _options.BeforeSendTransaction?.Invoke(transaction);
+            return _options.BeforeSendTransactionInternal?.Invoke(transaction, hint);
         }
         catch (Exception e)
         {

src/Sentry/SentryOptions.cs

@@ -341,6 +341,10 @@ public void SetBeforeSend(Func<SentryEvent, Hint, SentryEvent?> beforeSend)
         _beforeSend = beforeSend;
     }
 
+    private Func<Transaction, Hint, Transaction?>? _beforeSendTransaction;
+
+    internal Func<Transaction, Hint, Transaction?>? BeforeSendTransactionInternal => _beforeSendTransaction;
+
     /// <summary>
     /// A callback to invoke before sending a transaction to Sentry
     /// </summary>
@@ -349,7 +353,29 @@ public void SetBeforeSend(Func<SentryEvent, Hint, SentryEvent?> beforeSend)
     /// a chance to inspect and/or modify the transaction before it's sent. If the transaction
     /// should not be sent at all, return null from the callback.
     /// </remarks>
-    public Func<Transaction, Transaction?>? BeforeSendTransaction { get; set; }
+    [Obsolete("This property will be removed in a future version. Use SetBeforeSendTransaction instead.")]
+    public Func<Transaction, Transaction?>? BeforeSendTransaction {
+        get => null;
+        set => _beforeSendTransaction = value is null ? null : (e, _) => value(e);
+    }
+
+    /// <summary>
+    /// Configures a callback to invoke before sending a transaction to Sentry
+    /// </summary>
+    /// <param name="beforeSendTransaction">The callback</param>
+    public void SetBeforeSendTransaction(Func<Transaction, Transaction?> beforeSendTransaction)
+    {
+        _beforeSendTransaction = (e, _) => beforeSendTransaction(e);
+    }
+
+    /// <summary>
+    /// Configures a callback to invoke before sending a transaction to Sentry
+    /// </summary>
+    /// <param name="beforeSendTransaction">The callback</param>
+    public void SetBeforeSendTransaction(Func<Transaction, Hint, Transaction?> beforeSendTransaction)
+    {
+        _beforeSendTransaction = beforeSendTransaction;
+    }
 
     private Func<Breadcrumb, Hint, Breadcrumb?>? _beforeBreadcrumb;
 

src/Sentry/SentrySdk.cs

@@ -527,6 +527,18 @@ public static void CaptureUserFeedback(SentryId eventId, string email, string co
     public static void CaptureTransaction(Transaction transaction)
         => CurrentHub.CaptureTransaction(transaction);
 
+    /// <summary>
+    /// Captures a transaction.
+    /// </summary>
+    /// <remarks>
+    /// Note: this method is NOT meant to be called from user code!
+    /// Instead, call <see cref="ISpan.Finish()"/> on the transaction.
+    /// </remarks>
+    [DebuggerStepThrough]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public static void CaptureTransaction(Transaction transaction, Hint? hint)
+        => CurrentHub.CaptureTransaction(transaction, hint);
+
     /// <summary>
     /// Captures a session update.
     /// </summary>

test/Sentry.AspNetCore.Tests/SentryTracingMiddlewareTests.cs

@@ -55,7 +55,9 @@ public async Task Transactions_are_grouped_by_route()
         sentryClient.Received(2).CaptureTransaction(
             Arg.Is<Transaction>(transaction =>
                 transaction.Name == "GET /person/{id}" &&
-                transaction.NameSource == TransactionNameSource.Route));
+                transaction.NameSource == TransactionNameSource.Route),
+            Arg.Any<Hint>()
+            );
     }
 
     [Fact]
@@ -150,7 +152,9 @@ public async Task Transaction_is_started_automatically_from_incoming_trace_heade
             t.TraceId == SentryId.Parse("75302ac48a024bde9a3b3734a82e36c8") &&
             t.ParentSpanId == SpanId.Parse("1000000000000000") &&
             t.IsSampled == false
-        ));
+        ),
+        Arg.Any<Hint>()
+        );
     }
 
     [Theory]
@@ -554,7 +558,7 @@ public async Task Transaction_TransactionNameProviderSetSet_TransactionNameSet()
         var expectedName = "My custom name";
 
         var sentryClient = Substitute.For<ISentryClient>();
-        sentryClient.When(x => x.CaptureTransaction(Arg.Any<Transaction>()))
+        sentryClient.When(x => x.CaptureTransaction(Arg.Any<Transaction>(), Arg.Any<Hint>()))
             .Do(callback => transaction = callback.Arg<Transaction>());
         var options = new SentryAspNetCoreOptions
         {
@@ -596,7 +600,7 @@ public async Task Transaction_TransactionNameProviderSetUnset_TransactionNameSet
         Transaction transaction = null;
 
         var sentryClient = Substitute.For<ISentryClient>();
-        sentryClient.When(x => x.CaptureTransaction(Arg.Any<Transaction>()))
+        sentryClient.When(x => x.CaptureTransaction(Arg.Any<Transaction>(), Arg.Any<Hint>()))
             .Do(callback => transaction = callback.Arg<Transaction>());
         var options = new SentryAspNetCoreOptions
         {

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

@@ -256,6 +256,7 @@ namespace Sentry
         Sentry.SentryId CaptureEvent(Sentry.SentryEvent evt, Sentry.Hint? hint, Sentry.Scope? scope = null);
         void CaptureSession(Sentry.SessionUpdate sessionUpdate);
         void CaptureTransaction(Sentry.Transaction transaction);
+        void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint);
         void CaptureUserFeedback(Sentry.UserFeedback userFeedback);
         System.Threading.Tasks.Task FlushAsync(System.TimeSpan timeout);
     }
@@ -478,6 +479,7 @@ namespace Sentry
         public Sentry.SentryId CaptureEvent(Sentry.SentryEvent? @event, Sentry.Hint? hint, Sentry.Scope? scope = null) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         [System.Obsolete("Sentry client should not be explicitly disposed of. This method will be removed i" +
             "n version 4.")]
@@ -591,6 +593,8 @@ namespace Sentry
         public System.Func<Sentry.Breadcrumb, Sentry.Breadcrumb?>? BeforeBreadcrumb { get; set; }
         [System.Obsolete("This property will be removed in a future version. Use SetBeforeSend instead.")]
         public System.Func<Sentry.SentryEvent, Sentry.SentryEvent?>? BeforeSend { get; set; }
+        [System.Obsolete("This property will be removed in a future version. Use SetBeforeSendTransaction i" +
+            "nstead.")]
         public System.Func<Sentry.Transaction, Sentry.Transaction?>? BeforeSendTransaction { get; set; }
         public string? CacheDirectoryPath { get; set; }
         public bool CaptureFailedRequests { get; set; }
@@ -647,6 +651,8 @@ namespace Sentry
         public void SetBeforeBreadcrumb(System.Func<Sentry.Breadcrumb, Sentry.Hint, Sentry.Breadcrumb?> beforeBreadcrumb) { }
         public void SetBeforeSend(System.Func<Sentry.SentryEvent, Sentry.SentryEvent?> beforeSend) { }
         public void SetBeforeSend(System.Func<Sentry.SentryEvent, Sentry.Hint, Sentry.SentryEvent?> beforeSend) { }
+        public void SetBeforeSendTransaction(System.Func<Sentry.Transaction, Sentry.Transaction?> beforeSendTransaction) { }
+        public void SetBeforeSendTransaction(System.Func<Sentry.Transaction, Sentry.Hint, Sentry.Transaction?> beforeSendTransaction) { }
     }
     public static class SentryOptionsExtensions
     {
@@ -712,6 +718,7 @@ namespace Sentry
         public static Sentry.SentryId CaptureMessage(string message, System.Action<Sentry.Scope> configureScope, Sentry.SentryLevel level = 1) { }
         public static void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public static void CaptureTransaction(Sentry.Transaction transaction) { }
+        public static void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public static void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         public static void CaptureUserFeedback(Sentry.SentryId eventId, string email, string comments, string? name = null) { }
         [System.Obsolete("WARNING: This method deliberately causes a crash, and should not be used in a rea" +
@@ -1189,6 +1196,7 @@ namespace Sentry.Extensibility
         public Sentry.SentryId CaptureEvent(Sentry.SentryEvent evt, Sentry.Hint? hint, Sentry.Scope? scope = null) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         public void ConfigureScope(System.Action<Sentry.Scope> configureScope) { }
         public System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope) { }
@@ -1227,6 +1235,7 @@ namespace Sentry.Extensibility
         public Sentry.SentryId CaptureException(System.Exception exception) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback sentryUserFeedback) { }
         public void ConfigureScope(System.Action<Sentry.Scope> configureScope) { }
         public System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope) { }

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

@@ -256,6 +256,7 @@ namespace Sentry
         Sentry.SentryId CaptureEvent(Sentry.SentryEvent evt, Sentry.Hint? hint, Sentry.Scope? scope = null);
         void CaptureSession(Sentry.SessionUpdate sessionUpdate);
         void CaptureTransaction(Sentry.Transaction transaction);
+        void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint);
         void CaptureUserFeedback(Sentry.UserFeedback userFeedback);
         System.Threading.Tasks.Task FlushAsync(System.TimeSpan timeout);
     }
@@ -478,6 +479,7 @@ namespace Sentry
         public Sentry.SentryId CaptureEvent(Sentry.SentryEvent? @event, Sentry.Hint? hint, Sentry.Scope? scope = null) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         [System.Obsolete("Sentry client should not be explicitly disposed of. This method will be removed i" +
             "n version 4.")]
@@ -592,6 +594,8 @@ namespace Sentry
         public System.Func<Sentry.Breadcrumb, Sentry.Breadcrumb?>? BeforeBreadcrumb { get; set; }
         [System.Obsolete("This property will be removed in a future version. Use SetBeforeSend instead.")]
         public System.Func<Sentry.SentryEvent, Sentry.SentryEvent?>? BeforeSend { get; set; }
+        [System.Obsolete("This property will be removed in a future version. Use SetBeforeSendTransaction i" +
+            "nstead.")]
         public System.Func<Sentry.Transaction, Sentry.Transaction?>? BeforeSendTransaction { get; set; }
         public string? CacheDirectoryPath { get; set; }
         public bool CaptureFailedRequests { get; set; }
@@ -648,6 +652,8 @@ namespace Sentry
         public void SetBeforeBreadcrumb(System.Func<Sentry.Breadcrumb, Sentry.Hint, Sentry.Breadcrumb?> beforeBreadcrumb) { }
         public void SetBeforeSend(System.Func<Sentry.SentryEvent, Sentry.SentryEvent?> beforeSend) { }
         public void SetBeforeSend(System.Func<Sentry.SentryEvent, Sentry.Hint, Sentry.SentryEvent?> beforeSend) { }
+        public void SetBeforeSendTransaction(System.Func<Sentry.Transaction, Sentry.Transaction?> beforeSendTransaction) { }
+        public void SetBeforeSendTransaction(System.Func<Sentry.Transaction, Sentry.Hint, Sentry.Transaction?> beforeSendTransaction) { }
     }
     public static class SentryOptionsExtensions
     {
@@ -713,6 +719,7 @@ namespace Sentry
         public static Sentry.SentryId CaptureMessage(string message, System.Action<Sentry.Scope> configureScope, Sentry.SentryLevel level = 1) { }
         public static void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public static void CaptureTransaction(Sentry.Transaction transaction) { }
+        public static void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public static void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         public static void CaptureUserFeedback(Sentry.SentryId eventId, string email, string comments, string? name = null) { }
         [System.Obsolete("WARNING: This method deliberately causes a crash, and should not be used in a rea" +
@@ -1190,6 +1197,7 @@ namespace Sentry.Extensibility
         public Sentry.SentryId CaptureEvent(Sentry.SentryEvent evt, Sentry.Hint? hint, Sentry.Scope? scope = null) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback userFeedback) { }
         public void ConfigureScope(System.Action<Sentry.Scope> configureScope) { }
         public System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope) { }
@@ -1228,6 +1236,7 @@ namespace Sentry.Extensibility
         public Sentry.SentryId CaptureException(System.Exception exception) { }
         public void CaptureSession(Sentry.SessionUpdate sessionUpdate) { }
         public void CaptureTransaction(Sentry.Transaction transaction) { }
+        public void CaptureTransaction(Sentry.Transaction transaction, Sentry.Hint? hint) { }
         public void CaptureUserFeedback(Sentry.UserFeedback sentryUserFeedback) { }
         public void ConfigureScope(System.Action<Sentry.Scope> configureScope) { }
         public System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope) { }