Bug 1192359 - Add Telemetry for search suggestions being enabled. r=gfritzsche, a=sledru
authorDrew Willcoxon <adw@mozilla.com>
Thu, 27 Aug 2015 17:02:17 -0700
changeset 289023 3bb5c17c68568d4f9b2fe4e3715888926e588b1e
parent 289022 c850af52fbd84fc30a922eab459d38ae8b21b5d8
child 289024 88ef22723df67da787a0b1ac5a330f7e81d94916
push id5067
push userraliiev@mozilla.com
push dateMon, 21 Sep 2015 14:04:52 +0000
treeherdermozilla-beta@14221ffe5b2f [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgfritzsche, sledru
bugs1192359
milestone42.0a2
Bug 1192359 - Add Telemetry for search suggestions being enabled. r=gfritzsche, a=sledru
toolkit/components/telemetry/TelemetryEnvironment.jsm
toolkit/components/telemetry/docs/environment.rst
--- a/toolkit/components/telemetry/TelemetryEnvironment.jsm
+++ b/toolkit/components/telemetry/TelemetryEnvironment.jsm
@@ -96,18 +96,22 @@ const DEFAULT_ENVIRONMENT_PREFS = new Ma
   ["browser.cache.memory.enable", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.cache.offline.enable", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.formfill.enable", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.newtab.url", TelemetryEnvironment.RECORD_PREF_STATE],
   ["browser.newtabpage.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.newtabpage.enhanced", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.polaris.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.shell.checkDefaultBrowser", TelemetryEnvironment.RECORD_PREF_VALUE],
+  ["browser.search.suggest.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["browser.startup.homepage", TelemetryEnvironment.RECORD_PREF_STATE],
   ["browser.startup.page", TelemetryEnvironment.RECORD_PREF_VALUE],
+  ["browser.urlbar.suggest.searches", TelemetryEnvironment.RECORD_PREF_VALUE],
+  ["browser.urlbar.unifiedcomplete", TelemetryEnvironment.RECORD_PREF_VALUE],
+  ["browser.urlbar.userMadeSearchSuggestionsChoice", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["devtools.chrome.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["devtools.debugger.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["devtools.debugger.remote-enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["dom.ipc.plugins.asyncInit", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["dom.ipc.plugins.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["experiments.manifest.uri", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["extensions.blocklist.enabled", TelemetryEnvironment.RECORD_PREF_VALUE],
   ["extensions.blocklist.url", TelemetryEnvironment.RECORD_PREF_VALUE],
--- a/toolkit/components/telemetry/docs/environment.rst
+++ b/toolkit/components/telemetry/docs/environment.rst
@@ -270,8 +270,25 @@ The object contains:
   For privacy, we don't record this for user-installed engines.
 
 ``loadPath`` and ``submissionURL`` are not present if ``name`` is ``NONE``.
 
 searchCohort
 ~~~~~~~~~~~~
 
 If the user has been enrolled into a search default change experiment, this contains the string identifying the experiment the user is taking part in. Most user profiles will never be part of any search default change experiment, and will not send this value.
+
+userPrefs
+~~~~~~~~~
+
+This object contains user preferences.
+
+Each key in the object is the name of a preference. A key's value depends on the policy with which the preference was collected. There are two such policies, "value" and "state". For preferences collected under the "value" policy, the value will be the preference's value. For preferences collected under the "state" policy, the value will be an opaque marker signifying only that the preference has a user value. The "state" policy is therefore used when user privacy is a concern.
+
+The following is a partial list of collected preferences.
+
+- ``browser.search.suggest.enabled``: The "master switch" for search suggestions everywhere in Firefox (search bar, urlbar, etc.). Defaults to true.
+
+- ``browser.urlbar.suggest.searches``: True if search suggestions are enabled in the urlbar. Defaults to false.
+
+- ``browser.urlbar.unifiedcomplete``: True if the urlbar's UnifiedComplete back-end is enabled.
+
+- ``browser.urlbar.userMadeSearchSuggestionsChoice``: True if the user has clicked Yes or No in the urlbar's opt-in notification. Defaults to false.