Add SentrySdk.SetTag #4228 (#4232)

KnapSac · web-flow · commit bc1e4f14019a · 2025-05-30T12:32:51.000-04:00
* Add SentrySdk.SetTag #4228 * Update CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Features
 
 - Reduced memory pressure when sampling less than 100% of traces/transactions ([#4212](https://github.com/getsentry/sentry-dotnet/pull/4212))
+- Add SentrySdk.SetTag ([#4232](https://github.com/getsentry/sentry-dotnet/pull/4232))
 
 ### Fixes
 
diff --git a/src/Sentry/Extensibility/DisabledHub.cs b/src/Sentry/Extensibility/DisabledHub.cs
@@ -35,6 +35,20 @@ public void ConfigureScope(Action<Scope> configureScope)
     /// </summary>
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope) => Task.CompletedTask;
 
+    /// <summary>
+    /// No-Op.
+    /// </summary>
+    public void SetTag(string key, string value)
+    {
+    }
+
+    /// <summary>
+    /// No-Op.
+    /// </summary>
+    public void UnsetTag(string key)
+    {
+    }
+
     /// <summary>
     /// No-Op.
     /// </summary>
diff --git a/src/Sentry/Extensibility/HubAdapter.cs b/src/Sentry/Extensibility/HubAdapter.cs
@@ -46,6 +46,20 @@ public void ConfigureScope(Action<Scope> configureScope)
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         => SentrySdk.ConfigureScopeAsync(configureScope);
 
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// </summary>
+    [DebuggerStepThrough]
+    public void SetTag(string key, string value)
+        => SentrySdk.SetTag(key, value);
+
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// </summary>
+    [DebuggerStepThrough]
+    public void UnsetTag(string key)
+        => SentrySdk.UnsetTag(key);
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>
diff --git a/src/Sentry/ISentryScopeManager.cs b/src/Sentry/ISentryScopeManager.cs
@@ -22,6 +22,16 @@ public interface ISentryScopeManager
     /// <returns>A task that completes when the callback is done or a completed task if the SDK is disabled.</returns>
     public Task ConfigureScopeAsync(Func<Scope, Task> configureScope);
 
+    /// <summary>
+    /// Sets a tag on the current scope.
+    /// </summary>
+    public void SetTag(string key, string value);
+
+    /// <summary>
+    /// Removes a tag from the current scope.
+    /// </summary>
+    public void UnsetTag(string key);
+
     /// <summary>
     /// Binds the client to the current scope.
     /// </summary>
diff --git a/src/Sentry/Internal/Hub.cs b/src/Sentry/Internal/Hub.cs
@@ -111,6 +111,10 @@ public async Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         }
     }
 
+    public void SetTag(string key, string value) => ScopeManager.SetTag(key, value);
+
+    public void UnsetTag(string key) => ScopeManager.UnsetTag(key);
+
     public IDisposable PushScope() => ScopeManager.PushScope();
 
     public IDisposable PushScope<TState>(TState state) => ScopeManager.PushScope(state);
diff --git a/src/Sentry/Internal/SentryScopeManager.cs b/src/Sentry/Internal/SentryScopeManager.cs
@@ -44,6 +44,18 @@ public Task ConfigureScopeAsync(Func<Scope, Task>? configureScope)
         return configureScope?.Invoke(scope) ?? Task.CompletedTask;
     }
 
+    public void SetTag(string key, string value)
+    {
+        var (scope, _) = GetCurrent();
+        scope.SetTag(key, value);
+    }
+
+    public void UnsetTag(string key)
+    {
+        var (scope, _) = GetCurrent();
+        scope.UnsetTag(key);
+    }
+
     public IDisposable PushScope() => PushScope<object>(null);
 
     public IDisposable PushScope<TState>(TState? state)
diff --git a/src/Sentry/SentrySdk.cs b/src/Sentry/SentrySdk.cs
@@ -389,6 +389,20 @@ public static void ConfigureScope(Action<Scope> configureScope)
     public static Task ConfigureScopeAsync(Func<Scope, Task> configureScope)
         => CurrentHub.ConfigureScopeAsync(configureScope);
 
