add origin to span context #2803

lbloder · 2023-06-28T20:46:32Z

📜 Description

Add trace origin to SpanContext and set it when automatically creating transactions or spans.

💡 Motivation and Context

Fixes #2692

💚 How did you test it?

📝 Checklist

I reviewed the submitted code.
I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

github-actions · 2023-06-28T20:47:48Z

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

Generated by 🚫 dangerJS against 10c88ea

github-actions · 2023-06-28T21:04:31Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	309.98 ms	367.33 ms	57.35 ms
Size	1.72 MiB	2.29 MiB	575.54 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`adf8fe3`	300.49 ms	357.36 ms	56.87 ms
`f60279b`	324.60 ms	345.33 ms	20.73 ms
`dc67004`	273.86 ms	346.37 ms	72.51 ms
`d0c08e7`	310.28 ms	350.68 ms	40.40 ms
`c03a05e`	390.40 ms	419.35 ms	28.94 ms
`f274c79`	313.96 ms	355.96 ms	42.00 ms
`f274c79`	334.86 ms	348.54 ms	13.68 ms
`caf50ec`	302.36 ms	325.25 ms	22.89 ms
`9246ed4`	281.79 ms	352.08 ms	70.29 ms
`0310da5`	381.20 ms	404.50 ms	23.30 ms

App size

Revision	Plain	With Sentry	Diff
`adf8fe3`	1.72 MiB	2.29 MiB	575.24 KiB
`f60279b`	1.72 MiB	2.29 MiB	575.23 KiB
`dc67004`	1.72 MiB	2.28 MiB	573.45 KiB
`d0c08e7`	1.72 MiB	2.29 MiB	574.68 KiB
`c03a05e`	1.72 MiB	2.29 MiB	574.43 KiB
`f274c79`	1.72 MiB	2.29 MiB	575.01 KiB
`f274c79`	1.72 MiB	2.29 MiB	575.01 KiB
`caf50ec`	1.72 MiB	2.29 MiB	575.24 KiB
`9246ed4`	1.72 MiB	2.28 MiB	572.22 KiB
`0310da5`	1.72 MiB	2.28 MiB	573.45 KiB

Previous results on branch: feat/send_trace_origin

Startup times

Revision	Plain	With Sentry	Diff
`d2942c5`	286.82 ms	336.78 ms	49.96 ms
`a0437fa`	319.00 ms	366.47 ms	47.47 ms
`05c4514`	291.88 ms	358.38 ms	66.50 ms
`af877ce`	315.78 ms	330.94 ms	15.16 ms
`f7d1f90`	332.02 ms	377.20 ms	45.18 ms
`a67a90a`	314.43 ms	376.82 ms	62.39 ms
`a8f1f47`	261.73 ms	314.85 ms	53.12 ms
`38987c2`	319.73 ms	437.14 ms	117.41 ms
`991f624`	328.58 ms	383.94 ms	55.36 ms
`aba9d3a`	273.60 ms	331.62 ms	58.01 ms

App size

Revision	Plain	With Sentry	Diff
`d2942c5`	1.72 MiB	2.29 MiB	575.43 KiB
`a0437fa`	1.72 MiB	2.29 MiB	575.43 KiB
`05c4514`	1.72 MiB	2.29 MiB	575.18 KiB
`af877ce`	1.72 MiB	2.29 MiB	575.43 KiB
`f7d1f90`	1.72 MiB	2.29 MiB	575.43 KiB
`a67a90a`	1.72 MiB	2.29 MiB	575.43 KiB
`a8f1f47`	1.72 MiB	2.29 MiB	575.43 KiB
`38987c2`	1.72 MiB	2.28 MiB	573.75 KiB
`991f624`	1.72 MiB	2.29 MiB	575.43 KiB
`aba9d3a`	1.72 MiB	2.29 MiB	575.13 KiB

codecov · 2023-06-29T12:51:12Z

Codecov Report

Patch coverage: 81.81% and no project coverage change.

Comparison is base (f60279b) 81.37% compared to head (10c88ea) 81.37%.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #2803   +/-   ##
=========================================
  Coverage     81.37%   81.37%           
- Complexity     4633     4639    +6     
=========================================
  Files           354      354           
  Lines         17064    17112   +48     
  Branches       2307     2312    +5     
=========================================
+ Hits          13885    13925   +40     
- Misses         2229     2237    +8     
  Partials        950      950

