Send transaction memory stats in profile payload (#2447)

* Added list of MemoryCollectionData to Android profiles payload as measurements
* AndroidTransactionProfiler now takes a PerformanceCollectionData onTransactionFinish
* Updated profile measurement keys and units

Author: stefanosiano

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Send transaction memory stats in profile payload ([#2447](https://github.com/getsentry/sentry-java/pull/2447))
 - Add cpu usage collection ([#2462](https://github.com/getsentry/sentry-java/pull/2462))
 - Improve ANR implementation: ([#2475](https://github.com/getsentry/sentry-java/pull/2475))
   - Add `abnormal_mechanism` to sessions for ANR rate calculation

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

@@ -71,16 +71,16 @@ public void collect(
     if (buildInfoProvider.getSdkInfoVersion() < Build.VERSION_CODES.LOLLIPOP || !isEnabled) {
       return;
     }
-    long nowNanos = SystemClock.elapsedRealtimeNanos();
-    long realTimeNanosDiff = nowNanos - lastRealtimeNanos;
+    final long nowNanos = SystemClock.elapsedRealtimeNanos();
+    final long realTimeNanosDiff = nowNanos - lastRealtimeNanos;
     lastRealtimeNanos = nowNanos;
-    long cpuNanos = readTotalCpuNanos();
-    long cpuNanosDiff = cpuNanos - lastCpuNanos;
+    final long cpuNanos = readTotalCpuNanos();
+    final long cpuNanosDiff = cpuNanos - lastCpuNanos;
     lastCpuNanos = cpuNanos;
     // Later we need to divide the percentage by the number of cores, otherwise we could
     // get a percentage value higher than 1. We also want to send the percentage as a
     // number from 0 to 100, so we are going to multiply it by 100
-    double cpuUsagePercentage = cpuNanosDiff / (double) realTimeNanosDiff;
+    final double cpuUsagePercentage = cpuNanosDiff / (double) realTimeNanosDiff;
 
     CpuCollectionData cpuData =
         new CpuCollectionData(
@@ -106,15 +106,20 @@ private long readTotalCpuNanos() {
     if (stat != null) {
       stat = stat.trim();
       String[] stats = stat.split("[\n\t\r ]");
-      // Amount of clock ticks this process has been scheduled in user mode
-      long uTime = Long.parseLong(stats[13]);
-      // Amount of clock ticks this process has been scheduled in kernel mode
-      long sTime = Long.parseLong(stats[14]);
-      // Amount of clock ticks this process' waited-for children has been scheduled in user mode
-      long cuTime = Long.parseLong(stats[15]);
-      // Amount of clock ticks this process' waited-for children has been scheduled in kernel mode
-      long csTime = Long.parseLong(stats[16]);
-      return (long) ((uTime + sTime + cuTime + csTime) * nanosecondsPerClockTick);
+      try {
+        // Amount of clock ticks this process has been scheduled in user mode
+        long uTime = Long.parseLong(stats[13]);
+        // Amount of clock ticks this process has been scheduled in kernel mode
+        long sTime = Long.parseLong(stats[14]);
+        // Amount of clock ticks this process' waited-for children has been scheduled in user mode
+        long cuTime = Long.parseLong(stats[15]);
+        // Amount of clock ticks this process' waited-for children has been scheduled in kernel mode
+        long csTime = Long.parseLong(stats[16]);
+        return (long) ((uTime + sTime + cuTime + csTime) * nanosecondsPerClockTick);
+      } catch (NumberFormatException e) {
+        logger.log(SentryLevel.ERROR, "Error parsing /proc/self/stat file.", e);
+        return 0;
+      }
     }
     return 0;
   }

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

@@ -15,6 +15,8 @@
 import io.sentry.IHub;
 import io.sentry.ITransaction;
 import io.sentry.ITransactionProfiler;
+import io.sentry.MemoryCollectionData;
+import io.sentry.PerformanceCollectionData;
 import io.sentry.ProfilingTraceData;
 import io.sentry.ProfilingTransactionData;
 import io.sentry.SentryLevel;
@@ -233,7 +235,7 @@ public void onFrameMetricCollected(
         options
             .getExecutorService()
             .schedule(
-                () -> timedOutProfilingData = onTransactionFinish(transaction, true),
+                () -> timedOutProfilingData = onTransactionFinish(transaction, true, null),
                 PROFILING_TIMEOUT_MILLIS);
 
     transactionStartNanos = SystemClock.elapsedRealtimeNanos();
@@ -247,11 +249,12 @@ public void onFrameMetricCollected(
 
   @Override
   public @Nullable synchronized ProfilingTraceData onTransactionFinish(
-      final @NotNull ITransaction transaction) {
+      final @NotNull ITransaction transaction,
+      final @Nullable PerformanceCollectionData performanceCollectionData) {
     try {
       return options
           .getExecutorService()
-          .submit(() -> onTransactionFinish(transaction, false))
+          .submit(() -> onTransactionFinish(transaction, false, performanceCollectionData))
           .get();
     } catch (ExecutionException e) {
       options.getLogger().log(SentryLevel.ERROR, "Error finishing profiling: ", e);
@@ -263,7 +266,9 @@ public void onFrameMetricCollected(
 
   @SuppressLint("NewApi")
   private @Nullable ProfilingTraceData onTransactionFinish(
-      final @NotNull ITransaction transaction, final boolean isTimeout) {
+      final @NotNull ITransaction transaction,
+      final boolean isTimeout,
+      final @Nullable PerformanceCollectionData performanceCollectionData) {
 
     // onTransactionStart() is only available since Lollipop
     // and SystemClock.elapsedRealtimeNanos() since Jelly Bean
@@ -383,6 +388,7 @@ public void onFrameMetricCollected(
           ProfileMeasurement.ID_SCREEN_FRAME_RATES,
           new ProfileMeasurement(ProfileMeasurement.UNIT_HZ, screenFrameRateMeasurements));
     }
+    putPerformanceCollectionDataInMeasurements(performanceCollectionData);
 
     // 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
@@ -408,6 +414,43 @@ public void onFrameMetricCollected(
         measurementsMap);
   }
 
+  private void putPerformanceCollectionDataInMeasurements(
+      final @Nullable PerformanceCollectionData performanceCollectionData) {
+    if (performanceCollectionData != null) {
+      List<MemoryCollectionData> memoryCollectionData = performanceCollectionData.getMemoryData();
+      final @NotNull ArrayDeque<ProfileMeasurementValue> memoryUsageMeasurements =
+          new ArrayDeque<>();
+      final @NotNull ArrayDeque<ProfileMeasurementValue> nativeMemoryUsageMeasurements =
+          new ArrayDeque<>();
+      for (MemoryCollectionData memoryData : memoryCollectionData) {
+        if (memoryData.getUsedHeapMemory() > -1) {
+          memoryUsageMeasurements.add(
+              new ProfileMeasurementValue(
+                  TimeUnit.MILLISECONDS.toNanos(memoryData.getTimestampMillis())
+                      - transactionStartNanos,
+                  memoryData.getUsedHeapMemory()));
+        }
+        if (memoryData.getUsedNativeMemory() > -1) {
+          nativeMemoryUsageMeasurements.add(
+              new ProfileMeasurementValue(
+                  TimeUnit.MILLISECONDS.toNanos(memoryData.getTimestampMillis())
+                      - transactionStartNanos,
+                  memoryData.getUsedNativeMemory()));
+        }
+      }
+      if (!memoryUsageMeasurements.isEmpty()) {
+        measurementsMap.put(
+            ProfileMeasurement.ID_MEMORY_FOOTPRINT,
+            new ProfileMeasurement(ProfileMeasurement.UNIT_BYTES, memoryUsageMeasurements));
+      }
+      if (!nativeMemoryUsageMeasurements.isEmpty()) {
+        measurementsMap.put(
+            ProfileMeasurement.ID_MEMORY_NATIVE_FOOTPRINT,
+            new ProfileMeasurement(ProfileMeasurement.UNIT_BYTES, nativeMemoryUsageMeasurements));
+      }
+    }
+  }
+
   /**
    * Get MemoryInfo object representing the memory state of the application.
    *

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

@@ -7,11 +7,14 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.sentry.IHub
 import io.sentry.ILogger
 import io.sentry.ISentryExecutorService
+import io.sentry.MemoryCollectionData
+import io.sentry.PerformanceCollectionData
 import io.sentry.ProfilingTraceData
 import io.sentry.SentryLevel
 import io.sentry.SentryTracer
 import io.sentry.TransactionContext
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector
+import io.sentry.profilemeasurements.ProfileMeasurement
 import io.sentry.test.getCtor
 import org.junit.runner.RunWith
 import org.mockito.kotlin.any
@@ -28,8 +31,10 @@ import java.util.concurrent.FutureTask
 import kotlin.test.AfterTest
 import kotlin.test.BeforeTest
 import kotlin.test.Test
+import kotlin.test.assertContentEquals
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
+import kotlin.test.assertFalse
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 
@@ -145,7 +150,7 @@ class AndroidTransactionProfilerTest {
     fun `profiler profiles current transaction`() {
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
 
         assertNotNull(profilingTraceData)
         assertEquals(profilingTraceData.transactionId, fixture.transaction1.eventId.toString())
@@ -158,7 +163,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context, buildInfo)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -169,7 +174,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -242,7 +247,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -253,7 +258,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -264,7 +269,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -275,7 +280,7 @@ class AndroidTransactionProfilerTest {
         }
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val traceData = profiler.onTransactionFinish(fixture.transaction1)
+        val traceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNotNull(traceData)
     }
 
@@ -287,15 +292,15 @@ class AndroidTransactionProfilerTest {
         whenever(mockExecutorService.submit(any<Callable<*>>())).thenReturn(mock())
         profiler.onTransactionStart(fixture.transaction1)
         verify(mockExecutorService).submit(any<Runnable>())
-        val profilingTraceData: ProfilingTraceData? = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData: ProfilingTraceData? = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
         verify(mockExecutorService).submit(any<Callable<*>>())
     }
 
     @Test
     fun `onTransactionFinish works only if previously started`() {
         val profiler = fixture.getSut(context)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNull(profilingTraceData)
     }
 
@@ -310,7 +315,7 @@ class AndroidTransactionProfilerTest {
         fixture.lastScheduledRunnable?.run()
 
         // First transaction finishes: timed out data is returned
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertEquals(profilingTraceData!!.transactionId, fixture.transaction1.eventId.toString())
         assertEquals(ProfilingTraceData.TRUNCATION_REASON_TIMEOUT, profilingTraceData.truncationReason)
     }
@@ -321,10 +326,10 @@ class AndroidTransactionProfilerTest {
         profiler.onTransactionStart(fixture.transaction1)
         profiler.onTransactionStart(fixture.transaction2)
 
-        var profilingTraceData = profiler.onTransactionFinish(fixture.transaction2)
+        var profilingTraceData = profiler.onTransactionFinish(fixture.transaction2, null)
         assertNull(profilingTraceData)
 
-        profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNotNull(profilingTraceData)
         assertEquals(profilingTraceData.transactionId, fixture.transaction1.eventId.toString())
     }
@@ -333,7 +338,7 @@ class AndroidTransactionProfilerTest {
     fun `profiling trace data contains release field`() {
         val profiler = fixture.getSut(context)
         profiler.onTransactionStart(fixture.transaction1)
-        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1)
+        val profilingTraceData = profiler.onTransactionFinish(fixture.transaction1, null)
         assertNotNull(profilingTraceData!!.release)
         assertEquals(fixture.options.release, profilingTraceData.release)
     }
@@ -353,7 +358,36 @@ class AndroidTransactionProfilerTest {
         whenever(fixture.frameMetricsCollector.startCollection(any())).thenReturn(frameMetricsCollectorId)
         profiler.onTransactionStart(fixture.transaction1)
         profiler.onTransactionStart(fixture.transaction2)
-        profiler.onTransactionFinish(fixture.transaction1)
+        profiler.onTransactionFinish(fixture.transaction1, null)
         verify(fixture.frameMetricsCollector).stopCollection(frameMetricsCollectorId)
     }
+
+    @Test
+    fun `profiler does not includes memory measurements when null is passed on transaction finish`() {
+        val profiler = fixture.getSut(context)
+        profiler.onTransactionStart(fixture.transaction1)
+        val data = profiler.onTransactionFinish(fixture.transaction1, null)
+        assertFalse(data!!.measurementsMap.containsKey(ProfileMeasurement.ID_MEMORY_FOOTPRINT))
+        assertFalse(data.measurementsMap.containsKey(ProfileMeasurement.ID_MEMORY_NATIVE_FOOTPRINT))
+    }
+
+    @Test
+    fun `profiler includes memory measurements when passed on transaction finish`() {
+        val profiler = fixture.getSut(context)
+        val memoryCollectionData = PerformanceCollectionData()
+        memoryCollectionData.addMemoryData(MemoryCollectionData(1, 2, 3))
+        memoryCollectionData.commitData()
+        memoryCollectionData.addMemoryData(MemoryCollectionData(2, 3, 4))
+        memoryCollectionData.commitData()
+        profiler.onTransactionStart(fixture.transaction1)
+        val data = profiler.onTransactionFinish(fixture.transaction1, memoryCollectionData)
+        assertContentEquals(
+            listOf(2.0, 3.0),
+            data!!.measurementsMap[ProfileMeasurement.ID_MEMORY_FOOTPRINT]!!.values.map { it.value }
+        )
+        assertContentEquals(
+            listOf(3.0, 4.0),
+            data.measurementsMap[ProfileMeasurement.ID_MEMORY_NATIVE_FOOTPRINT]!!.values.map { it.value }
+        )
+    }
 }

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

@@ -3,6 +3,7 @@ package io.sentry.android.core
 import io.sentry.ITransaction
 import io.sentry.ITransactionProfiler
 import io.sentry.NoOpTransactionProfiler
+import io.sentry.PerformanceCollectionData
 import io.sentry.ProfilingTraceData
 import io.sentry.protocol.DebugImage
 import kotlin.test.Test
@@ -110,6 +111,9 @@ class SentryAndroidOptionsTest {
 
     private class CustomTransactionProfiler : ITransactionProfiler {
         override fun onTransactionStart(transaction: ITransaction) {}
-        override fun onTransactionFinish(transaction: ITransaction): ProfilingTraceData? = null
+        override fun onTransactionFinish(
+            transaction: ITransaction,
+            memoryCollectionData: PerformanceCollectionData?
+        ): ProfilingTraceData? = null
     }
 }

sentry/api/sentry.api

@@ -565,7 +565,7 @@ public abstract interface class io/sentry/ITransaction : io/sentry/ISpan {
 }
 
 public abstract interface class io/sentry/ITransactionProfiler {
-	public abstract fun onTransactionFinish (Lio/sentry/ITransaction;)Lio/sentry/ProfilingTraceData;
+	public abstract fun onTransactionFinish (Lio/sentry/ITransaction;Lio/sentry/PerformanceCollectionData;)Lio/sentry/ProfilingTraceData;
 	public abstract fun onTransactionStart (Lio/sentry/ITransaction;)V
 }
 
@@ -855,7 +855,7 @@ public final class io/sentry/NoOpTransaction : io/sentry/ITransaction {
 
 public final class io/sentry/NoOpTransactionProfiler : io/sentry/ITransactionProfiler {
 	public static fun getInstance ()Lio/sentry/NoOpTransactionProfiler;
-	public fun onTransactionFinish (Lio/sentry/ITransaction;)Lio/sentry/ProfilingTraceData;
+	public fun onTransactionFinish (Lio/sentry/ITransaction;Lio/sentry/PerformanceCollectionData;)Lio/sentry/ProfilingTraceData;
 	public fun onTransactionStart (Lio/sentry/ITransaction;)V
 }
 
@@ -2430,9 +2430,12 @@ public final class io/sentry/internal/modules/ResourcesModulesLoader : io/sentry
 
 public final class io/sentry/profilemeasurements/ProfileMeasurement : io/sentry/JsonSerializable, io/sentry/JsonUnknown {
 	public static final field ID_FROZEN_FRAME_RENDERS Ljava/lang/String;
+	public static final field ID_MEMORY_FOOTPRINT Ljava/lang/String;
+	public static final field ID_MEMORY_NATIVE_FOOTPRINT Ljava/lang/String;
 	public static final field ID_SCREEN_FRAME_RATES Ljava/lang/String;
 	public static final field ID_SLOW_FRAME_RENDERS Ljava/lang/String;
 	public static final field ID_UNKNOWN Ljava/lang/String;
+	public static final field UNIT_BYTES Ljava/lang/String;
 	public static final field UNIT_HZ Ljava/lang/String;
 	public static final field UNIT_NANOSECONDS Ljava/lang/String;
 	public static final field UNIT_UNKNOWN Ljava/lang/String;
@@ -2466,6 +2469,7 @@ public final class io/sentry/profilemeasurements/ProfileMeasurementValue : io/se
 	public fun <init> (Ljava/lang/Long;Ljava/lang/Number;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public fun getUnknown ()Ljava/util/Map;
+	public fun getValue ()D
 	public fun hashCode ()I
 	public fun serialize (Lio/sentry/JsonObjectWriter;Lio/sentry/ILogger;)V
 	public fun setUnknown (Ljava/util/Map;)V

sentry/src/main/java/io/sentry/ITransactionProfiler.java

@@ -10,5 +10,6 @@ public interface ITransactionProfiler {
   void onTransactionStart(@NotNull ITransaction transaction);
 
   @Nullable
-  ProfilingTraceData onTransactionFinish(@NotNull ITransaction transaction);
+  ProfilingTraceData onTransactionFinish(
+      @NotNull ITransaction transaction, @Nullable PerformanceCollectionData memoryCollectionData);
 }