add origin to span context (#2803)

* add origin to span context

* add traceorigin to webflux

* add trace origin to spans and transactions

* fix tests, start moving trace origin to constants

* use constants for trace origin string

* add changelog

* remove duplicate constant, dump api

* CR

* remove duplicate trace origin for okhttp integration

* remove spy.log, make api

* fix changelog

* cr, add origin to UIElement to differentiate between old android view system and jetpack compose

* Format code

* add optional appendix for trace origin to SentryNavigationListener

* fix line length

* add / adapt tests to verify trace origin

* fix changelog after merge

* Update CHANGELOG.md

---------

Co-authored-by: Sentry Github Bot <[email protected]>
Co-authored-by: Roman Zavarnitsyn <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add TraceOrigin to Transactions and Spans ([#2803](https://github.com/getsentry/sentry-java/pull/2803))
+
 ### Fixes
 
 - Deduplicate events happening in multiple threads simultaneously (e.g. `OutOfMemoryError`) ([#2845](https://github.com/getsentry/sentry-java/pull/2845))

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

@@ -55,6 +55,7 @@ public final class ActivityLifecycleIntegration
   static final String TTID_OP = "ui.load.initial_display";
   static final String TTFD_OP = "ui.load.full_display";
   static final long TTFD_TIMEOUT_MILLIS = 30000;
+  private static final String TRACE_ORIGIN = "auto.ui.activity";
 
   private final @NotNull Application application;
   private final @NotNull BuildInfoProvider buildInfoProvider;
@@ -231,6 +232,7 @@ private void startTracing(final @NotNull Activity activity) {
             hub.startTransaction(
                 new TransactionContext(activityName, TransactionNameSource.COMPONENT, UI_LOAD_OP),
                 transactionOptions);
+        setSpanOrigin(transaction);
 
         // in case appStartTime isn't available, we don't create a span for it.
         if (!(firstActivityCreated || appStartTime == null || coldStart == null)) {
@@ -241,6 +243,7 @@ private void startTracing(final @NotNull Activity activity) {
                   getAppStartDesc(coldStart),
                   appStartTime,
                   Instrumenter.SENTRY);
+          setSpanOrigin(appStartSpan);
 
           // in case there's already an end time (e.g. due to deferred SDK init)
           // we can finish the app-start span
@@ -250,11 +253,13 @@ private void startTracing(final @NotNull Activity activity) {
             transaction.startChild(
                 TTID_OP, getTtidDesc(activityName), ttidStartTime, Instrumenter.SENTRY);
         ttidSpanMap.put(activity, ttidSpan);
+        setSpanOrigin(ttidSpan);
 
         if (timeToFullDisplaySpanEnabled && fullyDisplayedReporter != null && options != null) {
           final @NotNull ISpan ttfdSpan =
               transaction.startChild(
                   TTFD_OP, getTtfdDesc(activityName), ttidStartTime, Instrumenter.SENTRY);
+          setSpanOrigin(ttfdSpan);
           try {
             ttfdSpanMap.put(activity, ttfdSpan);
             ttfdAutoCloseFuture =
@@ -283,6 +288,12 @@ private void startTracing(final @NotNull Activity activity) {
     }
   }
 
+  private void setSpanOrigin(ISpan span) {
+    if (span != null) {
+      span.getSpanContext().setOrigin(TRACE_ORIGIN);
+    }
+  }
+
   @VisibleForTesting
   void applyScope(final @NotNull Scope scope, final @NotNull ITransaction transaction) {
     scope.withTransaction(

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

@@ -14,6 +14,8 @@
 @ApiStatus.Internal
 public final class AndroidViewGestureTargetLocator implements GestureTargetLocator {
 
+  private static final String ORIGIN = "old_view_system";
+
   private final boolean isAndroidXAvailable;
   private final int[] coordinates = new int[2];
 
@@ -46,7 +48,7 @@ private UiElement createUiElement(final @NotNull View targetView) {
       if (className == null) {
         className = targetView.getClass().getSimpleName();
       }
-      return new UiElement(targetView, className, resourceName, null);
+      return new UiElement(targetView, className, resourceName, null, ORIGIN);
     } catch (Resources.NotFoundException ignored) {
       return null;
     }

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

@@ -33,6 +33,7 @@
 public final class SentryGestureListener implements GestureDetector.OnGestureListener {
 
   static final String UI_ACTION = "ui.action";
+  private static final String TRACE_ORIGIN = "auto.ui.gesture_listener";
 
   private final @NotNull WeakReference<Activity> activityRef;
   private final @NotNull IHub hub;
@@ -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 + "." + target.getOrigin());
+
     hub.configureScope(
         scope -> {
           applyScope(scope, transaction);

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/SentryGestureListenerTracingTest.kt

@@ -13,10 +13,13 @@ import io.sentry.IHub
 import io.sentry.Scope
 import io.sentry.ScopeCallback
 import io.sentry.SentryTracer
+import io.sentry.SpanContext
+import io.sentry.SpanId
 import io.sentry.SpanStatus
 import io.sentry.TransactionContext
 import io.sentry.TransactionOptions
 import io.sentry.android.core.SentryAndroidOptions
+import io.sentry.protocol.SentryId
 import io.sentry.protocol.TransactionNameSource
 import org.mockito.kotlin.any
 import org.mockito.kotlin.check
@@ -307,6 +310,10 @@ class SentryGestureListenerTracingTest {
         val transaction = mock<SentryTracer>()
         val sut = fixture.getSut<View>(transaction = transaction)
 
+        whenever(transaction.spanContext).thenReturn(
+            SpanContext(SentryId.EMPTY_ID, SpanId.EMPTY_ID, "op", null, null)
+        )
+
         sut.onSingleTapUp(fixture.event)
 
         verify(fixture.hub).startTransaction(
@@ -323,6 +330,15 @@ class SentryGestureListenerTracingTest {
         verify(fixture.transaction).scheduleFinish()
     }
 
+    @Test
+    fun `captures transaction and sets trace origin`() {
+        val sut = fixture.getSut<View>()
+
+        sut.onSingleTapUp(fixture.event)
+
+        assertEquals("auto.ui.gesture_listener.old_view_system", fixture.transaction.spanContext.origin)
+    }
+
     internal open class ScrollableListView : AbsListView(mock()) {
         override fun getAdapter(): ListAdapter = mock()
         override fun setSelection(position: Int) = Unit

sentry-android-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"
+
 @Suppress("TooManyFunctions")
 class SentryFragmentLifecycleCallbacks(
     private val hub: IHub = HubAdapter.getInstance(),
@@ -164,6 +166,7 @@ class SentryFragmentLifecycleCallbacks(
 
         span?.let {
             fragmentsWithOngoingTransactions[fragment] = it
+            it.spanContext.origin = TRACE_ORIGIN
         }
     }
 

sentry-android-fragment/src/test/java/io/sentry/android/fragment/SentryFragmentLifecycleCallbacksTest.kt

@@ -12,7 +12,10 @@ import io.sentry.Scope
 import io.sentry.ScopeCallback
 import io.sentry.SentryLevel.INFO
 import io.sentry.SentryOptions
+import io.sentry.SpanContext
+import io.sentry.SpanId
 import io.sentry.SpanStatus
+import io.sentry.protocol.SentryId
 import org.mockito.kotlin.any
 import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.check
@@ -47,6 +50,9 @@ class SentryFragmentLifecycleCallbacksTest {
                     setTracesSampleRate(tracesSampleRate)
                 }
             )
+            whenever(span.spanContext).thenReturn(
+                SpanContext(SentryId.EMPTY_ID, SpanId.EMPTY_ID, "op", null, null)
+            )
             whenever(transaction.startChild(any(), any())).thenReturn(span)
             whenever(scope.transaction).thenReturn(transaction)
             whenever(hub.configureScope(any())).thenAnswer {

sentry-android-navigation/api/sentry-android-navigation.api

@@ -13,7 +13,8 @@ public final class io/sentry/android/navigation/SentryNavigationListener : andro
 	public fun <init> (Lio/sentry/IHub;)V
 	public fun <init> (Lio/sentry/IHub;Z)V
 	public fun <init> (Lio/sentry/IHub;ZZ)V
-	public synthetic fun <init> (Lio/sentry/IHub;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/sentry/IHub;ZZLjava/lang/String;)V
+	public synthetic fun <init> (Lio/sentry/IHub;ZZLjava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun onDestinationChanged (Landroidx/navigation/NavController;Landroidx/navigation/NavDestination;Landroid/os/Bundle;)V
 }
 

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

@@ -22,6 +22,8 @@ import io.sentry.protocol.TransactionNameSource
 import io.sentry.util.TracingUtils
 import java.lang.ref.WeakReference
 
+private const val TRACE_ORIGIN = "auto.navigation"
+
 /**
  * A [NavController.OnDestinationChangedListener] that captures a [Breadcrumb] and starts an
  * [ITransaction] and sends them to Sentry for each [onDestinationChanged] call.
@@ -34,7 +36,8 @@ import java.lang.ref.WeakReference
 class SentryNavigationListener @JvmOverloads constructor(
     private val hub: IHub = HubAdapter.getInstance(),
     private val enableNavigationBreadcrumbs: Boolean = true,
-    private val enableNavigationTracing: Boolean = true
+    private val enableNavigationTracing: Boolean = true,
+    private val traceOriginAppendix: String? = null
 ) : NavController.OnDestinationChangedListener, IntegrationName {
 
     private var previousDestinationRef: WeakReference<NavDestination>? = null
@@ -140,6 +143,10 @@ class SentryNavigationListener @JvmOverloads constructor(
             transactonOptions
         )
 
+        transaction.spanContext.origin = traceOriginAppendix?.let {
+            "$TRACE_ORIGIN.$traceOriginAppendix"
+        } ?: TRACE_ORIGIN
+
         if (arguments.isNotEmpty()) {
             transaction.setData("arguments", arguments)
         }

sentry-android-navigation/src/test/java/io/sentry/android/navigation/SentryNavigationListenerTest.kt

@@ -57,7 +57,8 @@ class SentryNavigationListenerTest {
             enableTracing: Boolean = true,
             tracesSampleRate: Double? = 1.0,
             hasViewIdInRes: Boolean = true,
-            transaction: SentryTracer? = null
+            transaction: SentryTracer? = null,
+            traceOriginAppendix: String? = null
         ): SentryNavigationListener {
             options = SentryOptions().apply {
                 dsn = "http://key@localhost/proj"
@@ -93,7 +94,7 @@ class SentryNavigationListenerTest {
             whenever(context.resources).thenReturn(resources)
             whenever(navController.context).thenReturn(context)
             whenever(destination.route).thenReturn(toRoute)
-            return SentryNavigationListener(hub, enableBreadcrumbs, enableTracing)
+            return SentryNavigationListener(hub, enableBreadcrumbs, enableTracing, traceOriginAppendix)
         }
     }
 
@@ -366,4 +367,22 @@ class SentryNavigationListenerTest {
         verify(fixture.hub).configureScope(any())
         assertNotSame(propagationContextAtStart, scope.propagationContext)
     }
+
+    @Test
+    fun `onDestinationChanged sets trace origin`() {
+        val sut = fixture.getSut()
+
+        sut.onDestinationChanged(fixture.navController, fixture.destination, null)
+
+        assertEquals("auto.navigation", fixture.transaction.spanContext.origin)
+    }
+
+    @Test
+    fun `onDestinationChanged sets trace origin with appendix`() {
+        val sut = fixture.getSut(traceOriginAppendix = "jetpack_compose")
+
+        sut.onDestinationChanged(fixture.navController, fixture.destination, null)
+
+        assertEquals("auto.navigation.jetpack_compose", fixture.transaction.spanContext.origin)
+    }
 }