+    /// <summary>
+    /// Sets a tag on the current scope.
+    /// </summary>
+    [DebuggerStepThrough]
+    public static void SetTag(string key, string value)
+        => CurrentHub.SetTag(key, value);
+
+    /// <summary>
+    /// Removes a tag from the current scope.
+    /// </summary>
+    [DebuggerStepThrough]
+    public static void UnsetTag(string key)
+        => CurrentHub.UnsetTag(key);
+
     /// <inheritdoc cref="ISentryClient.CaptureEnvelope"/>
     [DebuggerStepThrough]
     [EditorBrowsable(EditorBrowsableState.Never)]
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt
@@ -259,6 +259,8 @@ namespace Sentry
         System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope);
         System.IDisposable PushScope();
         System.IDisposable PushScope<TState>(TState state);
+        void SetTag(string key, string value);
+        void UnsetTag(string key);
     }
     public interface ISentryScopeStateProcessor
     {
@@ -863,12 +865,14 @@ namespace Sentry
         public static System.IDisposable PushScope() { }
         public static System.IDisposable PushScope<TState>(TState state) { }
         public static void ResumeSession() { }
+        public static void SetTag(string key, string value) { }
         public static void StartSession() { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context) { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
+        public static void UnsetTag(string key) { }
     }
     public class SentrySession : Sentry.ISentrySession
     {
@@ -1367,8 +1371,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public class FormRequestPayloadExtractor : Sentry.Extensibility.BaseRequestPayloadExtractor
     {
@@ -1413,8 +1419,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public interface IBackgroundWorker
     {
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt
@@ -259,6 +259,8 @@ namespace Sentry
         System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope);
         System.IDisposable PushScope();
         System.IDisposable PushScope<TState>(TState state);
+        void SetTag(string key, string value);
+        void UnsetTag(string key);
     }
     public interface ISentryScopeStateProcessor
     {
@@ -863,12 +865,14 @@ namespace Sentry
         public static System.IDisposable PushScope() { }
         public static System.IDisposable PushScope<TState>(TState state) { }
         public static void ResumeSession() { }
+        public static void SetTag(string key, string value) { }
         public static void StartSession() { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context) { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
+        public static void UnsetTag(string key) { }
     }
     public class SentrySession : Sentry.ISentrySession
     {
@@ -1367,8 +1371,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public class FormRequestPayloadExtractor : Sentry.Extensibility.BaseRequestPayloadExtractor
     {
@@ -1413,8 +1419,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public interface IBackgroundWorker
     {
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt
@@ -247,6 +247,8 @@ namespace Sentry
         System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope);
         System.IDisposable PushScope();
         System.IDisposable PushScope<TState>(TState state);
+        void SetTag(string key, string value);
+        void UnsetTag(string key);
     }
     public interface ISentryScopeStateProcessor
     {
@@ -844,12 +846,14 @@ namespace Sentry
         public static System.IDisposable PushScope() { }
         public static System.IDisposable PushScope<TState>(TState state) { }
         public static void ResumeSession() { }
+        public static void SetTag(string key, string value) { }
         public static void StartSession() { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context) { }
         public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
+        public static void UnsetTag(string key) { }
     }
     public class SentrySession : Sentry.ISentrySession
     {
@@ -1348,8 +1352,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public class FormRequestPayloadExtractor : Sentry.Extensibility.BaseRequestPayloadExtractor
     {
@@ -1394,8 +1400,10 @@ namespace Sentry.Extensibility
         public System.IDisposable PushScope() { }
         public System.IDisposable PushScope<TState>(TState state) { }
         public void ResumeSession() { }
+        public void SetTag(string key, string value) { }
         public void StartSession() { }
         public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }
+        public void UnsetTag(string key) { }
     }
     public interface IBackgroundWorker
     {
diff --git a/test/Sentry.Tests/SentrySdkTests.cs b/test/Sentry.Tests/SentrySdkTests.cs
@@ -467,6 +467,57 @@ async Task ModifyScope()
         }
     }
 
+    [Fact]
+    public void SetTag_SetsTagOnCurrentScope()
+    {
+        using var _ = SentrySdk.Init(o =>
+        {
+            o.Dsn = ValidDsn;
+            o.AutoSessionTracking = false;
+            o.BackgroundWorker = Substitute.For<IBackgroundWorker>();
+            o.InitNativeSdks = false;
+        });
+
+        const string key = "key";
+        const string value = "value";
+
+        SentrySdk.SetTag(key, value);
+
+        string actual = null;
+        SentrySdk.ConfigureScope(s => actual = s.Tags[key]);
+
+        Assert.Equal(value, actual);
+    }
+
+    [Fact]
+    public void SetTag_NotInit_NoOp() => SentrySdk.SetTag("key", "value");
+
+    [Fact]
+    public void UnsetTag_UnsetsTagOnCurrentScope()
+    {
+        using var _ = SentrySdk.Init(o =>
+        {
+            o.Dsn = ValidDsn;
+            o.AutoSessionTracking = false;
+            o.BackgroundWorker = Substitute.For<IBackgroundWorker>();
+            o.InitNativeSdks = false;
+        });
+
+        const string key = "key";
+        const string value = "value";
+
+        SentrySdk.SetTag(key, value);
+        SentrySdk.UnsetTag(key);
+
+        bool? containsKey = null;
+        SentrySdk.ConfigureScope(s => containsKey = s.Tags.ContainsKey(key));
+
+        Assert.True(containsKey is false);
+    }
+
+    [Fact]
+    public void UnsetTag_NotInit_NoOp() => SentrySdk.UnsetTag("key");
+
     [Fact]
     public void CaptureEvent_WithConfiguredScope_ScopeAppliesToEvent()
     {

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,10 @@ public async Task ConfigureScopeAsync(Func<Scope, Task> configureScope)`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`
	`114`	`+ public void SetTag(string key, string value) => ScopeManager.SetTag(key, value);`
	`115`	`+`
	`116`	`+ public void UnsetTag(string key) => ScopeManager.UnsetTag(key);`
	`117`	`+`
`114`	`118`	`public IDisposable PushScope() => ScopeManager.PushScope();`
`115`	`119`
`116`	`120`	`public IDisposable PushScope<TState>(TState state) => ScopeManager.PushScope(state);`
Original file line number	Diff line number	Diff line change
`@@ -259,6 +259,8 @@ namespace Sentry`
`259`	`259`	`System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope);`
`260`	`260`	`System.IDisposable PushScope();`
`261`	`261`	`System.IDisposable PushScope<TState>(TState state);`
	`262`	`+ void SetTag(string key, string value);`
	`263`	`+ void UnsetTag(string key);`
`262`	`264`	`}`
`263`	`265`	`public interface ISentryScopeStateProcessor`
`264`	`266`	`{`
`@@ -863,12 +865,14 @@ namespace Sentry`
`863`	`865`	`public static System.IDisposable PushScope() { }`
`864`	`866`	`public static System.IDisposable PushScope<TState>(TState state) { }`
`865`	`867`	`public static void ResumeSession() { }`
	`868`	`+ public static void SetTag(string key, string value) { }`
`866`	`869`	`public static void StartSession() { }`
`867`	`870`	`public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context) { }`
`868`	`871`	`public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
`869`	`872`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation) { }`
`870`	`873`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }`
`871`	`874`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }`
	`875`	`+ public static void UnsetTag(string key) { }`
`872`	`876`	`}`
`873`	`877`	`public class SentrySession : Sentry.ISentrySession`
`874`	`878`	`{`
`@@ -1367,8 +1371,10 @@ namespace Sentry.Extensibility`
`1367`	`1371`	`public System.IDisposable PushScope() { }`
`1368`	`1372`	`public System.IDisposable PushScope<TState>(TState state) { }`
`1369`	`1373`	`public void ResumeSession() { }`
	`1374`	`+ public void SetTag(string key, string value) { }`
`1370`	`1375`	`public void StartSession() { }`
`1371`	`1376`	`public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
	`1377`	`+ public void UnsetTag(string key) { }`
`1372`	`1378`	`}`
`1373`	`1379`	`public class FormRequestPayloadExtractor : Sentry.Extensibility.BaseRequestPayloadExtractor`
`1374`	`1380`	`{`
`@@ -1413,8 +1419,10 @@ namespace Sentry.Extensibility`
`1413`	`1419`	`public System.IDisposable PushScope() { }`
`1414`	`1420`	`public System.IDisposable PushScope<TState>(TState state) { }`
`1415`	`1421`	`public void ResumeSession() { }`
	`1422`	`+ public void SetTag(string key, string value) { }`
`1416`	`1423`	`public void StartSession() { }`
`1417`	`1424`	`public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
	`1425`	`+ public void UnsetTag(string key) { }`
`1418`	`1426`	`}`
`1419`	`1427`	`public interface IBackgroundWorker`
`1420`	`1428`	`{`
Original file line number	Diff line number	Diff line change
`@@ -247,6 +247,8 @@ namespace Sentry`
`247`	`247`	`System.Threading.Tasks.Task ConfigureScopeAsync(System.Func<Sentry.Scope, System.Threading.Tasks.Task> configureScope);`
`248`	`248`	`System.IDisposable PushScope();`
`249`	`249`	`System.IDisposable PushScope<TState>(TState state);`
	`250`	`+ void SetTag(string key, string value);`
	`251`	`+ void UnsetTag(string key);`
`250`	`252`	`}`
`251`	`253`	`public interface ISentryScopeStateProcessor`
`252`	`254`	`{`
`@@ -844,12 +846,14 @@ namespace Sentry`
`844`	`846`	`public static System.IDisposable PushScope() { }`
`845`	`847`	`public static System.IDisposable PushScope<TState>(TState state) { }`
`846`	`848`	`public static void ResumeSession() { }`
	`849`	`+ public static void SetTag(string key, string value) { }`
`847`	`850`	`public static void StartSession() { }`
`848`	`851`	`public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context) { }`
`849`	`852`	`public static Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
`850`	`853`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation) { }`
`851`	`854`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }`
`852`	`855`	`public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }`
	`856`	`+ public static void UnsetTag(string key) { }`
`853`	`857`	`}`
`854`	`858`	`public class SentrySession : Sentry.ISentrySession`
`855`	`859`	`{`
`@@ -1348,8 +1352,10 @@ namespace Sentry.Extensibility`
`1348`	`1352`	`public System.IDisposable PushScope() { }`
`1349`	`1353`	`public System.IDisposable PushScope<TState>(TState state) { }`
`1350`	`1354`	`public void ResumeSession() { }`
	`1355`	`+ public void SetTag(string key, string value) { }`
`1351`	`1356`	`public void StartSession() { }`
`1352`	`1357`	`public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
	`1358`	`+ public void UnsetTag(string key) { }`
`1353`	`1359`	`}`
`1354`	`1360`	`public class FormRequestPayloadExtractor : Sentry.Extensibility.BaseRequestPayloadExtractor`
`1355`	`1361`	`{`
`@@ -1394,8 +1400,10 @@ namespace Sentry.Extensibility`
`1394`	`1400`	`public System.IDisposable PushScope() { }`
`1395`	`1401`	`public System.IDisposable PushScope<TState>(TState state) { }`
`1396`	`1402`	`public void ResumeSession() { }`
	`1403`	`+ public void SetTag(string key, string value) { }`
`1397`	`1404`	`public void StartSession() { }`
`1398`	`1405`	`public Sentry.ITransactionTracer StartTransaction(Sentry.ITransactionContext context, System.Collections.Generic.IReadOnlyDictionary<string, object?> customSamplingContext) { }`
	`1406`	`+ public void UnsetTag(string key) { }`
`1399`	`1407`	`}`
`1400`	`1408`	`public interface IBackgroundWorker`
`1401`	`1409`	`{`