feat: Allow Hybrid SDK to `setTrace` by bitsandfoxes · Pull Request #4137 · getsentry/sentry-java

bitsandfoxes · 2025-02-04T18:28:25Z

Resolves #3562
Follows #4188

Depends on sentry-native release: getsentry/sentry-native#1137
Corresponding PR on Unity: getsentry/sentry-unity#1997

Context

Native events and crashes do not share the same trace ID as the rest of the layers. This is relevant in two ways:

Synching the trace for native events
Allowing hybrid SDKs (i.e. RN, Unity) to propagate their trace to Java - and implicitly to native

Changes

Setting the trace from hybrid SDKs

The Java SDK provides an API to allow hybrid SDKs to set a trace outside of accepting trace-header & baggage. This is done in the InternalSentrySdk. It accepts a trace ID, the parent span ID, and optionally a sample rate, and a sample rand. Assuming that enableTraceIdGeneration and performance is disabled, writing these to the propagation context allows the SDK to effectively "continue the trace".

Synching `trace` to native

The NDKScopeObserver is already getting invoked on changes to the propagation context via setTrace. The changes in getsentry/sentry-native#1137 provide a way to set the Trace context on the native scope.

Result

github-actions · 2025-02-04T18:28:57Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against e6a7438

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java

sentry/src/main/java/io/sentry/JsonSerializer.java

sentry/src/main/java/io/sentry/Sentry.java

krystofwoldrich · 2025-02-10T15:23:25Z

In JS the spanId is now called propagationSpanId but it's the same thing with different names.

https://github.com/getsentry/sentry-javascript/blob/95cc948ef0136e1228916e3216c4a08b84fa8230/packages/core/src/types-hoist/tracing.ts#L45

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java

sentry/src/main/java/io/sentry/Sentry.java

github-actions · 2025-02-26T15:08:17Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

github-actions · 2025-02-26T17:55:27Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

github-actions · 2025-02-26T18:12:11Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

adinauer

Left some thoughts after giving this a quick look

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

adinauer · 2025-02-27T07:30:56Z

sentry/src/main/java/io/sentry/PropagationContext.java

