Emit transaction.data inside contexts.trace.data

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Emit transaction.data inside contexts.trace.data ([#3936](https://github.com/getsentry/sentry-dotnet/pull/3936))
+
 ## 5.1.0
 
 ### Significant change in behavior

src/Sentry/Protocol/Trace.cs

@@ -50,6 +50,21 @@ internal set
     /// <inheritdoc />
     public bool? IsSampled { get; internal set; }
 
+    private Dictionary<string, object?> _data = new();
+
+    /// <summary>
+    /// Get the metadata
+    /// </summary>
+    public IReadOnlyDictionary<string, object?> Data => _data;
+
+    /// <summary>
+    /// Adds metadata to the trace
+    /// </summary>
+    /// <param name="key"></param>
+    /// <param name="value"></param>
+    public void SetData(string key, object? value)
+        => _data[key] = value;
+
     /// <summary>
     /// Clones this instance.
     /// </summary>
@@ -63,7 +78,8 @@ internal set
         Operation = Operation,
         Origin = Origin,
         Status = Status,
-        IsSampled = IsSampled
+        IsSampled = IsSampled,
+        _data = _data.ToDict()
     };
 
     /// <summary>
@@ -103,6 +119,7 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
         writer.WriteString("origin", Origin ?? Internal.OriginHelper.Manual);
         writer.WriteStringIfNotWhiteSpace("description", Description);
         writer.WriteStringIfNotWhiteSpace("status", Status?.ToString().ToSnakeCase());
+        writer.WriteDictionaryIfNotEmpty("data", _data, logger);
 
         writer.WriteEndObject();
     }
@@ -120,6 +137,7 @@ public static Trace FromJson(JsonElement json)
         var description = json.GetPropertyOrNull("description")?.GetString();
         var status = json.GetPropertyOrNull("status")?.GetString()?.Replace("_", "").ParseEnum<SpanStatus>();
         var isSampled = json.GetPropertyOrNull("sampled")?.GetBoolean();
+        var data = json.GetPropertyOrNull("data")?.GetDictionaryOrNull() ?? new();
 
         return new Trace
         {
@@ -130,7 +148,8 @@ public static Trace FromJson(JsonElement json)
             Origin = origin,
             Description = description,
             Status = status,
-            IsSampled = isSampled
+            IsSampled = isSampled,
+            _data = data
         };
     }
 }

src/Sentry/SentryTransaction.cs

@@ -339,6 +339,7 @@ public void AddBreadcrumb(Breadcrumb breadcrumb) =>
         _breadcrumbs.Add(breadcrumb);
 
     /// <inheritdoc />
+    [Obsolete("Add metadata to Contexts.Trace.SetData")]
     public void SetExtra(string key, object? value) =>
         _extra[key] = value;
 

test/Sentry.Tests/SerializationTests.cs

@@ -0,0 +1,50 @@
+using System.Text.Json.Nodes;
+
+namespace Sentry.Tests;
+
+public partial class SerializationTests
+{
+    private readonly IDiagnosticLogger _testOutputLogger;
+
+    public SerializationTests(ITestOutputHelper output)
+    {
+        _testOutputLogger = new TestOutputDiagnosticLogger(output);
+    }
+
+    [Fact]
+    public void Serialization_TransactionAndSpanData()
+    {
+        var hub = Substitute.For<IHub>();
+        var context = new TransactionContext("name", "operation", new SentryTraceHeader(SentryId.Empty, SpanId.Empty, false));
+        var transactionTracer = new TransactionTracer(hub, context);
+        var span = transactionTracer.StartChild("childop");
+        span.SetExtra("span1", "value1");
+
+        var transaction = new SentryTransaction(transactionTracer)
+        {
+            IsSampled = false
+        };
+        transaction.Contexts.Trace.SetData("transaction1", "transaction_value");
+        var json = transaction.ToJsonString(_testOutputLogger);
+        _testOutputLogger.LogDebug(json);
+
+        var node = JsonNode.Parse(json);
+        var dataNode = node?["contexts"]?["trace"]?["data"]?["transaction1"]?.GetValue<string>();
+        dataNode.Should().NotBeNull("contexts.trace.data.transaction1 not found");
+        dataNode.Should().Be("transaction_value");
+
+        var spansNode = node?["spans"]?.AsArray();
+        spansNode.Should().NotBeNull("spans not found");
+        var spanDataNode = spansNode!.FirstOrDefault()?["data"]?["span1"]?.GetValue<string>();
+        spanDataNode.Should().NotBeNull("spans.data not found");
+        spanDataNode.Should().Be("value1");
+
+        // verify deserialization
+        var reader = new Utf8JsonReader(Encoding.UTF8.GetBytes(json));
+        var el = JsonElement.ParseValue(ref reader);
+        var backTransaction = SentryTransaction.FromJson(el);
+
+        backTransaction.Spans.First().Extra["span1"].Should().Be("value1", "Span value missing");
+        backTransaction.Contexts.Trace.Data["transaction1"].Should().Be("transaction_value", "Transaction value missing");
+    }
+}

test/Sentry.Tests/SerializationTests.verify.cs

@@ -4,15 +4,8 @@
 
 namespace Sentry.Tests;
 
-public class SerializationTests
+public partial class SerializationTests
 {
-    private readonly IDiagnosticLogger _testOutputLogger;
-
-    public SerializationTests(ITestOutputHelper output)
-    {
-        _testOutputLogger = new TestOutputDiagnosticLogger(output);
-    }
-
     [Theory]
     [MemberData(nameof(GetData))]
     public async Task Serialization(string name, object target)