Ending "Paused" span for a fragment. (#591)

* ended active span on onFragmentPaused * started span Stopped in non in progress * run ./gradlew spotlessApply * fix tests to match expected output * spotless --------- Co-authored-by: Jason Plumb <jplumb@splunk.com>
open-telemetry · Sep 25, 2024 · f93a722 · f93a722
1 parent 8d9b9f9
commit f93a722
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 10 deletions.
diff --git a/...java/io/opentelemetry/android/instrumentation/fragment/RumFragmentLifecycleCallbacks.java b/...java/io/opentelemetry/android/instrumentation/fragment/RumFragmentLifecycleCallbacks.java
@@ -92,13 +92,16 @@ public void onFragmentResumed(@NonNull FragmentManager fm, @NonNull Fragment f)
     @Override
     public void onFragmentPaused(@NonNull FragmentManager fm, @NonNull Fragment f) {
         super.onFragmentPaused(fm, f);
-        getTracer(f).startSpanIfNoneInProgress("Paused").addEvent("fragmentPaused");
+        getTracer(f).startSpanIfNoneInProgress("Paused").addEvent("fragmentPaused").endActiveSpan();
     }
 
     @Override
     public void onFragmentStopped(@NonNull FragmentManager fm, @NonNull Fragment f) {
         super.onFragmentStopped(fm, f);
-        getTracer(f).addEvent("fragmentStopped").endActiveSpan();
+        getTracer(f)
+                .startSpanIfNoneInProgress("Stopped")
+                .addEvent("fragmentStopped")
+                .endActiveSpan();
     }
 
     @Override

diff --git a/.../io/opentelemetry/android/instrumentation/fragment/RumFragmentLifecycleCallbacksTest.java b/.../io/opentelemetry/android/instrumentation/fragment/RumFragmentLifecycleCallbacksTest.java
@@ -134,10 +134,12 @@ void fragmentPaused() {
         FragmentCallbackTestHarness testHarness = getFragmentCallbackTestHarness();
 
         Fragment fragment = mock(Fragment.class);
+        // calls onFragmentPaused() and onFragmentStopped()
         testHarness.runFragmentPausedLifecycle(fragment);
 
         List<SpanData> spans = otelTesting.getSpans();
-        assertEquals(1, spans.size());
+        // one paused, one stopped
+        assertEquals(2, spans.size());
 
         SpanData spanData = spans.get(0);
 
@@ -150,9 +152,22 @@ void fragmentPaused() {
         assertNull(spanData.getAttributes().get(LAST_SCREEN_NAME_KEY));
 
         List<EventData> events = spanData.getEvents();
-        assertEquals(2, events.size());
+        assertEquals(1, events.size());
         checkEventExists(events, "fragmentPaused");
-        checkEventExists(events, "fragmentStopped");
+
+        SpanData stopSpan = spans.get(1);
+
+        assertEquals("Stopped", stopSpan.getName());
+        assertEquals(
+                fragment.getClass().getSimpleName(),
+                stopSpan.getAttributes().get(FragmentTracer.FRAGMENT_NAME_KEY));
+        assertEquals(
+                fragment.getClass().getSimpleName(), stopSpan.getAttributes().get(SCREEN_NAME_KEY));
+        assertNull(stopSpan.getAttributes().get(LAST_SCREEN_NAME_KEY));
+
+        List<EventData> stopEvents = stopSpan.getEvents();
+        assertEquals(1, stopEvents.size());
+        checkEventExists(stopEvents, "fragmentStopped");
     }
 
     @Test
@@ -163,9 +178,11 @@ void fragmentDetachedFromActive() {
         testHarness.runFragmentDetachedFromActiveLifecycle(fragment);
 
         List<SpanData> spans = otelTesting.getSpans();
-        assertEquals(3, spans.size());
+
+        assertEquals(4, spans.size());
 
         SpanData pauseSpan = spans.get(0);
+        SpanData stopSpan = spans.get(1);
 
         assertEquals("Paused", pauseSpan.getName());
         assertEquals(
@@ -177,11 +194,22 @@ void fragmentDetachedFromActive() {
         assertNull(pauseSpan.getAttributes().get(LAST_SCREEN_NAME_KEY));
 
         List<EventData> events = pauseSpan.getEvents();
-        assertEquals(2, events.size());
+        assertEquals(1, events.size());
         checkEventExists(events, "fragmentPaused");
-        checkEventExists(events, "fragmentStopped");
 
-        SpanData destroyViewSpan = spans.get(1);
+        assertEquals("Stopped", stopSpan.getName());
+        assertEquals(
+                fragment.getClass().getSimpleName(),
+                stopSpan.getAttributes().get(FragmentTracer.FRAGMENT_NAME_KEY));
+        assertEquals(
+                fragment.getClass().getSimpleName(), stopSpan.getAttributes().get(SCREEN_NAME_KEY));
+        assertNull(stopSpan.getAttributes().get(LAST_SCREEN_NAME_KEY));
+
+        List<EventData> stopEvents = stopSpan.getEvents();
+        assertEquals(1, stopEvents.size());
+        checkEventExists(stopEvents, "fragmentStopped");
+
+        SpanData destroyViewSpan = spans.get(2);
 
         assertEquals("ViewDestroyed", destroyViewSpan.getName());
         assertEquals(
@@ -196,7 +224,7 @@ void fragmentDetachedFromActive() {
         assertEquals(1, events.size());
         checkEventExists(events, "fragmentViewDestroyed");
 
-        SpanData detachSpan = spans.get(2);
+        SpanData detachSpan = spans.get(3);
 
         assertEquals("Destroyed", detachSpan.getName());
         assertNotNull(detachSpan.getAttributes().get(FragmentTracer.FRAGMENT_NAME_KEY));