added FrameMetrics to Android profiling data (#2342)

* added ProfileMeasurements to AndroidTransactionProfiler and ProfilingTraceData
* added frameMetrics (slow and frozen frames) and screen refresh rate
* added a SentryFrameMetricsCollector to collect frameMetrics
* updated espresso test dependency to stable to run on Android 13 devices
* increased benchmark cpu overhead threshold from 5% to 5.5%
* updated benchmark device from OnePlus Nord N200 to Google Pixel 3a
* added automatic activity transaction in ui test
* Remove profiler main thread io (#2348)
* fixed crash in sample app's ProfilingActivity

Author: stefanosiano

.sauce/sentry-uitest-android-benchmark-lite.yml

@@ -20,7 +20,7 @@ suites:
 
   - name: "Android 11 (api 30)"
     devices:
-      - id: OnePlus_Nord_N200_5G_real_us # OnePlus Nord N200 5G - api 30 (11)
+      - id: Google_Pixel_3a_real # Google Pixel 3a - api 30 (11)
 
 artifacts:
   download:

.sauce/sentry-uitest-android-benchmark.yml

@@ -28,11 +28,11 @@ suites:
     devices:
       - id: OnePlus_9_Pro_real_us # OnePlus 9 Pro - api 30 (11) - high end
       - id: Google_Pixel_4_real_us # Google Pixel 4 - api 30 (11) - mid end
-      - id: OnePlus_Nord_N200_5G_real_us # OnePlus Nord N200 5G - api 30 (11) - low end
+      - id: Google_Pixel_3a_real # Google Pixel 3a - api 30 (11) - low end
 
   - name: "Android 10 (api 29)"
     devices:
-      - id: OnePlus_7T_real_us # OnePlus 7T - api 29 (10)
+      - id: Google_Pixel_4_XL_real_us1 # Google Pixel 4 XL - api 29 (10)
       - id: Nokia_7_1_real_us # Nokia 7.1 - api 29 (10)
 
 # At the time of writing (July, 4, 2022), the market share per android version is:

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Remove profiler main thread io ([#2348](https://github.com/getsentry/sentry-java/pull/2348))
+
+### Features
+
+- Add FrameMetrics to Android profiling data ([#2342](https://github.com/getsentry/sentry-java/pull/2342))
+
 ## 6.7.1
 
 ### Fixes
@@ -11,6 +21,8 @@
 
 ### Features
 
+- Don't set device name on Android if `sendDefaultPii` is disabled ([#2354](https://github.com/getsentry/sentry-java/pull/2354))
+- Fix corrupted UUID on Motorola devices ([#2363](https://github.com/getsentry/sentry-java/pull/2363))
 - Update Spring Boot Jakarta to Spring Boot 3.0.0-RC2 ([#2347](https://github.com/getsentry/sentry-java/pull/2347))
 
 ## 6.7.0

buildSrc/src/main/java/Config.kt

@@ -139,10 +139,8 @@ object Config {
     }
 
     object TestLibs {
-        // todo These rc versions are needed to run ui tests on Android 13.
-        //  They will be replaced by stable version when 1.5.0/3.5.0 will be out.
-        private val androidxTestVersion = "1.5.0-rc01"
-        private val espressoVersion = "3.5.0-rc01"
+        private val androidxTestVersion = "1.5.0"
+        private val espressoVersion = "3.5.0"
 
         val androidJUnitRunner = "androidx.test.runner.AndroidJUnitRunner"
         val kotlinTestJunit = "org.jetbrains.kotlin:kotlin-test-junit:$kotlinVersion"

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

@@ -13,6 +13,7 @@
 import io.sentry.SentryLevel;
 import io.sentry.android.core.cache.AndroidEnvelopeCache;
 import io.sentry.android.core.internal.modules.AssetsModulesLoader;
+import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.android.fragment.FragmentLifecycleIntegration;
 import io.sentry.android.timber.SentryTimberIntegration;
 import io.sentry.util.Objects;
@@ -154,8 +155,10 @@ static void init(
     options.addEventProcessor(new PerformanceAndroidEventProcessor(options, activityFramesTracker));
 
     options.setTransportGate(new AndroidTransportGate(context, options.getLogger()));
+    final SentryFrameMetricsCollector frameMetricsCollector =
+        new SentryFrameMetricsCollector(context, options, buildInfoProvider);
     options.setTransactionProfiler(
-        new AndroidTransactionProfiler(context, options, buildInfoProvider));
+        new AndroidTransactionProfiler(context, options, buildInfoProvider, frameMetricsCollector));
     options.setModulesLoader(new AssetsModulesLoader(context, options.getLogger()));
   }
 

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

@@ -11,6 +11,7 @@
 import android.os.Debug;
 import android.os.Process;
 import android.os.SystemClock;
+import android.view.FrameMetrics;
 import io.sentry.HubAdapter;
 import io.sentry.IHub;
 import io.sentry.ITransaction;
@@ -20,15 +21,20 @@
 import io.sentry.SentryEnvelope;
 import io.sentry.SentryLevel;
 import io.sentry.android.core.internal.util.CpuInfoUtils;
+import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.exception.SentryEnvelopeException;
+import io.sentry.profilemeasurements.ProfileMeasurement;
+import io.sentry.profilemeasurements.ProfileMeasurementValue;
 import io.sentry.util.Objects;
 import java.io.File;
+import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -60,23 +66,41 @@ final class AndroidTransactionProfiler implements ITransactionProfiler {
   private long profileStartCpuMillis = 0;
   private boolean isInitialized = false;
   private int transactionsCounter = 0;
+  private @Nullable String frameMetricsCollectorId;
+  private final @NotNull SentryFrameMetricsCollector frameMetricsCollector;
   private final @NotNull Map<String, ProfilingTransactionData> transactionMap = new HashMap<>();
+  private final @NotNull ArrayDeque<ProfileMeasurementValue> screenFrameRateMeasurements =
+      new ArrayDeque<>();
+  private final @NotNull ArrayDeque<ProfileMeasurementValue> slowFrameRenderMeasurements =
+      new ArrayDeque<>();
+  private final @NotNull ArrayDeque<ProfileMeasurementValue> frozenFrameRenderMeasurements =
+      new ArrayDeque<>();
+  private final @NotNull Map<String, ProfileMeasurement> measurementsMap = new HashMap<>();
 
   public AndroidTransactionProfiler(
       final @NotNull Context context,
       final @NotNull SentryAndroidOptions sentryAndroidOptions,
-      final @NotNull BuildInfoProvider buildInfoProvider) {
-    this(context, sentryAndroidOptions, buildInfoProvider, HubAdapter.getInstance());
+      final @NotNull BuildInfoProvider buildInfoProvider,
+      final @NotNull SentryFrameMetricsCollector frameMetricsCollector) {
+    this(
+        context,
+        sentryAndroidOptions,
+        buildInfoProvider,
+        frameMetricsCollector,
+        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");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "The BuildInfoProvider is required.");
     this.packageInfo = ContextUtils.getPackageInfo(context, options.getLogger(), buildInfoProvider);
@@ -115,9 +139,13 @@ private void init() {
     traceFilesDir = new File(tracesFilesDirPath);
   }
 
-  @SuppressLint("NewApi")
   @Override
-  public synchronized void onTransactionStart(@NotNull ITransaction transaction) {
+  public synchronized void onTransactionStart(final @NotNull ITransaction transaction) {
+    options.getExecutorService().submit(() -> onTransactionStartSafe(transaction));
+  }
+
+  @SuppressLint("NewApi")
+  private void onTransactionStartSafe(final @NotNull ITransaction transaction) {
 
     // Debug.startMethodTracingSampling() is only available since Lollipop
     if (buildInfoProvider.getSdkInfoVersion() < Build.VERSION_CODES.LOLLIPOP) return;
@@ -127,38 +155,14 @@ public synchronized void onTransactionStart(@NotNull ITransaction transaction) {
 
     // traceFilesDir is null or intervalUs is 0 only if there was a problem in the init, but
     // we already logged that
-    if (traceFilesDir == null || intervalUs == 0 || !traceFilesDir.exists()) {
+    if (traceFilesDir == null || intervalUs == 0 || !traceFilesDir.canWrite()) {
       return;
     }
 
     transactionsCounter++;
     // When the first transaction is starting, we can start profiling
     if (transactionsCounter == 1) {
-
-      traceFile = new File(traceFilesDir, UUID.randomUUID() + ".trace");
-
-      if (traceFile.exists()) {
-        options
-            .getLogger()
-            .log(SentryLevel.DEBUG, "Trace file already exists: %s", traceFile.getPath());
-        transactionsCounter--;
-        return;
-      }
-
-      // We stop profiling after a timeout to avoid huge profiles to be sent
-      scheduledFinish =
-          options
-              .getExecutorService()
-              .schedule(() -> onTransactionFinish(transaction, true), PROFILING_TIMEOUT_MILLIS);
-
-      transactionStartNanos = SystemClock.elapsedRealtimeNanos();
-      profileStartCpuMillis = Process.getElapsedCpuTime();
-
-      ProfilingTransactionData transactionData =
-          new ProfilingTransactionData(transaction, transactionStartNanos, profileStartCpuMillis);
-      transactionMap.put(transaction.getEventId().toString(), transactionData);
-
-      Debug.startMethodTracingSampling(traceFile.getPath(), BUFFER_SIZE_BYTES, intervalUs);
+      onFirstTransactionStarted(transaction);
     } else {
       ProfilingTransactionData transactionData =
           new ProfilingTransactionData(
@@ -175,14 +179,73 @@ public synchronized void onTransactionStart(@NotNull ITransaction transaction) {
             transactionsCounter);
   }
 
+  @SuppressLint("NewApi")
+  private void onFirstTransactionStarted(final @NotNull ITransaction transaction) {
+    // We create a file with a uuid name, so no need to check if it already exists
+    traceFile = new File(traceFilesDir, UUID.randomUUID() + ".trace");
+
+    measurementsMap.clear();
+    screenFrameRateMeasurements.clear();
+    slowFrameRenderMeasurements.clear();
+    frozenFrameRenderMeasurements.clear();
+
+    frameMetricsCollectorId =
+        frameMetricsCollector.startCollection(
+            new SentryFrameMetricsCollector.FrameMetricsCollectorListener() {
+              final long nanosInSecond = TimeUnit.SECONDS.toNanos(1);
+              final long frozenFrameThresholdNanos = TimeUnit.MILLISECONDS.toNanos(700);
+              float lastRefreshRate = 0;
+
+              @Override
+              public void onFrameMetricCollected(
+                  @NotNull FrameMetrics frameMetrics, float refreshRate) {
+                long frameTimestampRelativeNanos =
+                    SystemClock.elapsedRealtimeNanos() - transactionStartNanos;
+                long durationNanos = frameMetrics.getMetric(FrameMetrics.TOTAL_DURATION);
+                // Most frames take just a few nanoseconds longer than the optimal calculated
+                // duration.
+                // Therefore we subtract one, because otherwise almost all frames would be slow.
+                boolean isSlow = durationNanos > nanosInSecond / (refreshRate - 1);
+                float newRefreshRate = (int) (refreshRate * 100) / 100F;
+                if (durationNanos > frozenFrameThresholdNanos) {
+                  frozenFrameRenderMeasurements.addLast(
+                      new ProfileMeasurementValue(frameTimestampRelativeNanos, durationNanos));
+                } else if (isSlow) {
+                  slowFrameRenderMeasurements.addLast(
+                      new ProfileMeasurementValue(frameTimestampRelativeNanos, durationNanos));
+                }
+                if (newRefreshRate != lastRefreshRate) {
+                  lastRefreshRate = newRefreshRate;
+                  screenFrameRateMeasurements.addLast(
+                      new ProfileMeasurementValue(frameTimestampRelativeNanos, newRefreshRate));
+                }
+              }
+            });
+
+    // We stop profiling after a timeout to avoid huge profiles to be sent
+    scheduledFinish =
+        options
+            .getExecutorService()
+            .schedule(() -> onTransactionFinish(transaction, true), PROFILING_TIMEOUT_MILLIS);
+
+    transactionStartNanos = SystemClock.elapsedRealtimeNanos();
+    profileStartCpuMillis = Process.getElapsedCpuTime();
+
+    ProfilingTransactionData transactionData =
+        new ProfilingTransactionData(transaction, transactionStartNanos, profileStartCpuMillis);
+    transactionMap.put(transaction.getEventId().toString(), transactionData);
+
+    Debug.startMethodTracingSampling(traceFile.getPath(), BUFFER_SIZE_BYTES, intervalUs);
+  }
+
   @Override
-  public synchronized void onTransactionFinish(@NotNull ITransaction transaction) {
-    onTransactionFinish(transaction, false);
+  public synchronized void onTransactionFinish(final @NotNull ITransaction transaction) {
+    options.getExecutorService().submit(() -> onTransactionFinish(transaction, false));
   }
 
   @SuppressLint("NewApi")
-  private synchronized void onTransactionFinish(
-      @NotNull ITransaction transaction, boolean isTimeout) {
+  private void onTransactionFinish(
+      final @NotNull ITransaction transaction, final boolean isTimeout) {
 
     // onTransactionStart() is only available since Lollipop
     // and SystemClock.elapsedRealtimeNanos() since Jelly Bean
@@ -226,8 +289,14 @@ private synchronized void onTransactionFinish(
       }
       return;
     }
+    onLastTransactionFinished(transaction, isTimeout);
+  }
 
+  @SuppressLint("NewApi")
+  private void onLastTransactionFinished(final ITransaction transaction, final boolean isTimeout) {
     Debug.stopMethodTracing();
+    frameMetricsCollector.stopCollection(frameMetricsCollectorId);
+
     long transactionEndNanos = SystemClock.elapsedRealtimeNanos();
     long transactionEndCpuMillis = Process.getElapsedCpuTime();
     long transactionDurationNanos = transactionEndNanos - transactionStartNanos;
@@ -270,6 +339,23 @@ private synchronized void onTransactionFinish(
           profileStartCpuMillis);
     }
 
+    if (!slowFrameRenderMeasurements.isEmpty()) {
+      measurementsMap.put(
+          ProfileMeasurement.ID_SLOW_FRAME_RENDERS,
+          new ProfileMeasurement(ProfileMeasurement.UNIT_NANOSECONDS, slowFrameRenderMeasurements));
+    }
+    if (!frozenFrameRenderMeasurements.isEmpty()) {
+      measurementsMap.put(
+          ProfileMeasurement.ID_FROZEN_FRAME_RENDERS,
+          new ProfileMeasurement(
+              ProfileMeasurement.UNIT_NANOSECONDS, frozenFrameRenderMeasurements));
+    }
+    if (!screenFrameRateMeasurements.isEmpty()) {
+      measurementsMap.put(
+          ProfileMeasurement.ID_SCREEN_FRAME_RATES,
+          new ProfileMeasurement(ProfileMeasurement.UNIT_HZ, screenFrameRateMeasurements));
+    }
+
     // cpu max frequencies are read with a lambda because reading files is involved, so it will be
     // done in the background when the trace file is read
     ProfilingTraceData profilingTraceData =
@@ -292,7 +378,8 @@ private synchronized void onTransactionFinish(
             options.getEnvironment(),
             isTimeout
                 ? ProfilingTraceData.TRUNCATION_REASON_TIMEOUT
-                : ProfilingTraceData.TRUNCATION_REASON_NORMAL);
+                : ProfilingTraceData.TRUNCATION_REASON_NORMAL,
+            measurementsMap);
 
     SentryEnvelope envelope;
     try {