fix: include `Data` set via `ITransactionTracer` in `SentryTransaction` by Flash0ver · Pull Request #4148 · getsentry/sentry-dotnet

Flash0ver · 2025-04-28T09:48:52Z

relates to #3936

Changes

remove backing store of SentryTransaction.Data
reuse Data of SentryContexts.Trace instead

Added links to discussions from the original PR (if I understood all the context correctly).
Added questions where I am uncertain whether it's the correct way of fixing the issue.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Flash0ver · 2025-04-28T09:57:23Z

src/Sentry/TransactionTracer.cs


    /// <inheritdoc />
-    public void SetData(string key, object? value) => _data[key] = value;
+    public void SetData(string key, object? value) => _contexts.Trace.SetData(key, value);


question: concurrency

The now used

sentry-dotnet/src/Sentry/Protocol/Trace.cs

Line 53 in 3745efe

private Dictionary<string, object?> _data = new();

currently is a regular Dictionary`2.
Should this now become a ConcurrentDictionary`2?
Because it's also the private readonly ConcurrentDictionary<string, object?> _data = new(); that this PR removes from this type?

Or is that an indicator that this fix is technically not quite right?

Relates to #3936 (comment) and #3936 (comment)

SentryTransaction shouldn't be accessed concurrently since it represents "a point in time" instance that gets serialized to Sentry.

