From cce41afb7e45e037b868a82b3e5c80702c04bbf9 Mon Sep 17 00:00:00 2001
From: Jeff Boek <jeff@jeffboek.com>
Date: Tue, 11 Jun 2019 09:33:29 -0700
Subject: [PATCH] For #3351 - Adds docs for search_default_engine telemetry

---
 app/metrics.yaml |  6 +++---
 docs/metrics.md  | 36 +++++++++++++++++++++++++++++++++++-
 2 files changed, 38 insertions(+), 4 deletions(-)

diff --git a/app/metrics.yaml b/app/metrics.yaml
index bf50ce6ac..1867fa544 100644
--- a/app/metrics.yaml
+++ b/app/metrics.yaml
@@ -401,7 +401,7 @@ search.default_engine:
     bugs:
     - 800
     data_reviews:
-    - https://github.com/mozilla-mobile/fenix/issues/1607
+    - https://github.com/mozilla-mobile/fenix/pull/1606
     notification_emails:
     - fenix-core@mozilla.com
     expires: "2019-09-01"
@@ -417,7 +417,7 @@ search.default_engine:
     bugs:
     - 800
     data_reviews:
-    - https://github.com/mozilla-mobile/fenix/issues/1607
+    - https://github.com/mozilla-mobile/fenix/pull/1606
     notification_emails:
     - fenix-core@mozilla.com
     expires: "2019-09-01"
@@ -434,7 +434,7 @@ search.default_engine:
     bugs:
     - 800
     data_reviews:
-    - https://github.com/mozilla-mobile/fenix/issues/1607
+    - https://github.com/mozilla-mobile/fenix/pull/1606
     notification_emails:
     - fenix-core@mozilla.com
     expires: "2019-09-01"
diff --git a/docs/metrics.md b/docs/metrics.md
index 4250e0a65..b06486cfd 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -746,7 +746,41 @@ Items that are added to the metrics ping
         <td>default_moz_browser</td>
         <td>string</td>
         <td>The name of the default browser on device if and only if it's a Mozilla owned product, otherwise empty string</td>
-        <td><a href=https://github.com/mozilla-mobile/fenix/pull/1953/">link</a></td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/1953/">link</a></td>
+        <td></td>
+        <td>2019-09-01</td>
+    </tr>
+    <tr>
+        <td>search.default_engine.code</td>
+        <td>string</td>
+        <td>If the search engine is pre-loaded with Fenix this value
+      will be the search engine identifier. If it's a custom search engine
+      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
+      value will be "custom"</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/issues/1607">link</a></td>
+        <td></td>
+        <td>2019-09-01</td>
+    </tr>
+    <tr>
+        <td>search.default_engine.name</td>
+        <td>string</td>
+        <td>If the search engine is pre-loaded with Fenix this value
+      will be the search engine name. If it's a custom search engine
+      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
+      value will be "custom"</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/1953/">link</a></td>
+        <td></td>
+        <td>2019-09-01</td>
+    </tr>
+    <tr>
+        <td>search.default_engine.submission_url</td>
+        <td>string</td>
+        <td>If the search engine is pre-loaded with Fenix this value
+      will be he base URL we use to build the search query for the search engine.
+      For example: https://mysearchengine.com/?query=%s. If it's a custom search engine
+      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
+      value will be "custom"</td>
+        <td><a href="https://github.com/mozilla-mobile/fenix/pull/1953/">link</a></td>
         <td></td>
         <td>2019-09-01</td>
     </tr>