+      final @NotNull String traceId,
+      final @NotNull String spanId,
+      final @Nullable Double decisionSampleRate,
+      final @Nullable Double decisionSampleRand) {


Can we add an optional Baggage param here as well?
I would assume we want to sync that between the SDKs as well.

I don't see the need or benefit of doing that from the Unity SDK's perspective. @krystofwoldrich would this help RN?

At the moment, I don't see why we would need Baggage synced as well.

I believe we pass replayId via baggage to downstream services
Might need that on React Native (which has Replay)

We don't need that because the ReplayID is generated on native and synced up to RN Replay Integration which adds it to DSC.

https://github.com/getsentry/sentry-react-native/blob/5dff5ee95fb4c3d8f2589b80d4d355fecde17778/packages/core/src/js/replay/mobilereplay.ts#L107

The traceID is the opposite, hybrid (RN) generates it and we need to sync it down to native.

github-actions · 2025-02-27T10:06:02Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

github-actions · 2025-02-28T10:59:29Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

github-actions · 2025-02-28T11:10:14Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	385.00 ms	422.86 ms	37.86 ms
Size	1.58 MiB	2.21 MiB	642.02 KiB

github-actions · 2025-02-28T11:55:38Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

adinauer

LGTM

markushi

LGTM!

bitsandfoxes mentioned this pull request Feb 4, 2025

Propagate traceId to native layer getsentry/sentry-unity#1998

Closed

16 tasks

bitsandfoxes force-pushed the feat/set-trace-id branch from 0c5d7ff to a4b2d66 Compare February 5, 2025 17:57

bitsandfoxes commented Feb 6, 2025

View reviewed changes

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java Outdated Show resolved Hide resolved

bitsandfoxes commented Feb 6, 2025

View reviewed changes

sentry/src/main/java/io/sentry/JsonSerializer.java Outdated Show resolved Hide resolved

bitsandfoxes requested review from adinauer, markushi and romtsn February 7, 2025 10:25

krystofwoldrich reviewed Feb 10, 2025

View reviewed changes

sentry/src/main/java/io/sentry/Sentry.java Outdated Show resolved Hide resolved

romtsn reviewed Feb 10, 2025

View reviewed changes

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java Show resolved Hide resolved

romtsn mentioned this pull request Feb 10, 2025

Add Fragment Transactions #3719

Open

krystofwoldrich reviewed Feb 11, 2025

View reviewed changes

sentry/src/main/java/io/sentry/Sentry.java Outdated Show resolved Hide resolved

bitsandfoxes added 14 commits February 20, 2025 14:30

added option to disable trace ID generation

c233756

rename. recheck

d0f9805

LifeCycleIntegrationTest

c124eb1

GestureListener tests

ac7be23

spotless

46039a5

apidump

14ab70e

Updated CHANGELOG.md

4a94bdd

Merge branch 'main' into feat/auto-trace-id-generation

ef20aae

sync trace as well

461aa8a

passing span ID as well

b95088c

added API taking traceId and spanID

19c0eaa

renamed

d7316ea

.

3d99e63

Update sentry/src/main/java/io/sentry/JsonSerializer.java

b427553

bitsandfoxes force-pushed the feat/set-trace-id branch 2 times, most recently from e5c09c4 to b427553 Compare February 21, 2025 12:53

Merge branch 'feat/auto-trace-id-generation' into feat/set-trace-id

82deae2

bitsandfoxes added 2 commits February 26, 2025 15:15

.

dc0a6d5

Merge branch 'main' into feat/set-trace-id

7447f11

bitsandfoxes requested a review from romtsn February 26, 2025 17:23

test

68fea13

bitsandfoxes requested a review from krystofwoldrich February 26, 2025 17:30

bitsandfoxes marked this pull request as ready for review February 26, 2025 17:30

bitsandfoxes requested review from lcian and stefanosiano as code owners February 26, 2025 17:30

merged

31c6718

bitsandfoxes changed the title ~~feat: Propagate trace to NDK~~ feat: Allow Hybrid SDK to setTrace Feb 26, 2025

make the repo häppy

2243841

adinauer reviewed Feb 27, 2025

View reviewed changes

reviewref

d9d43ee

bumped native ndk

f8f097a

Updated CHANGELOG.md

e6a7438

adinauer approved these changes Mar 3, 2025

View reviewed changes

markushi approved these changes Mar 3, 2025

View reviewed changes

bitsandfoxes merged commit 158d688 into main Mar 3, 2025
34 of 35 checks passed

bitsandfoxes deleted the feat/set-trace-id branch March 3, 2025 08:54

bitsandfoxes mentioned this pull request Mar 5, 2025

feat: Allow IScopeObserver to observe trace getsentry/sentry-dotnet#4026

Merged

krystofwoldrich mentioned this pull request Mar 11, 2025

Synchronize PropagationContext across layers getsentry/sentry-react-native#3918

Open

bitsandfoxes mentioned this pull request Apr 10, 2025

feat: Allow Hybrid SDKs to setTrace getsentry/sentry-cocoa#5081

Merged

7 tasks

bitsandfoxes mentioned this pull request Dec 16, 2025

Synchronize PropagationContext across layers getsentry/sentry-dart#3406

Closed

Uh oh!

Comments

Conversation

bitsandfoxes commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Changes

Setting the trace from hybrid SDKs

Synching trace to native

Result

Uh oh!

github-actions bot commented Feb 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krystofwoldrich commented Feb 10, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 26, 2025 • edited by bitsandfoxes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 Detected changes in high risk code 🚨

Uh oh!

github-actions bot commented Feb 26, 2025 • edited by bitsandfoxes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 Detected changes in high risk code 🚨

Uh oh!

github-actions bot commented Feb 26, 2025 • edited by bitsandfoxes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 Detected changes in high risk code 🚨

Uh oh!

adinauer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adinauer Feb 27, 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!

bitsandfoxes Feb 27, 2025

Choose a reason for hiding this comment

Uh oh!

krystofwoldrich Mar 3, 2025

Choose a reason for hiding this comment

Uh oh!

bruno-garcia Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

krystofwoldrich Mar 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 27, 2025

🚨 Detected changes in high risk code 🚨

Uh oh!

github-actions bot commented Feb 28, 2025

🚨 Detected changes in high risk code 🚨

Uh oh!

github-actions bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Uh oh!

github-actions bot commented Feb 28, 2025 • edited by bitsandfoxes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 Detected changes in high risk code 🚨

Uh oh!

adinauer left a comment

Choose a reason for hiding this comment

Uh oh!

markushi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

bitsandfoxes commented Feb 4, 2025 •

edited

Loading

Synching `trace` to native

github-actions bot commented Feb 4, 2025 •

edited

Loading

github-actions bot commented Feb 26, 2025 •

edited by bitsandfoxes

Loading

github-actions bot commented Feb 26, 2025 •

edited by bitsandfoxes

Loading

github-actions bot commented Feb 26, 2025 •

edited by bitsandfoxes

Loading

adinauer Feb 27, 2025 •

edited

Loading

github-actions bot commented Feb 28, 2025 •

edited

Loading

github-actions bot commented Feb 28, 2025 •

edited by bitsandfoxes

Loading