Add RenderingMetrics aggregation to the library

Author: smbduknow

perfsuite/src/main/java/com/booking/perfsuite/rendering/RenderingMetrics.kt

@@ -0,0 +1,47 @@
+package com.booking.perfsuite.rendering
+
+/**
+ * Class aggregating raw frame metrics into more high level representation suitable for
+ * reporting and simpler to analyze
+ */
+public data class RenderingMetrics(
+
+    /**
+     * Total amount of frames rendered during the screen session
+     */
+    val totalFrames: Long,
+
+    /**
+     * Amount of frames that take more that 16ms to render (considered as "slow")
+     */
+    val slowFrames: Long,
+
+    /**
+     * Amount of frames that take more that 700ms to render (considered as "frozen")
+     */
+    val frozenFrames: Long,
+
+    /**
+     * Amount of "good" frames that potentially could be rendered, but were "dropped" due to
+     * rendering performance issues.
+     *
+     * For instance if we target 60fps, the "good" frame would be any frame rendered for less than
+     * 16ms. But when we see "slow" frame that take 48ms to render, it spend the same time to render
+     * as 3 "good" frames would spend. That means that due to performance issue the app has rendered
+     * 1 frame, but 2 potentially good frames were dropped
+     */
+    val droppedFrames: Long,
+
+    /**
+     * Total time of freezing the UI due to rendering of the slow frames per screen session.
+     * This metric accumulates all freeze durations during the screen session
+     */
+    val totalFreezeTimeMs: Long = 0,
+
+    /**
+     * Total time spent by user on current screen. Helpful as a supporting metrics, since sometimes
+     * increase in Total Freeze Time might be caused by longer interactions with the screen
+     */
+    val foregroundTimeMs: Long? = null
+)
+

…app/monitoring/RenderingMetricsMapper.kt …uite/rendering/RenderingMetricsMapper.ktsampleApp/src/main/java/com/booking/perfsuite/app/monitoring/RenderingMetricsMapper.kt renamed to perfsuite/src/main/java/com/booking/perfsuite/rendering/RenderingMetricsMapper.kt sampleApp/src/main/java/com/booking/perfsuite/app/monitoring/RenderingMetricsMapper.kt renamed to perfsuite/src/main/java/com/booking/perfsuite/rendering/RenderingMetricsMapper.kt

@@ -1,13 +1,17 @@
-package com.booking.perfsuite.app.monitoring
+package com.booking.perfsuite.rendering
 
 import android.util.SparseIntArray
 import androidx.core.app.FrameMetricsAggregator
 import androidx.core.util.forEach
 import androidx.core.util.isEmpty
 
-internal object RenderingMetricsMapper {
+public object RenderingMetricsMapper {
 
-    fun toRenderingMetrics(
+    /**
+     * Aggregates raw frames data collected by [ActivityFrameMetricsTracker] into
+     * [RenderingMetrics] data class, which is more suitable for reporting & metric analysis
+     */
+    public fun toRenderingMetrics(
         metrics: Array<SparseIntArray>?,
         foregroundTime: Long?
     ): RenderingMetrics? {
@@ -37,10 +41,10 @@ internal object RenderingMetricsMapper {
         }
 
         return RenderingMetrics(
-            total = total,
-            slow = slow,
-            frozen = frozen,
-            dropped = dropped,
+            totalFrames = total,
+            slowFrames = slow,
+            frozenFrames = frozen,
+            droppedFrames = dropped,
             totalFreezeTimeMs = totalFreezeTime,
             foregroundTimeMs = foregroundTime
         )

sampleApp/src/main/java/com/booking/perfsuite/app/monitoring/ActivityFrameMetricsListener.kt

@@ -4,6 +4,7 @@ import android.app.Activity
 import android.util.Log
 import android.util.SparseIntArray
 import com.booking.perfsuite.rendering.ActivityFrameMetricsTracker
+import com.booking.perfsuite.rendering.RenderingMetricsMapper
 
 internal object ActivityFrameMetricsListener : ActivityFrameMetricsTracker.Listener {