The TransactionTracer is potentially accessed concurrently (we set it onto the Scope which has concurrent access in both global mode (every ConfigureScope call access the same scope instance) or non global mode (since even though there's a single Scope instance per thread, we do access/read things in order to make clones for new threads).

Throwing Concurrent around is not always the solution. In this case for sure not since we want SentryTrasaction to be a snapshot, so we need a deep clone here. We don't want just a clone of the collection if the items in the collection are mutable. I wrote a note above about this.

If things on the context are immutable, things are easier though we could have data loss if we have concurrent updates without synchronization.

Hm... I see what you're saying. In the original code the TrancactionTracer stored additional data in private readonly ConcurrentDictionary<string, object?> _data = new();

In the new code that data instead gets stored in _contexts.Trace._data which is private Dictionary<string, object?> _data = new();.

So yes, I think we should probably make the this a concurrent dictionary:

sentry-dotnet/src/Sentry/Protocol/Trace.cs

Line 53 in 4169cb7

private Dictionary<string, object?> _data = new();

Flash0ver · 2025-04-28T10:02:52Z

src/Sentry/TransactionTracer.cs

    /// <inheritdoc />
-    public IReadOnlyDictionary<string, object?> Data => _data;
-
+    public IReadOnlyDictionary<string, object?> Data => _contexts.Trace.Data;


question: reference Contexts in SentryTransaction vs copy Contexts to SentryTransaction

When creating a SentryTransaction from ITransactionTracer, we reference the SentryContexts:

sentry-dotnet/src/Sentry/SentryTransaction.cs

Line 246 in 3745efe

Contexts = tracer.Contexts;

Should we instead copy the Contexts (via e.g. SentryContexts.Clone)?

Or is that an indicator that this fix here is not quite right, technically?
Should we maybe, rather than have SetData writing into SentryContexts.Trace.Data directly, instead when creating the SentryTransaction from the ITransactionTracer copy the ITransactionTracer.Data (backed by it's own Dictionary`2) over to the Context of the new SentryTransaction.
E.g. something like

class SentryTransaction { public SentryTransaction(ITransactionTracer tracer) : this(tracer.Name, tracer.NameSource) { Contexts = tracer.Contexts; foreach (KeyValuePair<string, object?> data in tracer.Data) { Contexts.Trace.SetData(data.Key, data.Value); } } }

or similar.
But that would have a side-effect on the Contexts of TransactionTracer, which I don't think is expected when creating a new SentryTransaction from TransactionTracer.
Should we perhaps indeed make a copy of the Trace and/or SentryContext?

Relates to #3936 (comment)

I think at this point the tracer is immutable - we're capturing the transaction trace so the trace should be finished and won't change.

Flash0ver · 2025-04-28T10:19:35Z

test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt

+            Data: {
+              http.request.method: GET,
+              http.response.status_code: 200
+            }


note: from

sentry-dotnet/src/Sentry.AspNetCore/SentryTracingMiddleware.cs

Line 89 in 3745efe

transaction?.SetExtra(OtelSemanticConventions.AttributeHttpRequestMethod, context.Request.Method);

sentry-dotnet/src/Sentry.AspNetCore/SentryTracingMiddleware.cs

Line 173 in 3745efe

transaction.SetExtra(OtelSemanticConventions.AttributeHttpResponseStatusCode, context.Response.StatusCode);

Flash0ver · 2025-04-28T10:22:07Z

test/Sentry.Tests/Protocol/SentryTransactionTests.cs

            return o;
        });
+
+        Assert.Contains($$"""


note: I kept this test similar to

sentry-dotnet/test/Sentry.Tests/Protocol/SentryEventTests.verify.cs

Line 6 in 3745efe

public async Task SerializeObject_AllPropertiesSetToNonDefault_SerializesValidObject()

which also does a serialize/deserialize-roundtrip test
plus an additional "Contains-JSON" check on the serialized string

bruno-garcia · 2025-04-28T19:56:50Z

src/Sentry/TransactionTracer.cs

    /// <inheritdoc />
-    public IReadOnlyDictionary<string, object?> Data => _data;
-
+    public IReadOnlyDictionary<string, object?> Data => _contexts.Trace.Data;


Note that if you're copying all objects from the collection while they are mutable and still on the scope, mutations done on the scope will be reflected on the transaction object resulting in possible inaccurate data being sent to Sentry, or potentially crashes when we read the data for serialization while the data is being mutated

bruno-garcia · 2025-04-28T20:00:20Z

src/Sentry/TransactionTracer.cs


    /// <inheritdoc />
-    public void SetData(string key, object? value) => _data[key] = value;
+    public void SetData(string key, object? value) => _contexts.Trace.SetData(key, value);


SentryTransaction shouldn't be accessed concurrently since it represents "a point in time" instance that gets serialized to Sentry.

The TransactionTracer is potentially accessed concurrently (we set it onto the Scope which has concurrent access in both global mode (every ConfigureScope call access the same scope instance) or non global mode (since even though there's a single Scope instance per thread, we do access/read things in order to make clones for new threads).

Throwing Concurrent around is not always the solution. In this case for sure not since we want SentryTrasaction to be a snapshot, so we need a deep clone here. We don't want just a clone of the collection if the items in the collection are mutable. I wrote a note above about this.

If things on the context are immutable, things are easier though we could have data loss if we have concurrent updates without synchronization.

github-actions · 2026-03-18T22:47:18Z

Semver Impact of This PR

⚪ None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

Breaking Changes 🛠

The _Metrics_ APIs are now stable: removed Experimental from SentrySdk, SentryOptions and IHub by Flash0ver in #5023

Features ✨

Report a new _Diagnostic_ (SENTRY1001) when a Metrics-API is invoked with an unsupported numeric type by Flash0ver in #4840

Fixes 🐛

fix: include Data set via ITransactionTracer in SentryTransaction by Flash0ver in #4148

fix: CaptureFeedback now applies event processors by jamescrosswell in #4942

Dependencies ⬆️

Deps

chore(deps): update Cocoa SDK to v9.7.0 by github-actions in #5015
chore(deps): update Java SDK to v8.35.0 by github-actions in #5017
chore(deps): replaced the heavy protobuf-javalite 3.25.8 dependency with a light-weight epitaph 0.1.0 alternative on Android (getsentry/sentry-java#5157) by github-actions in #5017
chore(deps): update CLI to v3.3.3 by github-actions in #5002
chore(deps): update Cocoa SDK to v9.6.0 by github-actions in #4958

Other

ref: Use .NET 6.0 ArgumentNullException throw helpers by copilot-swe-agent in #4985

_{🤖 This preview updates automatically when you update the PR.}

codecov · 2026-03-18T23:19:40Z

Codecov Report

❌ Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.00%. Comparing base (a4a8ded) to head (454ceaf).

Files with missing lines	Patch %	Lines
src/Sentry/Internal/Extensions/JsonExtensions.cs	66.66%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4148      +/-   ##
==========================================
- Coverage   74.03%   74.00%   -0.03%     
==========================================
  Files         499      499              
  Lines       18044    18049       +5     
  Branches     3510     3512       +2     
==========================================
- Hits        13358    13357       -1     
- Misses       3830     3838       +8     
+ Partials      856      854       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Flash0ver added 7 commits April 28, 2025 10:02

test(trace): add expected data to trace context

e6e6c9b

test(transaction): expect SetData via TransactionTracer

f57868e

test(transaction): expect "data" via TransactionTracer

31e9125

fix(transaction): store Data from Tracer in Context

13c2a16

test(trace): add missing name

cb9e0c3

test(AspNetCore): update verified

3db4876

docs(CHANGELOG): add entry to unreleased Fixes

e91052d

Flash0ver self-assigned this Apr 28, 2025

Flash0ver requested review from aritchie and jamescrosswell as code owners April 28, 2025 09:48

docs(CHANGELOG): set pull request

3745efe

Flash0ver requested a review from Copilot April 28, 2025 09:51

Copilot AI reviewed Apr 28, 2025

View reviewed changes

Flash0ver commented Apr 28, 2025

View reviewed changes

bruno-garcia reviewed Apr 28, 2025

View reviewed changes

Flash0ver mentioned this pull request Apr 30, 2025

Updates the Unity SDK docs with new SetData methods on spans & transa… getsentry/sentry-docs#13457

Merged

6 tasks

Merge branch 'main' into fix/transaction/tracer-setdata-not-sent

9216b0f

This was referenced Mar 18, 2026

feat: Add option to exclude certain HTTP statuses from tracing #5034

Draft

Drop support setMeasurement in favor of transaction.SetData #4113

Open

Flash0ver added 2 commits March 18, 2026 22:53

Merge branch 'main' into fix/transaction/tracer-setdata-not-sent

0e9d7be

fix: change Trace's data from non-Concurrent to Concurrent-Dictionary

f401ea0

docs: fix spacing

454ceaf

Uh oh!

Conversation

Flash0ver commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Flash0ver Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bruno-garcia Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Flash0ver Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Flash0ver Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Flash0ver Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

bruno-garcia Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

bruno-garcia Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

Breaking Changes 🛠

Features ✨

Fixes 🐛

Dependencies ⬆️

Deps

Other

Uh oh!

codecov bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Flash0ver commented Apr 28, 2025 •

edited

Loading

Flash0ver Apr 28, 2025 •

edited

Loading

Flash0ver Apr 28, 2025 •

edited

Loading

github-actions bot commented Mar 18, 2026 •

edited

Loading

codecov bot commented Mar 18, 2026 •

edited

Loading