diff --git a/app/metrics.yaml b/app/metrics.yaml index 8e05f3c86..8539e4519 100644 --- a/app/metrics.yaml +++ b/app/metrics.yaml @@ -4487,8 +4487,8 @@ contextual_menu: - fenix-core@mozilla.com expires: "2021-06-01" -engine: - tab_kills: +engine_tab: + kills: type: labeled_counter labels: - foreground @@ -4507,7 +4507,7 @@ engine: - skaspari@mozilla.com expires: "2021-12-31" kill_foreground_age: - type: timespan + type: timing_distribution time_unit: millisecond description: | Measures the age of the engine session of a foreground (selected) tab @@ -4523,7 +4523,7 @@ engine: - skaspari@mozilla.com expires: "2021-12-31" kill_background_age: - type: timespan + type: timing_distribution time_unit: millisecond description: | Measures the age of the engine session of a background tab at the diff --git a/app/src/main/java/org/mozilla/fenix/TelemetryMiddleware.kt b/app/src/main/java/org/mozilla/fenix/TelemetryMiddleware.kt index 53a55bdfd..d4dad123e 100644 --- a/app/src/main/java/org/mozilla/fenix/TelemetryMiddleware.kt +++ b/app/src/main/java/org/mozilla/fenix/TelemetryMiddleware.kt @@ -24,7 +24,7 @@ import org.mozilla.fenix.components.metrics.Event import org.mozilla.fenix.components.metrics.MetricController import org.mozilla.fenix.search.telemetry.ads.AdsTelemetry import org.mozilla.fenix.utils.Settings -import org.mozilla.fenix.GleanMetrics.Engine as EngineMetrics +import org.mozilla.fenix.GleanMetrics.EngineTab as EngineMetrics /** * [Middleware] to record telemetry in response to [BrowserAction]s. @@ -138,24 +138,24 @@ class TelemetryMiddleware( } val isSelected = tab.id == state.selectedTabId - val ageNanos = tab.engineState.ageNanos() + val age = tab.engineState.age() // Increment the counter of killed foreground/background tabs val tabKillLabel = if (isSelected) { "foreground" } else { "background" } - EngineMetrics.tabKills[tabKillLabel].add() + EngineMetrics.kills[tabKillLabel].add() // Record the age of the engine session of the killed foreground/background tab. - if (isSelected && ageNanos != null) { - EngineMetrics.killForegroundAge.setRawNanos(ageNanos) - } else if (ageNanos != null) { - EngineMetrics.killBackgroundAge.setRawNanos(ageNanos) + if (isSelected && age != null) { + EngineMetrics.killForegroundAge.accumulateSamples(listOf(age).toLongArray()) + } else if (age != null) { + EngineMetrics.killBackgroundAge.accumulateSamples(listOf(age).toLongArray()) } } } @Suppress("MagicNumber") -private fun EngineState.ageNanos(): Long? { +private fun EngineState.age(): Long? { val timestamp = (timestamp ?: return null) val now = Clock.elapsedRealtime() - return (now - timestamp) * 1_000_000 + return (now - timestamp) } diff --git a/app/src/test/java/org/mozilla/fenix/TelemetryMiddlewareTest.kt b/app/src/test/java/org/mozilla/fenix/TelemetryMiddlewareTest.kt index 3f086f68f..55af22ff9 100644 --- a/app/src/test/java/org/mozilla/fenix/TelemetryMiddlewareTest.kt +++ b/app/src/test/java/org/mozilla/fenix/TelemetryMiddlewareTest.kt @@ -25,10 +25,11 @@ import mozilla.components.support.test.mock import mozilla.components.support.test.robolectric.testContext import mozilla.components.support.test.rule.MainCoroutineRule import org.junit.After -import org.junit.Assert import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse import org.junit.Assert.assertNotNull import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue import org.junit.Before import org.junit.Rule import org.junit.Test @@ -38,7 +39,7 @@ import org.mozilla.fenix.components.metrics.MetricController import org.mozilla.fenix.helpers.FenixRobolectricTestRunner import org.mozilla.fenix.search.telemetry.ads.AdsTelemetry import org.mozilla.fenix.utils.Settings -import org.mozilla.fenix.GleanMetrics.Engine as EngineMetrics +import org.mozilla.fenix.GleanMetrics.EngineTab as EngineMetrics @RunWith(FenixRobolectricTestRunner::class) @ExperimentalCoroutinesApi @@ -284,14 +285,14 @@ class TelemetryMiddlewareTest { selectedTabId = "foreground" )).joinBlocking() - Assert.assertFalse(EngineMetrics.tabKills["foreground"].testHasValue()) - Assert.assertFalse(EngineMetrics.tabKills["background"].testHasValue()) + assertFalse(EngineMetrics.kills["foreground"].testHasValue()) + assertFalse(EngineMetrics.kills["background"].testHasValue()) store.dispatch( EngineAction.KillEngineSessionAction("foreground") ).joinBlocking() - Assert.assertTrue(EngineMetrics.tabKills["foreground"].testHasValue()) + assertTrue(EngineMetrics.kills["foreground"].testHasValue()) } @Test @@ -305,24 +306,24 @@ class TelemetryMiddlewareTest { selectedTabId = "foreground" )).joinBlocking() - Assert.assertFalse(EngineMetrics.tabKills["foreground"].testHasValue()) - Assert.assertFalse(EngineMetrics.tabKills["background"].testHasValue()) + assertFalse(EngineMetrics.kills["foreground"].testHasValue()) + assertFalse(EngineMetrics.kills["background"].testHasValue()) store.dispatch( EngineAction.KillEngineSessionAction("background_pocket") ).joinBlocking() - Assert.assertFalse(EngineMetrics.tabKills["foreground"].testHasValue()) - Assert.assertTrue(EngineMetrics.tabKills["background"].testHasValue()) - assertEquals(1, EngineMetrics.tabKills["background"].testGetValue()) + assertFalse(EngineMetrics.kills["foreground"].testHasValue()) + assertTrue(EngineMetrics.kills["background"].testHasValue()) + assertEquals(1, EngineMetrics.kills["background"].testGetValue()) store.dispatch( EngineAction.KillEngineSessionAction("background_verge") ).joinBlocking() - Assert.assertFalse(EngineMetrics.tabKills["foreground"].testHasValue()) - Assert.assertTrue(EngineMetrics.tabKills["background"].testHasValue()) - assertEquals(2, EngineMetrics.tabKills["background"].testGetValue()) + assertFalse(EngineMetrics.kills["foreground"].testHasValue()) + assertTrue(EngineMetrics.kills["background"].testHasValue()) + assertEquals(2, EngineMetrics.kills["background"].testGetValue()) } @Test @@ -343,8 +344,8 @@ class TelemetryMiddlewareTest { engineSession = mock() )).joinBlocking() - Assert.assertFalse(EngineMetrics.killForegroundAge.testHasValue()) - Assert.assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) + assertFalse(EngineMetrics.killForegroundAge.testHasValue()) + assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) clock.elapsedTime = 500 @@ -352,9 +353,9 @@ class TelemetryMiddlewareTest { EngineAction.KillEngineSessionAction("foreground") ).joinBlocking() - Assert.assertTrue(EngineMetrics.killForegroundAge.testHasValue()) - Assert.assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) - assertEquals(400, EngineMetrics.killForegroundAge.testGetValue()) + assertTrue(EngineMetrics.killForegroundAge.testHasValue()) + assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) + assertEquals(400_000_000, EngineMetrics.killForegroundAge.testGetValue().sum) } @Test @@ -377,16 +378,16 @@ class TelemetryMiddlewareTest { clock.elapsedTime = 700 - Assert.assertFalse(EngineMetrics.killForegroundAge.testHasValue()) - Assert.assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) + assertFalse(EngineMetrics.killForegroundAge.testHasValue()) + assertFalse(EngineMetrics.killBackgroundAge.testHasValue()) store.dispatch( EngineAction.KillEngineSessionAction("background_pocket") ).joinBlocking() - Assert.assertTrue(EngineMetrics.killBackgroundAge.testHasValue()) - Assert.assertFalse(EngineMetrics.killForegroundAge.testHasValue()) - assertEquals(600, EngineMetrics.killBackgroundAge.testGetValue()) + assertTrue(EngineMetrics.killBackgroundAge.testHasValue()) + assertFalse(EngineMetrics.killForegroundAge.testHasValue()) + assertEquals(600_000_000, EngineMetrics.killBackgroundAge.testGetValue().sum) } } diff --git a/docs/metrics.md b/docs/metrics.md index 24bdcb0df..565873a1a 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -280,9 +280,9 @@ The following metrics are added to the ping: | browser.search.ad_clicks |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Records clicks of adverts on SERP pages. The key format is ‘’. |[1](https://github.com/mozilla-mobile/fenix/pull/10112), [2](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 | | browser.search.in_content |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Records the type of interaction a user has on SERP pages. |[1](https://github.com/mozilla-mobile/fenix/pull/10167), [2](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 | | browser.search.with_ads |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |Records counts of SERP pages with adverts displayed. The key format is ‘’. |[1](https://github.com/mozilla-mobile/fenix/pull/10112), [2](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 | -| engine.kill_background_age |[timespan](https://mozilla.github.io/glean/book/user/metrics/timespan.html) |Measures the age of the engine session of a background tab at the time its content process got killed. |[1](https://github.com/mozilla-mobile/fenix/pull/17864)||2021-12-31 |1 | -| engine.kill_foreground_age |[timespan](https://mozilla.github.io/glean/book/user/metrics/timespan.html) |Measures the age of the engine session of a foreground (selected) tab at the time its content process got killed. |[1](TBD)||2021-12-31 |1 | -| engine.tab_kills |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |How often was the content process of a foreground (selected) or background tab killed. |[1](https://github.com/mozilla-mobile/fenix/pull/17864)||2021-12-31 |1 | +| engine_tab.kill_background_age |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measures the age of the engine session of a background tab at the time its content process got killed. |[1](https://github.com/mozilla-mobile/fenix/pull/17864)||2021-12-31 |1 | +| engine_tab.kill_foreground_age |[timing_distribution](https://mozilla.github.io/glean/book/user/metrics/timing_distribution.html) |Measures the age of the engine session of a foreground (selected) tab at the time its content process got killed. |[1](TBD)||2021-12-31 |1 | +| engine_tab.kills |[labeled_counter](https://mozilla.github.io/glean/book/user/metrics/labeled_counters.html) |How often was the content process of a foreground (selected) or background tab killed. |[1](https://github.com/mozilla-mobile/fenix/pull/17864)||2021-12-31 |1 | | events.normal_and_private_uri_count |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |A counter of URIs visited by the user in the current session, including page reloads. This includes private browsing. This does not include background page requests and URIs from embedded pages but may be incremented without user interaction by website scripts that programmatically redirect to a new location. |[1](https://github.com/mozilla-mobile/fenix/pull/17935)||2022-08-01 |2 | | events.total_uri_count |[counter](https://mozilla.github.io/glean/book/user/metrics/counter.html) |A counter of URIs visited by the user in the current session, including page reloads. This does not include background page requests and URIs from embedded pages or private browsing but may be incremented without user interaction by website scripts that programmatically redirect to a new location. |[1](https://github.com/mozilla-mobile/fenix/pull/1785), [2](https://github.com/mozilla-mobile/fenix/pull/8314), [3](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 | | metrics.adjust_ad_group |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |A string containing the Adjust ad group ID from which the user installed Fenix. This will not send on the first session the user runs. If the install is organic, this will be empty. |[1](https://github.com/mozilla-mobile/fenix/pull/9253), [2](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 |