Emit transaction.data inside contexts.trace.data

[cleptric]

We need to ensure that transaction.data is sent as contexts.trace.data so we can also attach/extract metrics from transaction data.

SDKs

Beta Give feedback

1. JavaScript SDK
2. Electron SDK
3. Python SDK Emit transaction.data inside contexts.trace.data sentry-python#3372
4. PHP SDK
5. Laravel SDK
6. Symfony SDK
7. Ruby SDK Send transaction.data inside contexts.trace.data sentry-ruby#2363
8. Capacitor SDK
9. Cordova SDK
10. Emit transaction.data inside contexts.trace.data sentry-dart#2257
    Platform: Dart +1
11. Emit transaction.data inside contexts.trace.data sentry-java#3626
    Platform: Android Platform: Java +2
    
12. Emit transaction.data inside contexts.trace.data sentry-cocoa#4248
    Platform: Cocoa +1
    
13. Kotlin Multiplatform SDK (depends on native sdks)
14. Java SDK - covered with Android, see above
15. Emit transaction.data inside contexts.trace.data sentry-react-native#4011
    Platform: React-Native +1
    
16. Emit transaction.data inside contexts.trace.data sentry-native#1074
    Platform: Native +1
    
17. Go SDK Emit transaction.data inside contexts.trace.data sentry-go#863
18. Elixir SDK (NA - no performance yet)
19. Rust SDK
20. .NET SDK
21. Unity SDK
22. Unreal SDK
23. PowerShell SDK
24. Sentry CLI

[jan-auer]

Example usage for this in Python is:

with scope.start_transaction(name="hello"):
    span_or_tx = sentry_sdk.get_current_span()
    span_or_tx.set_data("foo", "bar")

[Lms24]

I checked for JS and we don't set transactionEvent.data at all, but only transactionEvent.contexts.trace.data. Is this alright?

(Fwiw, in JS we no longer have setData or setTag APIs but only setAttribute which always populates span.data for child spans or event.contexts.trace.data for the root span (i.e. transaction event))

[jan-auer]

@Lms24 yes, that's the right way. We expect root span data (i.e. span data of the transaction) to be placed into contexts.trace.data.

There is no data field on transactions. I believe @cleptric is referring to transaction._data in the case of the Python SDK, which is the transaction's own span's data.

[cleptric]

In some SDKs, transactions are inherited from span and, therefore, have a data property. The change we need to make is to attach this data to the transaction envelope item payload under contexts.trace.data.

[krystofwoldrich]

@Lms24 From which JS SDK version is event.contexts.trace.data populated? Is this part of v7 or only v8?

[Lms24]

As far as I know from both versions. I don't recall making any changes there for v8

[lucas-zimerman]

Capacitor should be marked as ok since it relies on the JavaScript SDK for that. I will double-check the Cordova one

[markushi]

@cleptric sentry-java currently sets transactionEvent.data as transactionEvent.extra (see comment here) - should we still do that or simply move it all to contexts.trace.data?

[cleptric]

Please move it, extra should not be used by SDKs anymore.

[lbloder]

Please move it, extra should not be used by SDKs anymore.

@cleptric Could you clarify what is meant by this? Does this mean we should remove extra completely (i.e. remove it from the SentryEvent class) or just not set any data to extras but keep it so that users can write to it?

[cleptric]

We can keep any setExtra() etc. APIs but the SDK should not add any data automatically onto extra.

[lucas-zimerman]

Finished checking Cordova and the data is correctly set.