For mozilla-mobile#18854: Add metrics for home screen being displayed.

mcarare · Apr 14, 2021 · 1121211 · 1121211
1 parent f797845
commit 1121211
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 0 deletions.
diff --git a/app/metrics.yaml b/app/metrics.yaml
@@ -5093,6 +5093,20 @@ awesomebar:
       - fenix-core@mozilla.com
     expires: "2021-08-01"
 
+home_screen:
+  home_screen_displayed:
+    type: event
+    description: The user clicked the settings option in home menu.
+    bugs:
+      - https://github.com/mozilla-mobile/fenix/issues/18856
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/18987
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2021-10-01"
+
 android_keystore_experiment:
   experiment_failure:
     type: event

diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/Event.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/Event.kt
@@ -224,6 +224,8 @@ sealed class Event {
     object SearchSuggestionClicked : Event()
     object OpenedTabSuggestionClicked : Event()
 
+    object HomeScreenDisplayed : Event()
+
     // Interaction events with extras
 
     data class TopSiteSwipeCarousel(val page: Int) : Event() {

diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/GleanMetricsService.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/GleanMetricsService.kt
@@ -34,6 +34,7 @@ import org.mozilla.fenix.GleanMetrics.ErrorPage
 import org.mozilla.fenix.GleanMetrics.Events
 import org.mozilla.fenix.GleanMetrics.FindInPage
 import org.mozilla.fenix.GleanMetrics.History
+import org.mozilla.fenix.GleanMetrics.HomeScreen
 import org.mozilla.fenix.GleanMetrics.LoginDialog
 import org.mozilla.fenix.GleanMetrics.Logins
 import org.mozilla.fenix.GleanMetrics.MasterPassword
@@ -809,6 +810,9 @@ private val Event.wrapper: EventWrapper<*>?
         is Event.SecurePrefsReset -> EventWrapper<NoExtraKeys>(
             { AndroidKeystoreExperiment.reset.record(it) }
         )
+        is Event.HomeScreenDisplayed -> EventWrapper<NoExtraKeys>(
+            { HomeScreen.homeScreenDisplayed.record(it) }
+        )
 
         // Don't record other events in Glean:
         is Event.AddBookmark -> null

diff --git a/app/src/main/java/org/mozilla/fenix/home/HomeFragment.kt b/app/src/main/java/org/mozilla/fenix/home/HomeFragment.kt
@@ -364,6 +364,7 @@ class HomeFragment : Fragment() {
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) =
         PerfStartup.homeFragmentOnViewCreated.measureNoInline {
             super.onViewCreated(view, savedInstanceState)
+            context?.metrics?.track(Event.HomeScreenDisplayed)
 
             observeSearchEngineChanges()
             createHomeMenu(requireContext(), WeakReference(view.menuButton))

diff --git a/docs/metrics.md b/docs/metrics.md
@@ -154,6 +154,7 @@ In addition to those built-in metrics, the following metrics are added to the pi
 | history.removed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user removed a history item  |[mozilla-mobile/fenix#3940](https://github.com/mozilla-mobile/fenix/pull/3940), [mozilla-mobile/fenix#15713](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 |
 | history.removed_all |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user removed all history items  |[mozilla-mobile/fenix#3940](https://github.com/mozilla-mobile/fenix/pull/3940), [mozilla-mobile/fenix#15713](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 |
 | history.shared |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A user shared a history item  |[mozilla-mobile/fenix#3940](https://github.com/mozilla-mobile/fenix/pull/3940), [mozilla-mobile/fenix#15713](https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068)||2021-08-01 |2 |
+| home_screen.home_screen_displayed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The user clicked the settings option in home menu. |[mozilla-mobile/fenix#18987](https://github.com/mozilla-mobile/fenix/pull/18987)||2021-10-01 |2 |
 | login_dialog.cancelled |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The login dialog prompt was cancelled  |[mozilla-mobile/fenix#13050](https://github.com/mozilla-mobile/fenix/pull/13050)||2021-08-01 |2 |
 | login_dialog.displayed |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The login dialog prompt was displayed  |[mozilla-mobile/fenix#13050](https://github.com/mozilla-mobile/fenix/pull/13050)||2021-08-01 |2 |
 | login_dialog.never_save |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |The login dialog prompt "never save" button was pressed  |[mozilla-mobile/fenix#13050](https://github.com/mozilla-mobile/fenix/pull/13050)||2021-08-01 |2 |