Slow and frozen frames + frame delay for Spans

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

@@ -23,7 +23,7 @@ public final class io/sentry/android/core/ActivityLifecycleIntegration : android
 	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
 }
 
-public final class io/sentry/android/core/AndroidCpuCollector : io/sentry/ICollector {
+public final class io/sentry/android/core/AndroidCpuCollector : io/sentry/IPerformanceSnapshotCollector {
 	public fun <init> (Lio/sentry/ILogger;Lio/sentry/android/core/BuildInfoProvider;)V
 	public fun collect (Lio/sentry/PerformanceCollectionData;)V
 	public fun setup ()V
@@ -43,7 +43,7 @@ public final class io/sentry/android/core/AndroidLogger : io/sentry/ILogger {
 	public fun log (Lio/sentry/SentryLevel;Ljava/lang/Throwable;Ljava/lang/String;[Ljava/lang/Object;)V
 }
 
-public class io/sentry/android/core/AndroidMemoryCollector : io/sentry/ICollector {
+public class io/sentry/android/core/AndroidMemoryCollector : io/sentry/IPerformanceSnapshotCollector {
 	public fun <init> ()V
 	public fun collect (Lio/sentry/PerformanceCollectionData;)V
 	public fun setup ()V
@@ -71,6 +71,14 @@ public class io/sentry/android/core/AndroidProfiler$ProfileStartData {
 	public fun <init> (JJ)V
 }
 
+public class io/sentry/android/core/AndroidSlowFrozenFrameCollector : io/sentry/IPerformanceContinuousCollector, io/sentry/android/core/internal/util/SentryFrameMetricsCollector$FrameMetricsCollectorListener {
+	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;)V
+	public fun clear ()V
+	public fun onFrameMetricCollected (JJJF)V
+	public fun onSpanFinished (Lio/sentry/ISpan;)V
+	public fun onSpanStarted (Lio/sentry/ISpan;)V
+}
+
 public final class io/sentry/android/core/AnrIntegration : io/sentry/Integration, java/io/Closeable {
 	public fun <init> (Landroid/content/Context;)V
 	public fun close ()V
@@ -246,6 +254,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun getBeforeScreenshotCaptureCallback ()Lio/sentry/android/core/SentryAndroidOptions$BeforeCaptureCallback;
 	public fun getBeforeViewHierarchyCaptureCallback ()Lio/sentry/android/core/SentryAndroidOptions$BeforeCaptureCallback;
 	public fun getDebugImagesLoader ()Lio/sentry/android/core/IDebugImagesLoader;
+	public fun getFrameMetricsCollector ()Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;
 	public fun getNativeSdkName ()Ljava/lang/String;
 	public fun getProfilingTracesHz ()I
 	public fun getProfilingTracesIntervalMillis ()I
@@ -291,6 +300,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun setEnableRootCheck (Z)V
 	public fun setEnableScopeSync (Z)V
 	public fun setEnableSystemEventBreadcrumbs (Z)V
+	public fun setFrameMetricsCollector (Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;)V
 	public fun setNativeSdkName (Ljava/lang/String;)V
 	public fun setProfilingTracesHz (I)V
 	public fun setProfilingTracesIntervalMillis (I)V

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

@@ -21,6 +21,10 @@
  * A class that tracks slow and frozen frames using the FrameMetricsAggregator class from
  * androidx.core package. It also checks if the FrameMetricsAggregator class is available at
  * runtime.
+ *
+ * <p>If starfish is enabled, frame metrics are recorded using {@link
+ * io.sentry.android.core.internal.util.SentryFrameMetricsCollector} via {@link
+ * AndroidSlowFrozenFrameCollector} instead.
  */
 public final class ActivityFramesTracker {
 
@@ -42,7 +46,8 @@ public ActivityFramesTracker(
     final boolean androidXAvailable =
         loadClass.isClassAvailable("androidx.core.app.FrameMetricsAggregator", options.getLogger());
 
-    if (androidXAvailable) {
+    /** */
+    if (androidXAvailable && !options.isEnablePerformanceV2()) {
       frameMetricsAggregator = new FrameMetricsAggregator();
     }
     this.options = options;

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

@@ -6,8 +6,8 @@
 import android.system.Os;
 import android.system.OsConstants;
 import io.sentry.CpuCollectionData;
-import io.sentry.ICollector;
 import io.sentry.ILogger;
+import io.sentry.IPerformanceSnapshotCollector;
 import io.sentry.PerformanceCollectionData;
 import io.sentry.SentryLevel;
 import io.sentry.util.FileUtils;
@@ -22,7 +22,7 @@
 // The content of the /proc/self/stat file is specified in
 // https://man7.org/linux/man-pages/man5/proc.5.html
 @ApiStatus.Internal
-public final class AndroidCpuCollector implements ICollector {
+public final class AndroidCpuCollector implements IPerformanceSnapshotCollector {
 
   private long lastRealtimeNanos = 0;
   private long lastCpuNanos = 0;

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

@@ -1,14 +1,14 @@
 package io.sentry.android.core;
 
 import android.os.Debug;
-import io.sentry.ICollector;
+import io.sentry.IPerformanceSnapshotCollector;
 import io.sentry.MemoryCollectionData;
 import io.sentry.PerformanceCollectionData;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 @ApiStatus.Internal
-public class AndroidMemoryCollector implements ICollector {
+public class AndroidMemoryCollector implements IPerformanceSnapshotCollector {
 
   @Override
   public void setup() {}

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

@@ -100,6 +100,9 @@ static void loadDefaultAndMetadataOptions(
     // set a lower flush timeout on Android to avoid ANRs
     options.setFlushTimeoutMillis(DEFAULT_FLUSH_TIMEOUT_MS);
 
+    options.setFrameMetricsCollector(
+        new SentryFrameMetricsCollector(context, logger, buildInfoProvider));
+
     ManifestMetadataReader.applyMetadata(context, options, buildInfoProvider);
     initializeCacheDirs(context, options);
 
@@ -145,10 +148,8 @@ static void initializeIntegrationsAndProcessors(
     options.addEventProcessor(new ViewHierarchyEventProcessor(options));
     options.addEventProcessor(new AnrV2EventProcessor(context, options, buildInfoProvider));
     options.setTransportGate(new AndroidTransportGate(options));
-    final SentryFrameMetricsCollector frameMetricsCollector =
-        new SentryFrameMetricsCollector(context, options, buildInfoProvider);
     options.setTransactionProfiler(
-        new AndroidTransactionProfiler(context, options, buildInfoProvider, frameMetricsCollector));
+        new AndroidTransactionProfiler(context, options, buildInfoProvider));
     options.setModulesLoader(new AssetsModulesLoader(context, options.getLogger()));
     options.setDebugMetaLoader(new AssetsDebugMetaLoader(context, options.getLogger()));
 
@@ -183,9 +184,13 @@ static void initializeIntegrationsAndProcessors(
     }
 
     options.setMainThreadChecker(AndroidMainThreadChecker.getInstance());
-    if (options.getCollectors().isEmpty()) {
-      options.addCollector(new AndroidMemoryCollector());
-      options.addCollector(new AndroidCpuCollector(options.getLogger(), buildInfoProvider));
+    if (options.getPerformanceCollectors().isEmpty()) {
+      options.addPerformanceCollector(new AndroidMemoryCollector());
+      options.addPerformanceCollector(
+          new AndroidCpuCollector(options.getLogger(), buildInfoProvider));
+    }
+    if (options.isEnablePerformanceV2()) {
+      options.addPerformanceCollector(new AndroidSlowFrozenFrameCollector(options));
     }
     options.setTransactionPerformanceCollector(new DefaultTransactionPerformanceCollector(options));
 

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

@@ -0,0 +1,110 @@
+package io.sentry.android.core;
+
+import android.util.Log;
+import io.sentry.FrameMetrics;
+import io.sentry.IPerformanceContinuousCollector;
+import io.sentry.ISpan;
+import io.sentry.NoOpSpan;
+import io.sentry.SpanDataConvention;
+import io.sentry.SpanId;
+import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class AndroidSlowFrozenFrameCollector
+    implements IPerformanceContinuousCollector,
+        SentryFrameMetricsCollector.FrameMetricsCollectorListener {
+  private @NotNull final Object lock = new Object();
+  private @Nullable final SentryFrameMetricsCollector frameMetricsCollector;
+  private @Nullable volatile String listenerId;
+  private @NotNull final Map<SpanId, FrameMetrics> metricsAtSpanStart;
+
+  private @NotNull final FrameMetrics currentFrameMetrics;
+  final long nanosInSecond = TimeUnit.SECONDS.toNanos(1);
+  final long frozenFrameThresholdNanos = TimeUnit.MILLISECONDS.toNanos(700);
+  float lastRefreshRate = 0;
+
+  public AndroidSlowFrozenFrameCollector(@NotNull SentryAndroidOptions options) {
+    frameMetricsCollector = options.getFrameMetricsCollector();
+    metricsAtSpanStart = new HashMap<>();
+    currentFrameMetrics = new FrameMetrics();
+  }
+
+  @Override
+  public void onSpanStarted(final @NotNull ISpan span) {
+    if (span instanceof NoOpSpan) {
+      return;
+    }
+    synchronized (lock) {
+      metricsAtSpanStart.put(span.getSpanContext().getSpanId(), currentFrameMetrics.duplicate());
+
+      if (listenerId == null) {
+        if (frameMetricsCollector != null) {
+          listenerId = frameMetricsCollector.startCollection(this);
+        }
+      }
+    }
+  }
+
+  @Override
+  public void onSpanFinished(final @NotNull ISpan span) {
+    if (span instanceof NoOpSpan) {
+      return;
+    }
+    @Nullable FrameMetrics diff = null;
+    synchronized (lock) {
+      final @Nullable FrameMetrics metricsAtStart =
+          metricsAtSpanStart.remove(span.getSpanContext().getSpanId());
+      if (metricsAtStart != null) {
+        diff = currentFrameMetrics.diffTo(metricsAtStart);
+      }
+    }
+    if (diff != null) {
+      final int totalFrameCount = diff.getTotalFrameCount();
+      if (totalFrameCount > 0) {
+        span.setData(SpanDataConvention.FRAMES_SLOW, diff.getSlowFrameCount());
+        span.setData(SpanDataConvention.FRAMES_FROZEN, diff.getFrozenFrameCount());
+        span.setData(SpanDataConvention.FRAMES_TOTAL, diff.getFastFrameCount());
+      }
+    }
+  }
+
+  @Override
+  public void clear() {
+    Log.d("TAG", "clear");
+    synchronized (lock) {
+      if (listenerId != null) {
+        if (frameMetricsCollector != null) {
+          frameMetricsCollector.stopCollection(listenerId);
+        }
+        listenerId = null;
+      }
+      metricsAtSpanStart.clear();
+      currentFrameMetrics.clear();
+    }
+  }
+
+  @Override
+  public void onFrameMetricCollected(
+      long frameStartNanos,
+      long frameEndNanos,
+      long durationNanos,
+      long delayNanos,
+      boolean isSlow,
+      boolean isFrozen,
+      float refreshRate) {
+
+    lastRefreshRate = (int) (refreshRate * 100) / 100F;
+
+    if (isFrozen) {
+      currentFrameMetrics.addFrozenFrame(durationNanos);
+    } else if (isSlow) {
+      currentFrameMetrics.addSlowFrame(durationNanos);
+    } else {
+      currentFrameMetrics.addFastFrame(durationNanos);
+    }
+  }
+}

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

@@ -29,7 +29,6 @@
 final class AndroidTransactionProfiler implements ITransactionProfiler {
   private final @NotNull Context context;
   private final @NotNull SentryAndroidOptions options;
-  private final @NotNull IHub hub;
   private final @NotNull BuildInfoProvider buildInfoProvider;
   private boolean isInitialized = false;
   private int transactionsCounter = 0;
@@ -44,27 +43,34 @@ final class AndroidTransactionProfiler implements ITransactionProfiler {
   public AndroidTransactionProfiler(
       final @NotNull Context context,
       final @NotNull SentryAndroidOptions sentryAndroidOptions,
-      final @NotNull BuildInfoProvider buildInfoProvider,
-      final @NotNull SentryFrameMetricsCollector frameMetricsCollector) {
+      final @NotNull BuildInfoProvider buildInfoProvider) {
     this(
         context,
         sentryAndroidOptions,
         buildInfoProvider,
-        frameMetricsCollector,
+        Objects.requireNonNull(
+            sentryAndroidOptions.getFrameMetricsCollector(),
+            "sentryAndroidOptions.getFrameMetricsCollector() cannot be null."),
         HubAdapter.getInstance());
   }
 
+  public AndroidTransactionProfiler(
+      final @NotNull Context context,
+      final @NotNull SentryAndroidOptions sentryAndroidOptions,
+      final @NotNull BuildInfoProvider buildInfoProvider) {
+    this(context, sentryAndroidOptions, buildInfoProvider, HubAdapter.getInstance());
+  }
+
   public AndroidTransactionProfiler(
       final @NotNull Context context,
       final @NotNull SentryAndroidOptions sentryAndroidOptions,
       final @NotNull BuildInfoProvider buildInfoProvider,
-      final @NotNull SentryFrameMetricsCollector frameMetricsCollector,
       final @NotNull IHub hub) {
     this.context = Objects.requireNonNull(context, "The application context is required");
     this.options = Objects.requireNonNull(sentryAndroidOptions, "SentryAndroidOptions is required");
-    this.hub = Objects.requireNonNull(hub, "Hub is required");
     this.frameMetricsCollector =
-        Objects.requireNonNull(frameMetricsCollector, "SentryFrameMetricsCollector is required");
+        Objects.requireNonNull(
+            options.getFrameMetricsCollector(), "SentryFrameMetricsCollector is required");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "The BuildInfoProvider is required.");
   }

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

@@ -10,6 +10,7 @@
 import io.sentry.SentryOptions;
 import io.sentry.SpanStatus;
 import io.sentry.android.core.internal.util.RootChecker;
+import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.protocol.Mechanism;
 import io.sentry.protocol.SdkVersion;
 import org.jetbrains.annotations.ApiStatus;
@@ -214,6 +215,8 @@ public interface BeforeCaptureCallback {
 
   private boolean enablePerformanceV2 = false;
 
+  private @Nullable SentryFrameMetricsCollector frameMetricsCollector;
+
   public SentryAndroidOptions() {
     setSentryClientName(BuildConfig.SENTRY_ANDROID_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
     setSdkVersion(createSdkVersion());
@@ -613,4 +616,15 @@ public boolean isEnablePerformanceV2() {
   public void setEnablePerformanceV2(final boolean enablePerformanceV2) {
     this.enablePerformanceV2 = enablePerformanceV2;
   }
+
+  @ApiStatus.Internal
+  public @Nullable SentryFrameMetricsCollector getFrameMetricsCollector() {
+    return frameMetricsCollector;
+  }
+
+  @ApiStatus.Internal
+  public void setFrameMetricsCollector(
+      final @Nullable SentryFrameMetricsCollector frameMetricsCollector) {
+    this.frameMetricsCollector = frameMetricsCollector;
+  }
 }

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

@@ -570,14 +570,14 @@ class AndroidOptionsInitializerTest {
     fun `AndroidMemoryCollector is set to options`() {
         fixture.initSut()
 
-        assertTrue { fixture.sentryOptions.collectors.any { it is AndroidMemoryCollector } }
+        assertTrue { fixture.sentryOptions.performanceCollectors.any { it is AndroidMemoryCollector } }
     }
 
     @Test
     fun `AndroidCpuCollector is set to options`() {
         fixture.initSut()
 
-        assertTrue { fixture.sentryOptions.collectors.any { it is AndroidCpuCollector } }
+        assertTrue { fixture.sentryOptions.performanceCollectors.any { it is AndroidCpuCollector } }
     }
 
     @Test

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

@@ -101,7 +101,7 @@ class AndroidTransactionProfilerTest {
             transaction1 = SentryTracer(TransactionContext("", ""), hub)
             transaction2 = SentryTracer(TransactionContext("", ""), hub)
             transaction3 = SentryTracer(TransactionContext("", ""), hub)
-            return AndroidTransactionProfiler(context, options, buildInfoProvider, frameMetricsCollector, hub)
+            return AndroidTransactionProfiler(context, options, buildInfoProvider, hub)
         }
     }
 

sentry-samples/sentry-samples-android/src/main/AndroidManifest.xml

@@ -151,7 +151,7 @@
         <!--    how to disable sentry -->
         <!--    <meta-data android:name="io.sentry.enabled" android:value="false" /> -->
 
-      <meta-data android:name="io.sentry.performance-v2" android:value="true" />
+      <meta-data android:name="io.sentry.performance-v2.enable" android:value="true" />
 
     </application>
 </manifest>