Skip to content

feat: Allow Hybrid SDK to setTrace #4137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Mar 3, 2025
+102 −1
Merged

feat: Allow Hybrid SDK to setTrace #4137

Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
c233756
added option to disable trace ID generation
bitsandfoxes Feb 20, 2025
d0f9805
rename. recheck
bitsandfoxes Feb 20, 2025
c124eb1
LifeCycleIntegrationTest
bitsandfoxes Feb 20, 2025
ac7be23
GestureListener tests
bitsandfoxes Feb 20, 2025
46039a5
spotless
bitsandfoxes Feb 20, 2025
14ab70e
apidump
bitsandfoxes Feb 20, 2025
4a94bdd
Updated CHANGELOG.md
bitsandfoxes Feb 20, 2025
ef20aae
Merge branch 'main' into feat/auto-trace-id-generation
bitsandfoxes Feb 20, 2025
461aa8a
sync trace as well
bitsandfoxes Feb 4, 2025
b95088c
passing span ID as well
bitsandfoxes Feb 5, 2025
19c0eaa
added API taking traceId and spanID
bitsandfoxes Feb 5, 2025
d7316ea
renamed
bitsandfoxes Feb 6, 2025
3d99e63
.
bitsandfoxes Feb 6, 2025
b427553
Update sentry/src/main/java/io/sentry/JsonSerializer.java
bitsandfoxes Feb 7, 2025
82deae2
Merge branch 'feat/auto-trace-id-generation' into feat/set-trace-id
bitsandfoxes Feb 21, 2025
4152092
Format code
getsentry-bot Feb 21, 2025
2af13de
merge mixup
bitsandfoxes Feb 21, 2025
cba1f4c
merge?
bitsandfoxes Feb 25, 2025
05147f9
merge
bitsandfoxes Feb 25, 2025
cbe837c
moved 'settrace' to internal
bitsandfoxes Feb 25, 2025
9a10493
updated settrace to accept sample rate and sample rand
bitsandfoxes Feb 26, 2025
a589c3d
renamed
bitsandfoxes Feb 26, 2025
093e907
docs
bitsandfoxes Feb 26, 2025
0682748
Format code
getsentry-bot Feb 26, 2025
dc0a6d5
.
bitsandfoxes Feb 26, 2025
7447f11
Merge branch 'main' into feat/set-trace-id
bitsandfoxes Feb 26, 2025
68fea13
test
bitsandfoxes Feb 26, 2025
31c6718
merged
bitsandfoxes Feb 26, 2025
2243841
make the repo häppy
bitsandfoxes Feb 26, 2025
d9d43ee
reviewref
bitsandfoxes Feb 27, 2025
f8f097a
bumped native ndk
bitsandfoxes Feb 28, 2025
e6a7438
Updated CHANGELOG.md
bitsandfoxes Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sentry-android-core/api/sentry-android-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ public final class io/sentry/android/core/InternalSentrySdk {
public static fun getAppStartMeasurement ()Ljava/util/Map;
public static fun getCurrentScope ()Lio/sentry/IScope;
public static fun serializeScope (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/IScope;)Ljava/util/Map;
public static fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
}

public final class io/sentry/android/core/LoadClass : io/sentry/util/LoadClass {
Expand Down
17 changes: 17 additions & 0 deletions sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.sentry.android.core;

import static io.sentry.Sentry.getCurrentScopes;
import static io.sentry.SentryLevel.DEBUG;
import static io.sentry.SentryLevel.INFO;
import static io.sentry.SentryLevel.WARNING;
Expand Down Expand Up @@ -329,4 +330,20 @@ private static Session updateSession(
});
return sessionRef.get();
}

/**
* Allows a Hybrid SDK to set the trace on the native layer
*
* @param traceId the trace ID
* @param spanId the trace origin's span ID
* @param sampleRate the sample rate used by the origin of the trace
* @param sampleRand the random value used to sample with by the origin of the trace
*/
public static void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {
getCurrentScopes().setTrace(traceId, spanId, sampleRate, sampleRand);
}
}
21 changes: 21 additions & 0 deletions sentry-android-core/src/test/java/io/sentry/android/core/InternalSentrySdkTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,4 +505,25 @@ class InternalSentrySdkTest {
assertEquals(20.toLong(), actualProcessSpan["start_timestamp_ms"])
assertEquals(100.toLong(), actualProcessSpan["end_timestamp_ms"])
}

