Bug 1148500 - Part 2 (Fx 40): Complete Telemetry pref documentation. r=dexter
authorGeorg Fritzsche <georg.fritzsche@googlemail.com>
Thu, 30 Apr 2015 14:00:58 +0200
changeset 273199 0df0d478d39641db7e3b3a567397f37ca270b09e
parent 273198 833051c87c7be1a34d716c51ab50a4431d248be9
child 273200 b2c68526576dfb6df05812b5432175b070ce6105
push id863
push userraliiev@mozilla.com
push dateMon, 03 Aug 2015 13:22:43 +0000
treeherdermozilla-release@f6321b14228d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdexter
bugs1148500
milestone40.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1148500 - Part 2 (Fx 40): Complete Telemetry pref documentation. r=dexter
toolkit/components/telemetry/docs/pings.rst
toolkit/components/telemetry/docs/preferences.rst
--- a/toolkit/components/telemetry/docs/pings.rst
+++ b/toolkit/components/telemetry/docs/pings.rst
@@ -40,18 +40,8 @@ Archiving
 When archiving is enabled through the relative preference, pings submitted to ``TelemetryController`` are also stored locally in the user profile directory, in `<profile-dir>/datareporting/archived`.
 
 To allow for cheaper lookup of archived pings, storage follows a specific naming scheme for both the directory and the ping file name: `<YYYY-MM>/<timestamp>.<UUID>.<type>.json`.
 
 * ``<YYYY-MM>`` - The subdirectory name, generated from the ping creation date.
 * ``<timestamp>`` - Timestamp of the ping creation date.
 * ``<UUID>`` - The ping identifier.
 * ``<type>`` - The ping type.
-
-Preferences
-===========
-
-Telemetry behaviour is controlled through the following preferences:
-
-* ``datareporting.healthreport.service.enabled`` - If true, records base Telemetry data. Otherwise, completely disables telemetry recording.
-* ``toolkit.telemetry.enabled`` - If true, record the extended Telemetry data. Please note that base Telemetry data needs to be enabled as well and we need to be in an official build or in test mode. This preference is controlled through the `Preferences` dialog.
-* ``datareporting.healthreport.uploadEnabled`` - Send the data we record if user has consented to FHR. This preference is controlled through the `Preferences` dialog.
-* ``toolkit.telemetry.archive.enabled`` - Allow pings to be archived locally.
--- a/toolkit/components/telemetry/docs/preferences.rst
+++ b/toolkit/components/telemetry/docs/preferences.rst
@@ -1,17 +1,41 @@
 Preferences
 ===========
 
-Telemetry behaviour is controlled through the following preferences:
+Telemetry behaviour is controlled through the preferences listed here.
+
+*Note:* On official builds (which define ``MOZILLA_OFFICIAL``), Telemetry is only initialized when ``MOZ_TELEMETRY_REPORTING`` is defined.
+Sending only happens on official builds with ``MOZ_TELEMETRY_REPORTING`` defined.
 
 ``toolkit.telemetry.unified``
 
   This controls whether unified behavior is enabled. If true:
 
   * Telemetry is always enabled and recording *base* data.
   * Telemetry will send additional ``main`` pings.
 
 ``toolkit.telemetry.enabled``
 
-  If unified is off, this controls whether the Telemetry module is enabled.
-  If unified is on, this controls whether to record *extended* data.
+  If ``unified`` is off, this controls whether the Telemetry module is enabled.
+  If ``unified`` is on, this controls whether to record *extended* data.
   This preference is controlled through the `Preferences` dialog.
+
+``datareporting.healthreport.uploadEnabled``
+
+  Send the data we record if user has consented to FHR. This preference is controlled through the `Preferences` dialog.
+
+``toolkit.telemetry.archive.enabled``
+
+  Allow pings to be archived locally. This can only be enabled if ``unified`` is on.
+
+``toolkit.telemetry.server``
+
+  The server Telemetry pings are sent to.
+
+``toolkit.telemetry.log.level``
+
+  This sets the Telemetry logging verbosity per ``Log.jsm``, with ``Trace`` or ``0`` being the most verbose and the default being ``Warn``.
+  By default logging goes only the console service.
+
+``toolkit.telemetry.log.dump``
+
+  Sets whether to dump Telemetry log messages to ``stdout`` too.