For #2267: Adds telemetry for reader mode

mozilla-mobile · Jul 18, 2019 · 6ef6bc9 · 6ef6bc9
1 parent 9251597
commit 6ef6bc9
Show file tree

Hide file tree

Showing 4 changed files with 82 additions and 2 deletions.
diff --git a/app/metrics.yaml b/app/metrics.yaml
@@ -900,4 +900,38 @@ history:
       - https://github.com/mozilla-mobile/fenix/pull/3940
     notification_emails:
       - fenix-core@mozilla.com
+    expires: "2020-03-01"
+reader_mode:
+  available:
+    type: event
+    description: >
+      Reader mode is available for the current page
+    bugs:
+      - 2267
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/3941
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2020-03-01"
+  opened:
+    type: event
+    description: >
+      A user opened reader mode
+    bugs:
+      - 2267
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/3941
+    notification_emails:
+      - fenix-core@mozilla.com
+    expires: "2020-03-01"
+  appearance:
+    type: event
+    description: >
+      A user tapped the appearance button
+    bugs:
+      - 2267
+    data_reviews:
+      - https://github.com/mozilla-mobile/fenix/pull/3941
+    notification_emails:
+      - fenix-core@mozilla.com
     expires: "2020-03-01"
diff --git a/app/src/main/java/org/mozilla/fenix/browser/BrowserFragment.kt b/app/src/main/java/org/mozilla/fenix/browser/BrowserFragment.kt
@@ -375,6 +375,10 @@ class BrowserFragment : Fragment(), BackHandler {
                 view.readerViewControlsBar
             ) {
                 getManagedEmitter<QuickActionChange>().apply {
+                    if (it) {
+                        requireComponents.analytics.metrics.track(Event.ReaderModeAvailable)
+                    }
+
                     onNext(QuickActionChange.ReadableStateChange(it))
                     onNext(
                         QuickActionChange.ReaderActiveStateChange(
@@ -527,11 +531,12 @@ class BrowserFragment : Fragment(), BackHandler {
                             } else {
                                 feature.showReaderView()
                                 actionEmitter.onNext(QuickActionChange.ReaderActiveStateChange(true))
+                                requireComponents.analytics.metrics.track(Event.ReaderModeOpened)
                             }
                         }
                     }
                     is QuickActionAction.ReadAppearancePressed -> {
-                        // TODO telemetry: https://github.com/mozilla-mobile/fenix/issues/2267
+                        requireComponents.analytics.metrics.track(Event.ReaderModeAppearanceOpened)
                         readerViewFeature.withFeature { feature ->
                             feature.showControls()
                         }

diff --git a/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt b/app/src/main/java/org/mozilla/fenix/components/metrics/Metrics.kt
@@ -98,6 +98,9 @@ sealed class Event {
     object HistoryItemOpened : Event()
     object HistoryItemRemoved : Event()
     object HistoryAllItemsRemoved : Event()
+    object ReaderModeAvailable : Event()
+    object ReaderModeOpened : Event()
+    object ReaderModeAppearanceOpened : Event()
 
     data class PreferenceToggled(val preferenceKey: String, val enabled: Boolean, val context: Context) : Event() {
         private val switchPreferenceTelemetryAllowList = listOf(

diff --git a/docs/metrics.md b/docs/metrics.md
@@ -705,7 +705,6 @@ tracking_protection</td>
 </table>
 </pre>
 
-
 ## history
 
 <pre>
@@ -762,6 +761,45 @@ tracking_protection</td>
 </pre>
 
 
+## reader_mode
+
+<pre>
+<table style="width: 100%">
+    <tr>
+        <th>key</th>
+        <th>type</th>
+        <th>description</th>
+        <th>data deview</th>
+        <th>extras</th>
+        <th>expires</th>
+    </tr>
+    <tr>
+        <td>available</td>
+        <td>event</td>
+        <td>Reader mode is available for the current page</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/3941">link</a></td>
+        <td></td>
+        <td>2020-03-01</td>
+    </tr>
+    <tr>
+        <td>opened</td>
+        <td>event</td>
+        <td>A user opened reader mode</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/3941">link</a></td>
+        <td></td>
+        <td>2020-03-01</td>
+    </tr>
+    <tr>
+        <td>appearance</td>
+        <td>event</td>
+        <td>A user tapped the appearance button</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/3941">link</a></td>
+        <td></td>
+        <td>2020-03-01</td>
+    </tr>
+</table>
+</pre>
+
 ## Metrics
 
 Items that are added to the metrics ping