Impacted Files	Coverage Δ
...racing/SentrySpanClientHttpRequestInterceptor.java	`0.00% <0.00%> (ø)`
...ebflux/SentryWebFilterWithThreadLocalAccessor.java	`0.00% <0.00%> (ø)`
...racing/SentrySpanClientHttpRequestInterceptor.java	`0.00% <0.00%> (ø)`
...in/java/io/sentry/internal/gestures/UiElement.java	`0.00% <0.00%> (ø)`
...y/src/main/java/io/sentry/protocol/SentrySpan.java	`84.13% <87.50%> (+0.19%)`	⬆️
.../io/sentry/apollo3/SentryApollo3HttpInterceptor.kt	`84.27% <100.00%> (+0.06%)`	⬆️
...n/java/io/sentry/apollo/SentryApolloInterceptor.kt	`82.82% <100.00%> (+0.17%)`	⬆️
.../java/io/sentry/graphql/SentryInstrumentation.java	`74.24% <100.00%> (+1.22%)`	⬆️
...n/java/io/sentry/jdbc/SentryJdbcEventListener.java	`88.46% <100.00%> (+0.46%)`	⬆️
...in/java/io/sentry/openfeign/SentryFeignClient.java	`96.10% <100.00%> (+0.05%)`	⬆️
... and 13 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

adinauer · 2023-07-05T12:40:07Z

sentry-jdbc/src/main/java/io/sentry/jdbc/SentryJdbcEventListener.java

