Continuous Profiling - stop when app goes in background (#4311)

* Replaced synchronized blocks with AutoClosableReentrantLock in AndroidContinuousProfiler
* Added "delayed" stop of profiler, which stops the profiler after the current chunk is finished
* Added default span data (profiler id, thread name and thread id) to transaction root span
* App going in the background now stops the continuous profiler
* Added isTerminating param to AndroidContinuousProfiler.close()

Author: stefanosiano

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Continuous Profiling - stop when app goes in background ([#4311](https://github.com/getsentry/sentry-java/pull/4311))
 - Continuous Profiling - Add delayed stop ([#4293](https://github.com/getsentry/sentry-java/pull/4293))
 - Continuous Profiling - Out of Experimental ([#4310](https://github.com/getsentry/sentry-java/pull/4310))
 

sentry-android-core/api/sentry-android-core.api

@@ -42,7 +42,7 @@ public final class io/sentry/android/core/ActivityLifecycleIntegration : android
 
 public class io/sentry/android/core/AndroidContinuousProfiler : io/sentry/IContinuousProfiler, io/sentry/transport/RateLimiter$IRateLimitObserver {
 	public fun <init> (Lio/sentry/android/core/BuildInfoProvider;Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;Lio/sentry/ILogger;Ljava/lang/String;ILio/sentry/ISentryExecutorService;)V
-	public fun close ()V
+	public fun close (Z)V
 	public fun getProfilerId ()Lio/sentry/protocol/SentryId;
 	public fun getRootSpanCounter ()I
 	public fun isRunning ()Z

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

@@ -322,12 +322,15 @@ public void reevaluateSampling() {
     shouldSample = true;
   }
 
-  public void close() {
+  @Override
+  public void close(final boolean isTerminating) {
     try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
       rootSpanCounter = 0;
       shouldStop = true;
-      stop(false);
-      isClosed.set(true);
+      if (isTerminating) {
+        stop(false);
+        isClosed.set(true);
+      }
     }
   }
 

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

@@ -268,7 +268,7 @@ private static void setupProfiler(
       // This is a safeguard, but it should never happen, as the app start profiler should be the
       // continuous one.
       if (appStartContinuousProfiler != null) {
-        appStartContinuousProfiler.close();
+        appStartContinuousProfiler.close(true);
       }
       if (appStartTransactionProfiler != null) {
         options.setTransactionProfiler(appStartTransactionProfiler);

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

@@ -122,6 +122,7 @@ public void run() {
                   scopes.endSession();
                 }
                 scopes.getOptions().getReplayController().stop();
+                scopes.getOptions().getContinuousProfiler().close(false);
               }
             };
 

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

@@ -95,7 +95,7 @@ public void shutdown() {
       final @Nullable IContinuousProfiler appStartContinuousProfiler =
           AppStartMetrics.getInstance().getAppStartContinuousProfiler();
       if (appStartContinuousProfiler != null) {
-        appStartContinuousProfiler.close();
+        appStartContinuousProfiler.close(true);
       }
     }
   }

sentry-android-core/src/main/java/io/sentry/android/core/performance/AppStartMetrics.java

@@ -225,7 +225,7 @@ public void clear() {
     }
     appStartProfiler = null;
     if (appStartContinuousProfiler != null) {
-      appStartContinuousProfiler.close();
+      appStartContinuousProfiler.close(true);
     }
     appStartContinuousProfiler = null;
     appStartSamplingDecision = null;
@@ -333,7 +333,7 @@ private void checkCreateTimeOnMain() {
                   appStartProfiler = null;
                 }
                 if (appStartContinuousProfiler != null && appStartContinuousProfiler.isRunning()) {
-                  appStartContinuousProfiler.close();
+                  appStartContinuousProfiler.close(true);
                   appStartContinuousProfiler = null;
                 }
               }

sentry-android-core/src/test/java/io/sentry/android/core/AndroidContinuousProfilerTest.kt

@@ -389,7 +389,7 @@ class AndroidContinuousProfilerTest {
         profiler.startProfiler(ProfileLifecycle.MANUAL, fixture.mockTracesSampler)
         assertTrue(profiler.isRunning)
 
-        profiler.close()
+        profiler.close(true)
         assertFalse(profiler.isRunning)
 
         // The timeout scheduled job should be cleared
@@ -470,14 +470,31 @@ class AndroidContinuousProfilerTest {
         verify(fixture.scopes).captureProfileChunk(any())
     }
 
+    @Test
+    fun `close without terminating stops all profiles after chunk is finished`() {
+        val profiler = fixture.getSut()
+        profiler.startProfiler(ProfileLifecycle.MANUAL, fixture.mockTracesSampler)
+        profiler.startProfiler(ProfileLifecycle.TRACE, fixture.mockTracesSampler)
+        assertTrue(profiler.isRunning)
+        // We are scheduling the profiler to stop at the end of the chunk, so it should still be running
+        profiler.close(false)
+        assertTrue(profiler.isRunning)
+        // However, close() already resets the rootSpanCounter
+        assertEquals(0, profiler.rootSpanCounter)
+
+        // We run the executor service to trigger the chunk finish, and the profiler shouldn't restart
+        fixture.executor.runAll()
+        assertFalse(profiler.isRunning)
+    }
+
     @Test
     fun `profiler does not send chunks after close`() {
         val profiler = fixture.getSut()
         profiler.startProfiler(ProfileLifecycle.MANUAL, fixture.mockTracesSampler)
         assertTrue(profiler.isRunning)
 
         // We close the profiler, which should prevent sending additional chunks
-        profiler.close()
+        profiler.close(true)
 
         // The executor used to send the chunk doesn't do anything
         fixture.executor.runAll()

sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt

@@ -446,7 +446,7 @@ class AndroidOptionsInitializerTest {
         assertEquals(fixture.sentryOptions.continuousProfiler, NoOpContinuousProfiler.getInstance())
 
         // app start profiler is closed, because it will never be used
-        verify(appStartContinuousProfiler).close()
+        verify(appStartContinuousProfiler).close(eq(true))
 
         // AppStartMetrics should be cleared
         assertNull(AppStartMetrics.getInstance().appStartProfiler)

sentry-android-core/src/test/java/io/sentry/android/core/LifecycleWatcherTest.kt

@@ -3,6 +3,7 @@ package io.sentry.android.core
 import androidx.lifecycle.LifecycleOwner
 import io.sentry.Breadcrumb
 import io.sentry.DateUtils
+import io.sentry.IContinuousProfiler
 import io.sentry.IScope
 import io.sentry.IScopes
 import io.sentry.ReplayController
@@ -15,6 +16,7 @@ import io.sentry.transport.ICurrentDateProvider
 import org.mockito.ArgumentCaptor
 import org.mockito.kotlin.any
 import org.mockito.kotlin.check
+import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
 import org.mockito.kotlin.timeout
@@ -38,6 +40,7 @@ class LifecycleWatcherTest {
         val dateProvider = mock<ICurrentDateProvider>()
         val options = SentryOptions()
         val replayController = mock<ReplayController>()
+        val continuousProfiler = mock<IContinuousProfiler>()
 
         fun getSUT(
             sessionIntervalMillis: Long = 0L,
@@ -52,6 +55,7 @@ class LifecycleWatcherTest {
                 argumentCaptor.value.run(scope)
             }
             options.setReplayController(replayController)
+            options.setContinuousProfiler(continuousProfiler)
             whenever(scopes.options).thenReturn(options)
 
             return LifecycleWatcher(
@@ -106,6 +110,7 @@ class LifecycleWatcherTest {
         watcher.onStop(fixture.ownerMock)
         verify(fixture.scopes, timeout(10000)).endSession()
         verify(fixture.replayController, timeout(10000)).stop()
+        verify(fixture.continuousProfiler, timeout(10000)).close(eq(false))
     }
 
     @Test