Bug 1359306 - Implant telemetry probe for search r=liuche,mconley

MozReview-Commit-ID: DoVIQbD92CA

--HG--
extra : rebase_source : e015755efbfd0e6808bec94e60564222aafab7e9

browser/components/preferences/in-content-new/findInPage.js

@@ -225,6 +225,11 @@ var gSearchResultsPane = {
     this.removeAllSearchTooltips();
     this.removeAllSearchMenuitemIndicators();
 
+    // Clear telemetry request if user types very frequently.
+    if (this.telemetryTimer) {
+      clearTimeout(this.telemetryTimer);
+    }
+
     let srHeader = document.getElementById("header-searchResults");
 
     if (this.query) {
@@ -274,6 +279,13 @@ var gSearchResultsPane = {
       } else {
         // Creating tooltips for all the instances found
         this.listSearchTooltips.forEach((anchorNode) => this.createSearchTooltip(anchorNode, this.query));
+
+        // Implant search telemetry probe after user stops typing for a while
+        if (this.query.length >= 2) {
+          this.telemetryTimer = setTimeout(() => {
+            Services.telemetry.keyedScalarAdd("preferences.search_query", this.query, 1);
+          }, 1000);
+        }
       }
     } else {
       document.getElementById("sorry-message").textContent = "";

toolkit/components/telemetry/Scalars.yaml

@@ -398,6 +398,21 @@ preferences:
     release_channel_collection: opt-out
     record_in_processes:
       - main
+  search_query:
+    bug_numbers:
+        - 1359306
+      description: >-
+        Each key is a search query string when user performs a search action within
+        about:preferences, and each value is the number of times that key is recorded.
+        The telemetry data will be recorded if there is a successful search result highlighted.
+      expires: "62"
+      kind: uint
+      keyed: true
+      notification_emails:
+        - chsiang@mozilla.com
+      release_channel_collection: opt-in
+      record_in_processes:
+        - main
 
 # The following section contains WebRTC nICEr scalars
 # For more info on ICE, see https://tools.ietf.org/html/rfc5245