@Test
fun `setTrace sets correct propagation context`() {
val fixture = Fixture()
fixture.init(context)

val traceId = "771a43a4192642f0b136d5159a501700"
val spanId = "771a43a4192642f0"
val sampleRate = 0.5
val sampleRand = 0.3

InternalSentrySdk.setTrace(traceId, spanId, sampleRate, sampleRand)

Sentry.configureScope { scope ->
val propagationContext = scope.propagationContext
assertEquals(SentryId(traceId), propagationContext.traceId)
assertEquals(SpanId(spanId), propagationContext.parentSpanId)
assertEquals(sampleRate, propagationContext.baggage.sampleRateDouble)
assertEquals(sampleRand, propagationContext.baggage.sampleRandDouble)
}
}
}
1 change: 1 addition & 0 deletions sentry-android-ndk/api/sentry-android-ndk.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ public final class io/sentry/android/ndk/NdkScopeObserver : io/sentry/ScopeObser
public fun removeTag (Ljava/lang/String;)V
public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Lio/sentry/SpanContext;Lio/sentry/IScope;)V
public fun setUser (Lio/sentry/protocol/User;)V
}

Expand Down
20 changes: 20 additions & 0 deletions sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

import io.sentry.Breadcrumb;
import io.sentry.DateUtils;
import io.sentry.IScope;
import io.sentry.ScopeObserverAdapter;
import io.sentry.SentryLevel;
import io.sentry.SentryOptions;
import io.sentry.SpanContext;
import io.sentry.ndk.INativeScope;
import io.sentry.ndk.NativeScope;
import io.sentry.protocol.User;
Expand Down Expand Up @@ -125,4 +127,22 @@ public void removeExtra(final @NotNull String key) {
.log(SentryLevel.ERROR, e, "Scope sync removeExtra(%s) has an error.", key);
}
}

