From 902783819cbb2fd1607495dc8376a7f030d20dba Mon Sep 17 00:00:00 2001
From: Jeff Boek <jeff@jeffboek.com>
Date: Thu, 21 Mar 2019 23:05:28 -0700
Subject: [PATCH] Addresses metrics nits

---
 app/metrics.yaml  | 27 ++++++++++++++-------------
 docs/telemetry.md | 14 +-------------
 2 files changed, 15 insertions(+), 26 deletions(-)

diff --git a/app/metrics.yaml b/app/metrics.yaml
index 50acb00db1b3..f4a34102a8bd 100644
--- a/app/metrics.yaml
+++ b/app/metrics.yaml
@@ -1,8 +1,9 @@
-# This file defines the metrics that are recorded by glean telemetry. They are
-# automatically converted to Kotlin code at build time using the `glean_parser`
-# PyPI package.
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0
+
+  $schema: moz://mozilla.org/schemas/glean/metrics/1-0-0
 
 events:
   app_opened:
@@ -10,53 +11,53 @@ events:
     description: >
       A user opened the app
     extra_keys:
-      source: "The source from which the app was opened"
+      source: "The method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link`"
     bugs:
     - 968
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
-    expires: never
+    expires: "2020-03-01"
   search_bar_tapped:
     type: event
     description: >
       A user tapped the search bar
     extra_keys:
-      source: "The source from which the search bar was tapped"
+      source: "The view the user was on when they initiated the search (For example: `Home` or `Browser`)"
     bugs:
     - 959
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
-    expires: never
+    expires: "2020-03-01"
   entered_url:
     type: event
     description: >
       A user entered a url
     extra_keys:
-      autocomplete: "The url was filled by the autocomplete"
+      autocomplete: "A boolean that tells us whether the URL was autofilled by an Autocomplete suggestion"
     bugs:
     - 959
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
-    expires: never
+    expires: "2020-03-01"
   performed_search:
     type: event
     description: >
       A user performed a search
     extra_keys:
-      search_suggestion: "The search was initiated from a search suggestion"
+      search_suggestion: "A boolean that tells us whether or not the search term was suggested by the Awesomebar"
     bugs:
     - 959
     data_reviews:
     - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
     notification_emails:
     - telemetry-client-dev@mozilla.com
-    expires: never
+    expires: "2020-03-01"
 
 metrics:
   default_browser:
@@ -71,4 +72,4 @@ metrics:
     - 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
+    expires: "2020-03-01"
\ No newline at end of file
diff --git a/docs/telemetry.md b/docs/telemetry.md
index 152d8eed8517..19dd840a11ae 100644
--- a/docs/telemetry.md
+++ b/docs/telemetry.md
@@ -12,16 +12,4 @@ Fenix creates and tries to send a "baseline" ping. It is defined inside the [`me
 
 ## Events
 
-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
+Fenix sends event pings that allows us to measure feature performance. These are defined inside the It is defined inside the [`metrics.yaml`](https://github.com/mozilla-mobile/fenix/blob/master/app/metrics.yaml) file.