From 51e778ead5b3b4b54bc10f1b4d7120ccfbf33e51 Mon Sep 17 00:00:00 2001
From: Jeff Boek <jeff@jeffboek.com>
Date: Tue, 19 Mar 2019 14:58:49 -0700
Subject: [PATCH] Documents new telemetry events

---
 app/metrics.yaml  | 20 ++++++++++----------
 docs/telemetry.md | 22 ++++++++++++++++++----
 2 files changed, 28 insertions(+), 14 deletions(-)

diff --git a/app/metrics.yaml b/app/metrics.yaml
index e37db8934..50acb00db 100644
--- a/app/metrics.yaml
+++ b/app/metrics.yaml
@@ -12,9 +12,9 @@ events:
     extra_keys:
       source: "The source from which the app was opened"
     bugs:
-    - 123456789
+    - 968
     data_reviews:
-    - N/A
+    - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
     expires: never
@@ -25,9 +25,9 @@ events:
     extra_keys:
       source: "The source from which the search bar was tapped"
     bugs:
-    - 123456789
+    - 959
     data_reviews:
-    - N/A
+    - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
     expires: never
@@ -38,9 +38,9 @@ events:
     extra_keys:
       autocomplete: "The url was filled by the autocomplete"
     bugs:
-    - 123456789
+    - 959
     data_reviews:
-    - N/A
+    - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
     expires: never
@@ -51,9 +51,9 @@ events:
     extra_keys:
       search_suggestion: "The search was initiated from a search suggestion"
     bugs:
-    - 123456789
+    - 959
     data_reviews:
-    - N/A
+    - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
     expires: never
@@ -66,9 +66,9 @@ metrics:
     send_in_pings:
     - metrics
     bugs:
-    - 123456789
+    - 960
     data_reviews:
-    - N/A
+    - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
     expires: never
\ No newline at end of file
diff --git a/docs/telemetry.md b/docs/telemetry.md
index 8f06202ea..152d8eed8 100644
--- a/docs/telemetry.md
+++ b/docs/telemetry.md
@@ -4,10 +4,24 @@ Fenix uses Mozilla's telemetry service (Glean) and LeanPlum to measure feature p
 
 ## Baseline ping
 
-Fenix creates and tries to send a "baseline" ping when the app goes to the background. This baseline ping is defined by the [Glean](https://github.com/mozilla-mobile/android-components/tree/master/components/service/glean) component and [documented in the Android Components repository](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/docs/baseline.md).
+Fenix creates and tries to send a "baseline" ping when the app goes to the background. This baseline ping is defined by the [Glean](https://github.com/mozilla-mobile/android-components/tree/master/components/service/glean) component and [documented in the Android Components repository](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/docs/pings/baseline.md).
+
+## Metrics ping
+
+Fenix creates and tries to send a "baseline" ping. It is defined inside the [`metrics.yaml`](https://github.com/mozilla-mobile/fenix/blob/master/app/metrics.yaml) file. This ping includes things like wether or not Fenix is currently the default browser.
 
 ## Events
 
-| Event     | Glean Key | Leanplum Key | extras |
-|-----------|-----------|--------------|--------|
-| OpenedApp |           | E_Opened_App |        |
\ No newline at end of file
+Fenix sends event pings that allows us to measure feature performance.
+
+| Event           | Glean Key         | Leanplum Key | extras                |
+|-----------------|-------------------|--------------|-----------------------|
+| OpenedApp       | app_opened        | E_Opened_App | source*               |
+| SearchBarTapped | search_bar_tapped |              | source**              |
+| EnteredUrl      | entered_url       |              | autocomplete***       |
+| PerformedSearch | performed_search  |              | search_suggestion**** |
+
+* `source`: The method used to open Fenix (For exmaple: `app_icon` or `link`)
+** `source`: The view the user was on when they initiated the search (For example: `Home` or `Browser`)
+*** `autocomplete`: A boolean that tells us wether the URL was autofilled by an Autocomplete suggestion
+**** `search_suggestion`: A boolean that tells us wether or not the search term was suggested by the Awesomebar
\ No newline at end of file