@Override
public void setTrace(@Nullable SpanContext spanContext, @NotNull IScope scope) {
if (spanContext == null) {
return;
}

try {
options
.getExecutorService()
.submit(
() ->
nativeScope.setTrace(
spanContext.getTraceId().toString(), spanContext.getSpanId().toString()));
} catch (Throwable e) {
options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setTrace failed.");
}
}
}
8 changes: 8 additions & 0 deletions sentry/api/sentry.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,7 @@ public final class io/sentry/HubAdapter : io/sentry/IHub {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down Expand Up @@ -689,6 +690,7 @@ public final class io/sentry/HubScopesWrapper : io/sentry/IHub {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down Expand Up @@ -916,6 +918,7 @@ public abstract interface class io/sentry/IScopes {
public abstract fun setLevel (Lio/sentry/SentryLevel;)V
public abstract fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public abstract fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public abstract fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public abstract fun setTransaction (Ljava/lang/String;)V
public abstract fun setUser (Lio/sentry/protocol/User;)V
public abstract fun startSession ()V
Expand Down Expand Up @@ -1438,6 +1441,7 @@ public final class io/sentry/NoOpHub : io/sentry/IHub {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down Expand Up @@ -1597,6 +1601,7 @@ public final class io/sentry/NoOpScopes : io/sentry/IScopes {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down Expand Up @@ -1952,6 +1957,7 @@ public final class io/sentry/PropagationContext {
public fun <init> ()V
public fun <init> (Lio/sentry/PropagationContext;)V
public fun <init> (Lio/sentry/protocol/SentryId;Lio/sentry/SpanId;Lio/sentry/SpanId;Lio/sentry/Baggage;Ljava/lang/Boolean;)V
public static fun fromExistingTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)Lio/sentry/PropagationContext;
public static fun fromHeaders (Lio/sentry/ILogger;Ljava/lang/String;Ljava/lang/String;)Lio/sentry/PropagationContext;
public static fun fromHeaders (Lio/sentry/ILogger;Ljava/lang/String;Ljava/util/List;)Lio/sentry/PropagationContext;
public static fun fromHeaders (Lio/sentry/SentryTraceHeader;Lio/sentry/Baggage;Lio/sentry/SpanId;)Lio/sentry/PropagationContext;
Expand Down Expand Up @@ -2197,6 +2203,7 @@ public final class io/sentry/Scopes : io/sentry/IScopes {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down Expand Up @@ -2261,6 +2268,7 @@ public final class io/sentry/ScopesAdapter : io/sentry/IScopes {
public fun setLevel (Lio/sentry/SentryLevel;)V
public fun setSpanContext (Ljava/lang/Throwable;Lio/sentry/ISpan;Ljava/lang/String;)V
public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
public fun setTrace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Double;Ljava/lang/Double;)V
public fun setTransaction (Ljava/lang/String;)V
public fun setUser (Lio/sentry/protocol/User;)V
public fun startSession ()V
Expand Down
9 changes: 9 additions & 0 deletions sentry/src/main/java/io/sentry/HubAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,15 @@ public void reportFullyDisplayed() {
return Sentry.continueTrace(sentryTrace, baggageHeaders);
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {
Sentry.getCurrentScopes().setTrace(traceId, spanId, sampleRate, sampleRand);
}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
return Sentry.getTraceparent();
Expand Down
9 changes: 9 additions & 0 deletions sentry/src/main/java/io/sentry/HubScopesWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,15 @@ public void reportFullyDisplayed() {
return scopes.continueTrace(sentryTrace, baggageHeaders);
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {
Sentry.getCurrentScopes().setTrace(traceId, spanId, sampleRate, sampleRand);
}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
return scopes.getTraceparent();
Expand Down
14 changes: 14 additions & 0 deletions sentry/src/main/java/io/sentry/IScopes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,20 @@ void setSpanContext(
TransactionContext continueTrace(
final @Nullable String sentryTrace, final @Nullable List<String> baggageHeaders);

/**
* Set a trace. This is primarily used by other SDKs in a Hybrid SDK context
*
* @param traceId the trace ID
* @param spanId the trace origin's span ID
* @param sampleRate the sample rate used by the origin of the trace
* @param sampleRand the random value used to sample with by the origin of the trace
*/
void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand);

/**
* Returns the "sentry-trace" header that allows tracing across services. Can also be used in
* &lt;meta&gt; HTML tags. Also see {@link IScopes#getBaggage()}.
Expand Down
7 changes: 7 additions & 0 deletions sentry/src/main/java/io/sentry/NoOpHub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,13 @@ public void reportFullyDisplayed() {}
return null;
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
return null;
Expand Down
7 changes: 7 additions & 0 deletions sentry/src/main/java/io/sentry/NoOpScopes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,13 @@ public void reportFullyDisplayed() {}
return null;
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
return null;
Expand Down
13 changes: 13 additions & 0 deletions sentry/src/main/java/io/sentry/PropagationContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@ public static PropagationContext fromHeaders(
sentryTraceHeader.isSampled());
}

public static @NotNull PropagationContext fromExistingTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double decisionSampleRate,
final @Nullable Double decisionSampleRand) {
Copy link
Member

@adinauer adinauer Feb 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

@bitsandfoxes bitsandfoxes Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@krystofwoldrich krystofwoldrich Mar 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@bruno-garcia bruno-garcia Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@krystofwoldrich krystofwoldrich Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

return new PropagationContext(
new SentryId(traceId),
new SpanId(),
new SpanId(spanId),
TracingUtils.ensureBaggage(null, null, decisionSampleRate, decisionSampleRand),
null);
}

private @NotNull SentryId traceId;
private @NotNull SpanId spanId;
private @Nullable SpanId parentSpanId;
Expand Down
15 changes: 15 additions & 0 deletions sentry/src/main/java/io/sentry/Scopes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,21 @@ public void reportFullyDisplayed() {
}
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {
@NotNull
PropagationContext propagationContext =
PropagationContext.fromExistingTrace(traceId, spanId, sampleRate, sampleRand);
configureScope(
(scope) -> {
scope.setPropagationContext(propagationContext);
});
}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
if (!isEnabled()) {
Expand Down
9 changes: 9 additions & 0 deletions sentry/src/main/java/io/sentry/ScopesAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,15 @@ public void reportFullyDisplayed() {
return Sentry.continueTrace(sentryTrace, baggageHeaders);
}

@Override
public void setTrace(
final @NotNull String traceId,
final @NotNull String spanId,
final @Nullable Double sampleRate,
final @Nullable Double sampleRand) {
Sentry.getCurrentScopes().setTrace(traceId, spanId, sampleRate, sampleRand);
}

@Override
public @Nullable SentryTraceHeader getTraceparent() {
return Sentry.getTraceparent();
Expand Down
Loading