@@ -17,6 +17,7 @@
 /** P6Spy JDBC event listener that creates {@link Span}s around database queries. */
 @Open
 public class SentryJdbcEventListener extends SimpleJdbcEventListener {
+  public static final String TRACE_ORIGIN = "auto.db.jdbc";


Suggested change

public static final String TRACE_ORIGIN = "auto.db.jdbc";

private static final String TRACE_ORIGIN = "auto.db.jdbc";

adinauer · 2023-07-05T12:45:11Z

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanAdvice.java

@@ -20,6 +20,7 @@
 */
 @Open
 public class SentrySpanAdvice implements MethodInterceptor {
+  private static final String TRACE_ORIGIN = "auto.spring_jakarta";


Suggested change

private static final String TRACE_ORIGIN = "auto.spring_jakarta";

private static final String TRACE_ORIGIN = "auto.function.spring_jakarta.advice";

adinauer · 2023-07-05T12:46:27Z

...a/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientHttpRequestInterceptor.java

@@ -26,6 +26,7 @@

 @Open
 public class SentrySpanClientHttpRequestInterceptor implements ClientHttpRequestInterceptor {
+  public static final String TRACE_ORIGIN = "auto.spring_jakarta";


Suggested change

public static final String TRACE_ORIGIN = "auto.spring_jakarta";

private static final String TRACE_ORIGIN = "auto.http.spring_jakarta.resttemplate";

adinauer · 2023-07-05T12:48:03Z

...jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientWebRequestFilter.java

@@ -24,6 +24,7 @@

 @Open
 public class SentrySpanClientWebRequestFilter implements ExchangeFilterFunction {
+  public static final String TRACE_ORIGIN = "auto.spring_jakarta";


Suggested change

public static final String TRACE_ORIGIN = "auto.spring_jakarta";

private static final String TRACE_ORIGIN = "auto.http.spring_jakarta.webclient";

adinauer · 2023-07-05T12:48:40Z

...y-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentryTransactionAdvice.java

@@ -25,6 +25,7 @@
 @ApiStatus.Internal
 @Open
 public class SentryTransactionAdvice implements MethodInterceptor {
+  public static final String TRACE_ORIGIN = "auto.spring_jakarta";


Suggested change

public static final String TRACE_ORIGIN = "auto.spring_jakarta";

private static final String TRACE_ORIGIN = "auto.function.spring_jakarta.advice";

adinauer · 2023-07-05T13:46:01Z

sentry-apollo-3/src/main/java/io/sentry/apollo3/SentryApollo3HttpInterceptor.kt

@@ -34,6 +34,8 @@ import io.sentry.vendor.Base64
 import okio.Buffer
 import org.jetbrains.annotations.ApiStatus

+private const val TRACE_ORIGIN = "auto.apollo3"


Suggested change

private const val TRACE_ORIGIN = "auto.apollo3"

private const val TRACE_ORIGIN = "auto.graphql.apollo3"

adinauer · 2023-07-05T13:46:13Z

sentry-android-okhttp/src/main/java/io/sentry/android/okhttp/SentryOkHttpInterceptor.kt

@@ -27,6 +27,8 @@ import okhttp3.Request
 import okhttp3.Response
 import java.io.IOException

+private const val TRACE_ORIGIN = "auto.okhttp"


Suggested change

private const val TRACE_ORIGIN = "auto.okhttp"

private const val TRACE_ORIGIN = "auto.http.okhttp"

adinauer · 2023-07-05T13:46:26Z

sentry-android-okhttp/src/main/java/io/sentry/android/okhttp/SentryOkHttpEvent.kt

@@ -21,6 +21,7 @@ import java.util.concurrent.ConcurrentHashMap

 private const val PROTOCOL_KEY = "protocol"
 private const val ERROR_MESSAGE_KEY = "error_message"
+private const val TRACE_ORIGIN = "auto.okhttp"


Suggested change

private const val TRACE_ORIGIN = "auto.okhttp"

private const val TRACE_ORIGIN = "auto.http.okhttp"

...droid-core/src/main/java/io/sentry/android/core/internal/gestures/SentryGestureListener.java

adinauer · 2023-07-05T13:50:39Z

spy.log

@@ -0,0 +1,23 @@
+1685029529524|0|statement|connection 0|url jdbc:p6spy:hsqldb:mem:testdb|CREATE TABLE person ( id INTEGER IDENTITY PRIMARY KEY, firstName VARCHAR(50) NOT NULL, lastName VARCHAR(50) NOT NULL )|CREATE TABLE person ( id INTEGER IDENTITY PRIMARY KEY, firstName VARCHAR(50) NOT NULL, lastName VARCHAR(50) NOT NULL )


remove and gitignore

adinauer · 2023-07-05T13:53:39Z

@stefanosiano @romtsn @markushi can one of you please give the Android parts here a review. Not sure if you'd like more details. Also bytecode manipulation by SAGP may have to be changed as well to include origin.

# Conflicts: # CHANGELOG.md # sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java # sentry-apollo-3/src/main/java/io/sentry/apollo3/SentryApollo3HttpInterceptor.kt # sentry-apollo/src/main/java/io/sentry/apollo/SentryApolloInterceptor.kt # sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentryTracingFilter.java # sentry-spring/src/main/java/io/sentry/spring/tracing/SentryTracingFilter.java # sentry-spring/src/main/java/io/sentry/spring/webflux/SentryWebFilter.java

romtsn · 2023-07-10T08:44:04Z

...ndroid-fragment/src/main/java/io/sentry/android/fragment/SentryFragmentLifecycleCallbacks.kt

@@ -16,6 +16,8 @@ import io.sentry.SpanStatus
 import io.sentry.TypeCheckHint.ANDROID_FRAGMENT
 import java.util.WeakHashMap

+private const val TRACE_ORIGIN = "auto.ui.fragment.lifecycle"


Suggested change

private const val TRACE_ORIGIN = "auto.ui.fragment.lifecycle"

private const val TRACE_ORIGIN = "auto.ui.fragment"

just to align with .activity

romtsn · 2023-07-10T09:37:35Z

sentry/src/main/java/io/sentry/SpanContext.java

+    return origin;
+  }
+
+  public void setOrigin(@Nullable String origin) {


Suggested change

public void setOrigin(@Nullable String origin) {

public void setOrigin(final @Nullable String origin) {

romtsn · 2023-07-10T10:32:46Z

...droid-core/src/main/java/io/sentry/android/core/internal/gestures/SentryGestureListener.java

@@ -243,6 +244,8 @@ private void startTracing(final @NotNull UiElement target, final @NotNull String
        hub.startTransaction(
            new TransactionContext(name, TransactionNameSource.COMPONENT, op), transactionOptions);

+    transaction.getSpanContext().setOrigin(TRACE_ORIGIN + "." + eventType);


h: I think what I'd like to see instead of auto.ui.gesture_listener.click is rather auto.ui.gesture_listener.old_view_system and auto.ui.gesture_listener.jetpack_compose, to understand where this span is coming from. I think to achieve that you could add a new property origin to UiElement and then set it respectively for Views/JPC and use here.

romtsn · 2023-07-10T10:35:41Z

...ry-android-navigation/src/main/java/io/sentry/android/navigation/SentryNavigationListener.kt

@@ -140,6 +142,8 @@ class SentryNavigationListener @JvmOverloads constructor(
            transactonOptions
        )

+        transaction.spanContext.origin = TRACE_ORIGIN


h: we'd also want to track if it was auto.navigation.jetpack_compose. For that I guess we could just add a new optional ctor parameter and then set it from SentryLifecycleObserver and concat here afterwards

romtsn

the android parts look good to me apart from the comments I left

# Conflicts: # CHANGELOG.md

… system and jetpack compose

lbloder · 2023-07-13T11:56:09Z

Hey @romtsn and @adinauer,
I implemented your suggestions and added some tests. Would you mind taking another quick look?

# Conflicts: # CHANGELOG.md

adinauer

LGTM

CHANGELOG.md

romtsn · 2023-07-17T07:39:57Z

LGTM too 👍

# Conflicts: # CHANGELOG.md

lbloder added 8 commits June 8, 2023 14:25

add origin to span context

c407efa

add traceorigin to webflux

69b989f

Merge branch 'main' into feat/send_trace_origin

3ad1efd

Merge branch 'main' into feat/send_trace_origin

af9f0bc

add trace origin to spans and transactions

cd7a199

fix tests, start moving trace origin to constants

fc91d95

use constants for trace origin string

4f03d5b

Merge branch 'main' into feat/send_trace_origin

a966270

lbloder added 2 commits June 29, 2023 09:06

add changelog

8cff016

remove duplicate constant, dump api

c031d29

adinauer reviewed Jul 5, 2023

View reviewed changes

lbloder added 3 commits July 5, 2023 15:56

CR

6d87934

remove duplicate trace origin for okhttp integration

85fbf40

romtsn reviewed Jul 10, 2023

View reviewed changes

romtsn approved these changes Jul 10, 2023

View reviewed changes

lbloder and others added 7 commits July 10, 2023 22:05

remove spy.log, make api

34f5f88

Merge branch 'main' into feat/send_trace_origin

4ce2716

# Conflicts: # CHANGELOG.md

Merge branch 'main' into feat/send_trace_origin

41c00d9

fix changelog

2f11261

cr, add origin to UIElement to differentiate between old android view…

4818b1c

… system and jetpack compose

Format code

383ccb5

add optional appendix for trace origin to SentryNavigationListener

d784f75

lbloder added 2 commits July 12, 2023 17:29

fix line length

04e1418

add / adapt tests to verify trace origin

ca897b8

lbloder marked this pull request as ready for review July 13, 2023 13:52

lbloder requested review from stefanosiano and markushi as code owners July 13, 2023 13:52

lbloder added 3 commits July 13, 2023 23:01

Merge branch 'main' into feat/send_trace_origin

2168305

# Conflicts: # CHANGELOG.md

Merge branch 'main' into feat/send_trace_origin

6b9c4b0

fix changelog after merge

b622d7c

adinauer approved these changes Jul 17, 2023

View reviewed changes

romtsn reviewed Jul 17, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

romtsn and others added 2 commits July 17, 2023 09:40

Update CHANGELOG.md

4bc3889

Merge branch 'main' into feat/send_trace_origin

10c88ea

# Conflicts: # CHANGELOG.md

lbloder merged commit 695d3a3 into main Jul 21, 2023
21 checks passed

lbloder deleted the feat/send_trace_origin branch July 21, 2023 06:22

adinauer mentioned this pull request Jan 22, 2024

Do not set TraceContext.origin for exceptions when no active transaction available #3143

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add origin to span context #2803

add origin to span context #2803

lbloder commented Jun 28, 2023 •

edited

github-actions bot commented Jun 28, 2023 •

edited

github-actions bot commented Jun 28, 2023 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/send_trace_origin

Startup times

App size

codecov bot commented Jun 29, 2023 •

edited

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer Jul 5, 2023

adinauer commented Jul 5, 2023

romtsn Jul 10, 2023

romtsn Jul 10, 2023

romtsn Jul 10, 2023

romtsn Jul 10, 2023

romtsn left a comment

lbloder commented Jul 13, 2023

adinauer left a comment

romtsn commented Jul 17, 2023

	public static final String TRACE_ORIGIN = "auto.db.jdbc";
	private static final String TRACE_ORIGIN = "auto.db.jdbc";

	private const val TRACE_ORIGIN = "auto.apollo3"
	private const val TRACE_ORIGIN = "auto.graphql.apollo3"

	private const val TRACE_ORIGIN = "auto.okhttp"
	private const val TRACE_ORIGIN = "auto.http.okhttp"

		@@ -0,0 +1,23 @@
		1685029529524\|0\|statement\|connection 0\|url jdbc:p6spy:hsqldb:mem:testdb\|CREATE TABLE person ( id INTEGER IDENTITY PRIMARY KEY, firstName VARCHAR(50) NOT NULL, lastName VARCHAR(50) NOT NULL )\|CREATE TABLE person ( id INTEGER IDENTITY PRIMARY KEY, firstName VARCHAR(50) NOT NULL, lastName VARCHAR(50) NOT NULL )

	private const val TRACE_ORIGIN = "auto.ui.fragment.lifecycle"
	private const val TRACE_ORIGIN = "auto.ui.fragment"

	public void setOrigin(@Nullable String origin) {
	public void setOrigin(final @Nullable String origin) {

add origin to span context #2803

add origin to span context #2803

Conversation

lbloder commented Jun 28, 2023 • edited

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Jun 28, 2023 • edited

github-actions bot commented Jun 28, 2023 • edited

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/send_trace_origin

Startup times

App size

codecov bot commented Jun 29, 2023 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adinauer commented Jul 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

romtsn left a comment

Choose a reason for hiding this comment

lbloder commented Jul 13, 2023

adinauer left a comment

Choose a reason for hiding this comment

romtsn commented Jul 17, 2023

lbloder commented Jun 28, 2023 •

edited

github-actions bot commented Jun 28, 2023 •

edited

github-actions bot commented Jun 28, 2023 •

edited

codecov bot commented Jun 29, 2023 •

edited