Add m-esr52 at 52.6.0

11 files changed, 1709 insertions, 0 deletions

diff --git a/toolkit/components/telemetry/docs/data/addons-malware-ping.rst b/toolkit/components/telemetry/docs/data/addons-malware-ping.rst
new file mode 100644
index 000000000..18502d748
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/addons-malware-ping.rst
@@ -0,0 +1,42 @@
+
+Add-ons malware ping
+====================
+
+This ping is generated by an add-on created by Mozilla and shipped to users on older versions of Firefox (44-46). The ping contains information about the profile that might have been altered by a third party malicious add-on.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: "malware-addon-states",
+      ...
+      clientId: <UUID>,
+      environment: { ... },
+      // Common ping data.
+      payload: {
+        // True if the blocklist was disabled at startup time.
+        blocklistDisabled: <bool>,
+        // True if the malicious add-on exists and is enabled. False if it
+        // exists and is disabled or null if the add-on was not found.
+        mainAddonActive: <bool | null>,
+        // A value of the malicious add-on block list state, or null if the
+        // add-on was not found.
+        mainAddonBlocked: <int | null>,
+        // True if a malicious user.js file was found in the profile.
+        foundUserJS: <bool>,
+        // If a malicious secmodd.db file was found the extension ID that the // file contained..
+        secmoddAddon: <string | null>, .
+        // A list of IDs for extensions which were hidden by malicious CSS.
+        hiddenAddons: [
+          <string>,
+          ...
+        ],
+        // A mapping of installed add-on IDs with known malicious
+        // update URL patterns to their exact update URLs.
+        updateURLs: {
+          <extensionID>: <updateURL>,
+          ...
+        }
+      }
+    }
diff --git a/toolkit/components/telemetry/docs/data/common-ping.rst b/toolkit/components/telemetry/docs/data/common-ping.rst
new file mode 100644
index 000000000..445557efd
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/common-ping.rst
@@ -0,0 +1,42 @@
+
+Common ping format
+==================
+
+This defines the top-level structure of a Telemetry ping.
+It contains basic information shared between different ping types, which enables proper storage and processing of the raw pings server-side.
+
+It also contains optional further information:
+
+* the :doc:`environment data <../data/environment>`, which contains important info to correlate the measurements against
+* the ``clientId``, a UUID identifying a profile and allowing user-oriented correlation of data
+
+*Note:* Both are not submitted with all ping types due to privacy concerns. This and the data it that can be correlated against is inspected under the `data collection policy <https://wiki.mozilla.org/Firefox/Data_Collection>`_.
+
+Finally, the structure also contains the `payload`, which is the specific data submitted for the respective *ping type*.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: <string>, // "main", "activation", "deletion", "saved-session", ...
+      id: <UUID>, // a UUID that identifies this ping
+      creationDate: <ISO date>, // the date the ping was generated
+      version: <number>, // the version of the ping format, currently 4
+
+      application: {
+        architecture: <string>, // build architecture, e.g. x86
+        buildId: <string>, // "20141126041045"
+        name: <string>, // "Firefox"
+        version: <string>, // "35.0"
+        displayVersion: <string>, // "35.0b3"
+        vendor: <string>, // "Mozilla"
+        platformVersion: <string>, // "35.0"
+        xpcomAbi: <string>, // e.g. "x86-msvc"
+        channel: <string>, // "beta"
+      },
+
+      clientId: <UUID>, // optional
+      environment: { ... }, // optional, not all pings contain the environment
+      payload: { ... }, // the actual payload data for this ping type
+    }
diff --git a/toolkit/components/telemetry/docs/data/core-ping.rst b/toolkit/components/telemetry/docs/data/core-ping.rst
new file mode 100644
index 000000000..7f38f2f7e
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/core-ping.rst
@@ -0,0 +1,191 @@
+
+"core" ping
+============
+
+This mobile-specific ping is intended to provide the most critical
+data in a concise format, allowing for frequent uploads.
+
+Since this ping is used to measure retention, it should be sent
+each time the browser is opened.
+
+Submission will be per the Edge server specification::
+
+    /submit/telemetry/docId/docType/appName/appVersion/appUpdateChannel/appBuildID
+
+* ``docId`` is a UUID for deduping
+* ``docType`` is “core”
+* ``appName`` is “Fennec”
+* ``appVersion`` is the version of the application (e.g. "46.0a1")
+* ``appUpdateChannel`` is “release”, “beta”, etc.
+* ``appBuildID`` is the build number
+
+Note: Counts below (e.g. search & usage times) are “since the last
+ping”, not total for the whole application lifetime.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      "v": 7, // ping format version
+      "clientId": <string>, // client id, e.g.
+                            // "c641eacf-c30c-4171-b403-f077724e848a"
+      "seq": <positive integer>, // running ping counter, e.g. 3
+      "locale": <string>, // application locale, e.g. "en-US"
+      "os": <string>, // OS name.
+      "osversion": <string>, // OS version.
+      "device": <string>, // Build.MANUFACTURER + " - " + Build.MODEL
+                          // where manufacturer is truncated to 12 characters
+                          // & model is truncated to 19 characters
+      "arch": <string>, // e.g. "arm", "x86"
+      "profileDate": <pos integer>, // Profile creation date in days since
+                                    // UNIX epoch.
+      "defaultSearch": <string>, // Identifier of the default search engine,
+                                 // e.g. "yahoo".
+      "distributionId": <string>, // Distribution identifier (optional)
+      "created": <string>, // date the ping was created
+                           // in local time, "yyyy-mm-dd"
+      "tz": <integer>, // timezone offset (in minutes) of the
+                       // device when the ping was created
+      "sessions": <integer>, // number of sessions since last upload
+      "durations": <integer>, // combined duration, in seconds, of all
+                                    // sessions since last upload
+      "searches": <object>, // Optional, object of search use counts in the
+                            // format: { "engine.source": <pos integer> }
+                            // e.g.: { "yahoo.suggestion": 3, "other.listitem": 1 }
+      "experiments": [<string>, /* … */], // Optional, array of identifiers
+                                    // for the active experiments
+    }
+
+Field details
+-------------
+
+device
+~~~~~~
+The ``device`` field is filled in with information specified by the hardware
+manufacturer. As such, it could be excessively long and use excessive amounts
+of limited user data. To avoid this, we limit the length of the field. We're
+more likely have collisions for models within a manufacturer (e.g. "Galaxy S5"
+vs. "Galaxy Note") than we are for shortened manufacturer names so we provide
+more characters for the model than the manufacturer.
+
+distributionId
+~~~~~~~~~~~~~~
+The ``distributionId`` contains the distribution ID as specified by
+preferences.json for a given distribution. More information on distributions
+can be found `here <https://wiki.mozilla.org/Mobile/Distribution_Files>`_.
+
+It is optional.
+
+defaultSearch
+~~~~~~~~~~~~~
+On Android, this field may be ``null``. To get the engine, we rely on
+``SearchEngineManager#getDefaultEngine``, which searches in several places in
+order to find the search engine identifier:
+
+* Shared Preferences
+* The distribution (if it exists)
+* The localized default engine
+
+If the identifier could not be retrieved, this field is ``null``. If the
+identifier is retrieved, we attempt to create an instance of the search
+engine from the search plugins (in order):
+
+* In the distribution
+* From the localized plugins shipped with the browser
+* The third-party plugins that are installed in the profile directory
+
+If the plugins fail to create a search engine instance, this field is also
+``null``.
+
+This field can also be ``null`` when a custom search engine is set as the
+default.
+
+sessions & durations
+~~~~~~~~~~~~~~~~~~~~
+On Android, a session is the time when Firefox is focused in the foreground.
+`sessions` tracks the number of sessions since the last upload and
+`durations` is the accumulated duration in seconds of all of these
+sessions. Note that showing a dialog (including a Firefox dialog) will
+take Firefox out of focus & end the current session.
+
+An implementation that records a session when Firefox is completely hidden is
+preferrable (e.g. to avoid the dialog issue above), however, it's more complex
+to implement and so we chose not to, at least for the initial implementation.
+
+profileDate
+~~~~~~~~~~~
+On Android, this value is created at profile creation time and retrieved or,
+for legacy profiles, taken from the package install time (note: this is not the
+same exact metric as profile creation time but we compromised in favor of ease
+of implementation).
+
+Additionally on Android, this field may be ``null`` in the unlikely event that
+all of the following events occur:
+
+#. The times.json file does not exist
+#. The package install date could not be persisted to disk
+
+The reason we don't just return the package install time even if the date could
+not be persisted to disk is to ensure the value doesn't change once we start
+sending it: we only want to send consistent values.
+
+searches
+~~~~~~~~
+In the case a search engine is added by a user, the engine identifier "other" is used, e.g. "other.<source>".
+
+Sources in Android are based on the existing UI telemetry values and are as
+follows:
+
+* actionbar: the user types in the url bar and hits enter to use the default
+  search engine
+* listitem: the user selects a search engine from the list of secondary search
+  engines at the bottom of the screen
+* suggestion: the user clicks on a search suggestion or, in the case that
+  suggestions are disabled, the row corresponding with the main engine
+
+Other parameters
+----------------
+
+HTTP "Date" header
+~~~~~~~~~~~~~~~~~~
+This header is used to track the submission date of the core ping in the format
+specified by
+`rfc 2616 sec 14.18 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18>`_,
+et al (e.g. "Tue, 01 Feb 2011 14:00:00 GMT").
+
+
+Version history
+---------------
+* v7: added ``sessionCount`` & ``sessionDuration``
+* v6: added ``searches``
+* v5: added ``created`` & ``tz``
+* v4: ``profileDate`` will return package install time when times.json is not available
+* v3: added ``defaultSearch``
+* v2: added ``distributionId``
+* v1: initial version
+
+Notes
+~~~~~
+
+* ``distributionId`` (v2) actually landed after ``profileDate`` (v4) but was
+  uplifted to 46, whereas ``profileDate`` landed on 47. The version numbers in
+  code were updated to be increasing (bug 1264492) and the version history docs
+  rearranged accordingly.
+
+Android implementation notes
+----------------------------
+On Android, the uploader has a high probability of delivering the complete data
+for a given client but not a 100% probability. This was a conscious decision to
+keep the code simple. The cases where we can lose data:
+
+* Resetting the field measurements (including incrementing the sequence number)
+  and storing a ping for upload are not atomic. Android can kill our process
+  for memory pressure in between these distinct operations so we can just lose
+  a ping's worth of data. That sequence number will be missing on the server.
+* If we exceed some number of pings on disk that have not yet been uploaded,
+  we remove old pings to save storage space. For those pings, we will lose
+  their data and their sequence numbers will be missing on the server.
+
+Note: we never expect to drop data without also dropping a sequence number so
+we are able to determine when data loss occurs.
diff --git a/toolkit/components/telemetry/docs/data/crash-ping.rst b/toolkit/components/telemetry/docs/data/crash-ping.rst
new file mode 100644
index 000000000..3cdbc6030
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/crash-ping.rst
@@ -0,0 +1,144 @@
+
+"crash" ping
+============
+
+This ping is captured after the main Firefox process crashes, whether or not the crash report is submitted to crash-stats.mozilla.org. It includes non-identifying metadata about the crash.
+
+The environment block that is sent with this ping varies: if Firefox was running long enough to record the environment block before the crash, then the environment at the time of the crash will be recorded and ``hasCrashEnvironment`` will be true. If Firefox crashed before the environment was recorded, ``hasCrashEnvironment`` will be false and the recorded environment will be the environment at time of submission.
+
+The client ID is submitted with this ping.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      version: 1,
+      type: "crash",
+      ... common ping data
+      clientId: <UUID>,
+      environment: { ... },
+      payload: {
+        crashDate: "YYYY-MM-DD",
+        sessionId: <UUID>, // may be missing for crashes that happen early
+                           // in startup. Added in Firefox 48 with the
+                           // intention of uplifting to Firefox 46
+        crashId: <UUID>, // Optional, ID of the associated crash
+        stackTraces: { ... }, // Optional, see below
+        metadata: { // Annotations saved while Firefox was running. See nsExceptionHandler.cpp for more information
+          ProductName: "Firefox",
+          ReleaseChannel: <channel>,
+          Version: <version number>,
+          BuildID: "YYYYMMDDHHMMSS",
+          AvailablePageFile: <size>, // Windows-only, available paging file
+          AvailablePhysicalMemory: <size>, // Windows-only, available physical memory
+          AvailableVirtualMemory: <size>, // Windows-only, available virtual memory
+          BlockedDllList: <list>, // Windows-only, see WindowsDllBlocklist.cpp for details
+          BlocklistInitFailed: 1, // Windows-only, present only if the DLL blocklist initialization failed
+          CrashTime: <time>, // Seconds since the Epoch
+          ContainsMemoryReport: 1, // Optional
+          EventLoopNestingLevel: <levels>, // Optional, present only if >0
+          IsGarbageCollecting: 1, // Optional, present only if set to 1
+          MozCrashReason: <reason>, // Optional, contains the string passed to MOZ_CRASH()
+          OOMAllocationSize: <size>, // Size of the allocation that caused an OOM
+          SecondsSinceLastCrash: <duration>, // Seconds elapsed since the last crash occurred
+          SystemMemoryUsePercentage: <percentage>, // Windows-only, percent of memory in use
+          TelemetrySessionId: <id>, // Active telemetry session ID when the crash was recorded
+          TextureUsage: <usage>, // Optional, usage of texture memory in bytes
+          TotalPageFile: <size>, // Windows-only, paging file in use
+          TotalPhysicalMemory: <size>, // Windows-only, physical memory in use
+          TotalVirtualMemory: <size>, // Windows-only, virtual memory in use
+          UptimeTS: <duration>, // Seconds since Firefox was started
+          User32BeforeBlocklist: 1, // Windows-only, present only if user32.dll was loaded before the DLL blocklist has been initialized
+        },
+        hasCrashEnvironment: bool
+      }
+    }
+
+Stack Traces
+------------
+
+The crash ping may contain a ``stackTraces`` field which has been populated
+with stack traces for all threads in the crashed process. The format of this
+field is similar to the one used by Socorro for representing a crash. The main
+differences are that redundant fields are not stored and that the module a
+frame belongs to is referenced by index in the module array rather than by its
+file name.
+
+Note that this field does not contain data from the application; only bare
+stack traces and module lists are stored.
+
+.. code-block:: js
+
+    {
+      status: <string>, // Status of the analysis, "OK" or an error message
+      crash_info: { // Basic crash information
+        type: <string>, // Type of crash, SIGSEGV, assertion, etc...
+        address: <addr>, // Crash address crash, hex format, see the notes below
+        crashing_thread: <index> // Index in the thread array below
+      },
+      main_module: <index>, // Index of Firefox' executable in the module list
+      modules: [{
+        base_addr: <addr>, // Base address of the module, hex format
+        end_addr: <addr>, // End address of the module, hex format
+        code_id: <string>, // Unique ID of this module, see the notes below
+        debug_file: <string>, // Name of the file holding the debug information
+        debug_id: <string>, // ID or hash of the debug information file
+        filename: <string>, // File name
+        version: <string>, // Library/executable version
+      },
+      ... // List of modules ordered by base memory address
+      ],
+      threads: [{ // Stack traces for every thread
+        frames: [{
+          module_index: <index>, // Index of the module this frame belongs to
+          ip: <ip>, // Program counter, hex format
+          trust: <string> // Trust of this frame, see the notes below
+        },
+        ... // List of frames, the first frame is the topmost
+        ]
+      }]
+    }
+
+Notes
+~~~~~
+
+Memory addresses and instruction pointers are always stored as strings in
+hexadecimal format (e.g. "0x4000"). They can be made of up to 16 characters for
+64-bit addresses.
+
+The crash type is both OS and CPU dependent and can be either a descriptive
+string (e.g. SIGSEGV, EXCEPTION_ACCESS_VIOLATION) or a raw numeric value. The
+crash address meaning depends on the type of crash. In a segmentation fault the
+crash address will be the memory address whose access caused the fault; in a
+crash triggered by an illegal instruction exception the address will be the
+instruction pointer where the invalid instruction resides.
+See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/c99d374dde62654a024840accfb357b2851daea0/src/processor/minidump_processor.cc#675>`_'s
+relevant code for further information.
+
+Since it's not always possible to establish with certainty the address of the
+previous frame while walking the stack, every frame has a trust value that
+represents how it was found and thus how certain we are that it's a real frame.
+The trust levels are (from least trusted to most trusted):
+
++---------------+---------------------------------------------------+
+| Trust         | Description                                       |
++===============+===================================================+
+| context       | Given as instruction pointer in a context         |
++---------------+---------------------------------------------------+
+| prewalked     | Explicitly provided by some external stack walker |
++---------------+---------------------------------------------------+
+| cfi           | Derived from call frame info                      |
++---------------+---------------------------------------------------+
+| frame_pointer | Derived from frame pointer                        |
++---------------+---------------------------------------------------+
+| cfi_scan      | Found while scanning stack using call frame info  |
++---------------+---------------------------------------------------+
+| scan          | Scanned the stack, found this                     |
++---------------+---------------------------------------------------+
+| none          | Unknown, this is most likely not a valid frame    |
++---------------+---------------------------------------------------+
+
+The ``code_id`` field holds a unique ID used to distinguish between different
+versions and builds of the same module. See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/24f5931c5e0120982c0cbf1896641e3ef2bdd52f/src/google_breakpad/processor/code_module.h#60>`_'s
+description for further information. This field is populated only on Windows.
diff --git a/toolkit/components/telemetry/docs/data/deletion-ping.rst b/toolkit/components/telemetry/docs/data/deletion-ping.rst
new file mode 100644
index 000000000..c4523ce54
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/deletion-ping.rst
@@ -0,0 +1,19 @@
+
+"deletion" ping
+===============
+
+This ping is generated when a user turns off FHR upload from the Preferences panel, changing the related ``datareporting.healthreport.uploadEnabled`` preference. This requests that all associated data from that user be deleted.
+
+This ping contains the client id and no environment data.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      version: 4,
+      type: "deletion",
+      ... common ping data
+      clientId: <UUID>,
+      payload: { }
+    }
\ No newline at end of file
diff --git a/toolkit/components/telemetry/docs/data/environment.rst b/toolkit/components/telemetry/docs/data/environment.rst
new file mode 100644
index 000000000..ff0d204a4
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/environment.rst
@@ -0,0 +1,373 @@
+
+Environment
+===========
+
+The environment consists of data that is expected to be characteristic for performance and other behavior and not expected to change too often.
+
+Changes to most of these data points are detected (where possible and sensible) and will lead to a session split in the :doc:`main-ping`.
+The environment data may also be submitted by other ping types.
+
+*Note:* This is not submitted with all ping types due to privacy concerns. This and other data is inspected under the `data collection policy <https://wiki.mozilla.org/Firefox/Data_Collection>`_.
+
+Some parts of the environment must be fetched asynchronously at startup. We don't want other Telemetry components to block on waiting for the environment, so some items may be missing from it until the async fetching finished.
+This currently affects the following sections:
+
+- profile
+- addons
+
+
+Structure:
+
+.. code-block:: js
+
+    {
+      build: {
+        applicationId: <string>, // nsIXULAppInfo.ID
+        applicationName: <string>, // "Firefox"
+        architecture: <string>, // e.g. "x86", build architecture for the active build
+        architecturesInBinary: <string>, // e.g. "i386-x86_64", from nsIMacUtils.architecturesInBinary, only present for mac universal builds
+        buildId: <string>, // e.g. "20141126041045"
+        version: <string>, // e.g. "35.0"
+        vendor: <string>, // e.g. "Mozilla"
+        platformVersion: <string>, // e.g. "35.0"
+        xpcomAbi: <string>, // e.g. "x86-msvc"
+        hotfixVersion: <string>, // e.g. "20141211.01"
+      },
+      settings: {
+        addonCompatibilityCheckEnabled: <bool>, // Whether application compatibility is respected for add-ons
+        blocklistEnabled: <bool>, // true on failure
+        isDefaultBrowser: <bool>, // null on failure, not available on Android
+        defaultSearchEngine: <string>, // e.g. "yahoo"
+        defaultSearchEngineData: {, // data about the current default engine
+          name: <string>, // engine name, e.g. "Yahoo"; or "NONE" if no default
+          loadPath: <string>, // where the engine line is located; missing if no default
+          origin: <string>, // 'default', 'verified', 'unverified', or 'invalid'; based on the presence and validity of the engine's loadPath verification hash.
+          submissionURL: <string> // missing if no default or for user-installed engines
+        },
+        searchCohort: <string>, // optional, contains an identifier for any active search A/B experiments
+        e10sEnabled: <bool>, // whether e10s is on, i.e. browser tabs open by default in a different process
+        e10sCohort: <string>, // which e10s cohort was assigned for this user
+        telemetryEnabled: <bool>, // false on failure
+        locale: <string>, // e.g. "it", null on failure
+        update: {
+          channel: <string>, // e.g. "release", null on failure
+          enabled: <bool>, // true on failure
+          autoDownload: <bool>, // true on failure
+        },
+        userPrefs: {
+          // Only prefs which are changed from the default value are listed
+          // in this block
+          "pref.name.value": value // some prefs send the value
+          "pref.name.url": "<user-set>" // For some privacy-sensitive prefs
+            // only the fact that the value has been changed is recorded
+        },
+        attribution: { // optional, only present if the installation has attribution data
+          // all of these values are optional.
+          source: <string>, // referring partner domain, when install happens via a known partner
+          medium: <string>, // category of the source, such as "organic" for a search engine
+          campaign: <string>, // identifier of the particular campaign that led to the download of the product
+          content: <string>, // identifier to indicate the particular link within a campaign
+        },
+      },
+      profile: {
+        creationDate: <integer>, // integer days since UNIX epoch, e.g. 16446
+        resetDate: <integer>, // integer days since UNIX epoch, e.g. 16446 - optional
+      },
+      partner: { // This section may not be immediately available on startup
+        distributionId: <string>, // pref "distribution.id", null on failure
+        distributionVersion: <string>, // pref "distribution.version", null on failure
+        partnerId: <string>, // pref mozilla.partner.id, null on failure
+        distributor: <string>, // pref app.distributor, null on failure
+        distributorChannel: <string>, // pref app.distributor.channel, null on failure
+        partnerNames: [
+          // list from prefs app.partner.<name>=<name>
+        ],
+      },
+      system: {
+        memoryMB: <number>,
+        virtualMaxMB: <number>, // windows-only
+        isWow64: <bool>, // windows-only
+        cpu: {
+            count: <number>,  // desktop only, e.g. 8, or null on failure - logical cpus
+            cores: <number>, // desktop only, e.g., 4, or null on failure - physical cores
+            vendor: <string>, // desktop only, e.g. "GenuineIntel", or null on failure
+            family: <number>, // desktop only, null on failure
+            model: <number, // desktop only, null on failure
+            stepping: <number>, // desktop only, null on failure
+            l2cacheKB: <number>, // L2 cache size in KB, only on windows & mac
+            l3cacheKB: <number>, // desktop only, L3 cache size in KB
+            speedMHz: <number>, // desktop only, cpu clock speed in MHz
+            extensions: [
+              <string>,
+              ...
+              // as applicable:
+              // "MMX", "SSE", "SSE2", "SSE3", "SSSE3", "SSE4A", "SSE4_1",
+              // "SSE4_2", "AVX", "AVX2", "EDSP", "ARMv6", "ARMv7", "NEON"
+            ],
+        },
+        device: { // This section is only available on mobile devices.
+          model: <string>, // the "device" from FHR, null on failure
+          manufacturer: <string>, // null on failure
+          hardware: <string>, // null on failure
+          isTablet: <bool>, // null on failure
+        },
+        os: {
+            name: <string>, // "Windows_NT" or null on failure
+            version: <string>, // e.g. "6.1", null on failure
+            kernelVersion: <string>, // android/b2g only or null on failure
+            servicePackMajor: <number>, // windows only or null on failure
+            servicePackMinor: <number>, // windows only or null on failure
+            windowsBuildNumber: <number>, // windows 10 only or null on failure
+            windowsUBR: <number>, // windows 10 only or null on failure
+            installYear: <number>, // windows only or null on failure
+            locale: <string>, // "en" or null on failure
+        },
+        hdd: {
+          profile: { // hdd where the profile folder is located
+              model: <string>, // windows only or null on failure
+              revision: <string>, // windows only or null on failure
+          },
+          binary:  { // hdd where the application binary is located
+              model: <string>, // windows only or null on failure
+              revision: <string>, // windows only or null on failure
+          },
+          system:  { // hdd where the system files are located
+              model: <string>, // windows only or null on failure
+              revision: <string>, // windows only or null on failure
+          },
+        },
+        gfx: {
+            D2DEnabled: <bool>, // null on failure
+            DWriteEnabled: <bool>, // null on failure
+            //DWriteVersion: <string>, // temporarily removed, pending bug 1154500
+            adapters: [
+              {
+                description: <string>, // e.g. "Intel(R) HD Graphics 4600", null on failure
+                vendorID: <string>, // null on failure
+                deviceID: <string>, // null on failure
+                subsysID: <string>, // null on failure
+                RAM: <number>, // in MB, null on failure
+                driver: <string>, // null on failure
+                driverVersion: <string>, // null on failure
+                driverDate: <string>, // null on failure
+                GPUActive: <bool>, // currently always true for the first adapter
+              },
+              ...
+            ],
+            // Note: currently only added on Desktop. On Linux, only a single
+            // monitor is returned representing the entire virtual screen.
+            monitors: [
+              {
+                screenWidth: <number>,  // screen width in pixels
+                screenHeight: <number>, // screen height in pixels
+                refreshRate: <number>,  // refresh rate in hertz (present on Windows only).
+                                        //  (values <= 1 indicate an unknown value)
+                pseudoDisplay: <bool>,  // networked screen (present on Windows only)
+                scale: <number>,        // backing scale factor (present on Mac only)
+              },
+              ...
+            ],
+            features: {
+              compositor: <string>,     // Layers backend for compositing (eg "d3d11", "none", "opengl")
+
+              // Each the following features can have one of the following statuses:
+              //   "unused"      - This feature has not been requested.
+              //   "unavailable" - Safe Mode or OS restriction prevents use.
+              //   "blocked"     - Blocked due to an internal condition such as safe mode.
+              //   "blacklisted" - Blocked due to a blacklist restriction.
+              //   "disabled"    - User explicitly disabled this default feature.
+              //   "failed"      - This feature was attempted but failed to initialize.
+              //   "available"   - User has this feature available.
+              "d3d11" { // This feature is Windows-only.
+                status: <string>,
+                warp: <bool>,           // Software rendering (WARP) mode was chosen.
+                textureSharing: <bool>  // Whether or not texture sharing works.
+                version: <number>,      // The D3D11 device feature level.
+                blacklisted: <bool>,    // Whether D3D11 is blacklisted; use to see whether WARP
+                                        // was blacklist induced or driver-failure induced.
+              },
+              "d2d" { // This feature is Windows-only.
+                status: <string>,
+                version: <string>,      // Either "1.0" or "1.1".
+              },
+            },
+          },
+      },
+      addons: {
+        activeAddons: { // the currently enabled addons
+          <addon id>: {
+            blocklisted: <bool>,
+            description: <string>, // null if not available
+            name: <string>,
+            userDisabled: <bool>,
+            appDisabled: <bool>,
+            version: <string>,
+            scope: <integer>,
+            type: <string>, // "extension", "service", ...
+            foreignInstall: <bool>,
+            hasBinaryComponents: <bool>
+            installDay: <number>, // days since UNIX epoch, 0 on failure
+            updateDay: <number>, // days since UNIX epoch, 0 on failure
+            signedState: <integer>, // whether the add-on is signed by AMO, only present for extensions
+            isSystem: <bool>, // true if this is a System Add-on
+          },
+          ...
+        },
+        theme: { // the active theme
+          id: <string>,
+          blocklisted: <bool>,
+          description: <string>,
+          name: <string>,
+          userDisabled: <bool>,
+          appDisabled: <bool>,
+          version: <string>,
+          scope: <integer>,
+          foreignInstall: <bool>,
+          hasBinaryComponents: <bool>
+          installDay: <number>, // days since UNIX epoch, 0 on failure
+          updateDay: <number>, // days since UNIX epoch, 0 on failure
+        },
+        activePlugins: [
+          {
+            name: <string>,
+            version: <string>,
+            description: <string>,
+            blocklisted: <bool>,
+            disabled: <bool>,
+            clicktoplay: <bool>,
+            mimeTypes: [<string>, ...],
+            updateDay: <number>, // days since UNIX epoch, 0 on failure
+          },
+          ...
+        ],
+        activeGMPlugins: {
+            <gmp id>: {
+                version: <string>,
+                userDisabled: <bool>,
+                applyBackgroundUpdates: <integer>,
+            },
+            ...
+        },
+        activeExperiment: { // section is empty if there's no active experiment
+            id: <string>, // id
+            branch: <string>, // branch name
+        },
+        persona: <string>, // id of the current persona, null on GONK
+      },
+    }
+
+build
+-----
+
+buildId
+~~~~~~~
+Firefox builds downloaded from mozilla.org use a 14-digit buildId. Builds included in other distributions may have a different format (e.g. only 10 digits).
+
+Settings
+--------
+
+defaultSearchEngine
+~~~~~~~~~~~~~~~~~~~
+Note: Deprecated, use defaultSearchEngineData instead.
+
+Contains the string identifier or name of the default search engine provider. This will not be present in environment data collected before the Search Service initialization.
+
+The special value ``NONE`` could occur if there is no default search engine.
+
+The special value ``UNDEFINED`` could occur if a default search engine exists but its identifier could not be determined.
+
+This field's contents are ``Services.search.defaultEngine.identifier`` (if defined) or ``"other-"`` + ``Services.search.defaultEngine.name`` if not. In other words, search engines without an ``.identifier`` are prefixed with ``other-``.
+
+defaultSearchEngineData
+~~~~~~~~~~~~~~~~~~~~~~~
+Contains data identifying the engine currently set as the default.
+
+The object contains:
+
+- a ``name`` property with the name of the engine, or ``NONE`` if no
+  engine is currently set as the default.
+
+- a ``loadPath`` property: an anonymized path of the engine xml file, e.g.
+  jar:[app]/omni.ja!browser/engine.xml
+  (where 'browser' is the name of the chrome package, not a folder)
+  [profile]/searchplugins/engine.xml
+  [distribution]/searchplugins/common/engine.xml
+  [other]/engine.xml
+
+- an ``origin`` property: the value will be ``default`` for engines that are built-in or from distribution partners, ``verified`` for user-installed engines with valid verification hashes, ``unverified`` for non-default engines without verification hash, and ``invalid`` for engines with broken verification hashes.
+
+- a ``submissionURL`` property with the HTTP url we would use to search.
+  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.userMadeSearchSuggestionsChoice``: True if the user has clicked Yes or No in the urlbar's opt-in notification. Defaults to false.
+
+- ``browser.zoom.full``: True if zoom is enabled for both text and images, that is if "Zoom Text Only" is not enabled. Defaults to true. Collection of this preference has been enabled in Firefox 50 and will be disabled again in Firefox 53 (`Bug 979323 <https://bugzilla.mozilla.org/show_bug.cgi?id=979323>`_).
+
+- ``security.sandbox.content.level``: The meanings of the values are OS dependent, but 0 means not sandboxed for all OS. Details of the meanings can be found in the `Firefox prefs file <http://hg.mozilla.org/mozilla-central/file/tip/browser/app/profile/firefox.js>`_.
+
+attribution
+~~~~~~~~~~~
+
+This object contains the attribution data for the product installation.
+
+Attribution data is used to link installations of Firefox with the source that the user arrived at the Firefox download page from. It would indicate, for instance, when a user executed a web search for Firefox and arrived at the download page from there, directly navigated to the site, clicked on a link from a particular social media campaign, etc.
+
+The attribution data is included in some versions of the default Firefox installer for Windows (the "stub" installer) and stored as part of the installation. All platforms other than Windows and also Windows installations that did not use the stub installer do not have this data and will not include the ``attribution`` object.
+
+partner
+-------
+
+If the user is using a partner repack, this contains information identifying the repack being used, otherwise "partnerNames" will be an empty array and other entries will be null. The information may be missing when the profile just becomes available. In Firefox for desktop, the information along with other customizations defined in distribution.ini are processed later in the startup phase, and will be fully applied when "distribution-customization-complete" notification is sent.
+
+Distributions are most reliably identified by the ``distributionId`` field. Partner information can be found in the `partner repacks <https://github.com/mozilla-partners>`_ (`the old one <http://hg.mozilla.org/build/partner-repacks/>`_ is deprecated): it contains one private repository per partner.
+Important values for ``distributionId`` include:
+
+- "MozillaOnline" for the Mozilla China repack.
+- "canonical", for the `Ubuntu Firefox repack <http://bazaar.launchpad.net/~mozillateam/firefox/firefox.trusty/view/head:/debian/distribution.ini>`_.
+- "yandex", for the Firefox Build by Yandex.
+
+system
+------
+
+os
+~~
+
+This object contains operating system information.
+
+- ``name``: the name of the OS.
+- ``version``: a string representing the OS version.
+- ``kernelVersion``: an Android/B2G only string representing the kernel version.
+- ``servicePackMajor``: the Windows only major version number for the installed service pack.
+- ``servicePackMinor``: the Windows only minor version number for the installed service pack.
+- ``windowsBuildNumber``: the Windows build number, only available for Windows >= 10.
+- ``windowsUBR``: the Windows UBR number, only available for Windows >= 10. This value is incremented by Windows cumulative updates patches.
+- ``installYear``: the Windows only integer representing the year the OS was installed.
+- ``locale``: the string representing the OS locale.
+
+addons
+------
+
+activeAddons
+~~~~~~~~~~~~
+
+Starting from Firefox 44, the length of the following string fields: ``name``, ``description`` and ``version`` is limited to 100 characters. The same limitation applies to the same fields in ``theme`` and ``activePlugins``.
diff --git a/toolkit/components/telemetry/docs/data/heartbeat-ping.rst b/toolkit/components/telemetry/docs/data/heartbeat-ping.rst
new file mode 100644
index 000000000..413da0376
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/heartbeat-ping.rst
@@ -0,0 +1,63 @@
+
+"heartbeat" ping
+=================
+
+This ping is submitted after a Firefox Heartbeat survey. Even if the user exits
+the browser, closes the survey window, or ignores the survey, Heartbeat will
+provide a ping to Telemetry for sending during the same session.
+
+The payload contains the user's survey response (if any) as well as timestamps
+of various Heartbeat events (survey shown, survey closed, link clicked, etc).
+
+The ping will also report the "surveyId", "surveyVersion" and "testing"
+Heartbeat survey parameters (if they are present in the survey config).
+These "meta fields" will be repeated verbatim in the payload section.
+
+The environment block and client ID are submitted with this ping.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: "heartbeat",
+      version: 4,
+      clientId: <UUID>,
+      environment: { /* ... */ }
+      // ... common ping data
+      payload: {
+        version: 1,
+        flowId: <string>,
+        ... timestamps below ...
+        offeredTS: <integer epoch timestamp>,
+        learnMoreTS: <integer epoch timestamp>,
+        votedTS: <integer epoch timestamp>,
+        engagedTS: <integer epoch timestamp>,
+        closedTS: <integer epoch timestamp>,
+        expiredTS: <integer epoch timestamp>,
+        windowClosedTS: <integer epoch timestamp>,
+        // ... user's rating below
+        score: <integer>,
+        // ... survey meta fields below
+        surveyId: <string>,
+        surveyVersion: <integer>,
+        testing: <boolean>
+      }
+    }
+
+Notes:
+
+* Pings will **NOT** have all possible timestamps, timestamps are only reported for events that actually occurred.
+* Timestamp meanings:
+   * offeredTS: when the survey was shown to the user
+   * learnMoreTS: when the user clicked on the "Learn More" link
+   * votedTS: when the user voted
+   * engagedTS: when the user clicked on the survey-provided button (alternative to voting feature)
+   * closedTS: when the Heartbeat notification bar was closed
+   * expiredTS: indicates that the survey expired after 2 hours of no interaction (threshold regulated by "browser.uitour.surveyDuration" pref)
+   * windowClosedTS: the user closed the entire Firefox window containing the survey, thus ending the survey. This timestamp will also be reported when the survey is ended by the browser being shut down.
+* The surveyId/surveyVersion fields identify a specific survey (like a "1040EZ" tax paper form). The flowID is a UUID that uniquely identifies a single user's interaction with the survey. Think of it as a session token.
+* The self-support page cannot include additional data in this payload. Only the the 4 flowId/surveyId/surveyVersion/testing fields are under the self-support page's control.
+
+See also: :doc:`common ping fields <common-ping>`
+
diff --git a/toolkit/components/telemetry/docs/data/index.rst b/toolkit/components/telemetry/docs/data/index.rst
new file mode 100644
index 000000000..a0467e9a1
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/index.rst
@@ -0,0 +1,18 @@
+==================
+Data documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :glob:
+
+   common-ping
+   environment
+   main-ping
+   deletion-ping
+   crash-ping
+   *-ping
+   addons-malware-ping
+
+The `mozilla-pipeline-schemas repository <https://github.com/mozilla-services/mozilla-pipeline-schemas/>`_ contains schemas for some of the pings.
diff --git a/toolkit/components/telemetry/docs/data/main-ping.rst b/toolkit/components/telemetry/docs/data/main-ping.rst
new file mode 100644
index 000000000..445090af9
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/main-ping.rst
@@ -0,0 +1,609 @@
+
+"main" ping
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+This is the "main" Telemetry ping type, whose payload contains most of the measurements that are used to track the performance and health of Firefox in the wild.
+It includes the histograms and other performance and diagnostic data.
+
+This ping is triggered by different scenarios, which is documented by the ``reason`` field:
+
+* ``aborted-session`` - this ping is regularly saved to disk (every 5 minutes), overwriting itself, and deleted at shutdown. If a previous aborted session ping is found at startup, it gets sent to the server. The first aborted-session ping is generated as soon as Telemetry starts
+* ``environment-change`` - the :doc:`environment` changed, so the session measurements got reset and a new subsession starts
+* ``shutdown`` - triggered when the browser session ends
+* ``daily`` - a session split triggered in 24h hour intervals at local midnight. If an ``environment-change`` ping is generated by the time it should be sent, the daily ping is rescheduled for the next midnight
+* ``saved-session`` - the *"classic"* Telemetry payload with measurements covering the whole browser session (only submitted for a transition period)
+
+Most reasons lead to a session split, initiating a new *subsession*. We reset important measurements for those subsessions.
+
+After a new subsession split, the ``internal-telemetry-after-subsession-split`` topic is notified to all the observers. *This is an internal topic and is only meant for internal Telemetry usage.*
+
+*Note:* ``saved-session`` is sent with a different ping type (``saved-session``, not ``main``), but otherwise has the same format as discussed here.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      version: 4,
+
+      info: {
+        reason: <string>, // what triggered this ping: "saved-session", "environment-change", "shutdown", ...
+        revision: <string>, // the Histograms.json revision
+        timezoneOffset: <integer>, // time-zone offset from UTC, in minutes, for the current locale
+        previousBuildId: <string>, // null if this is the first run, or the previous build ID is unknown
+
+        sessionId: <uuid>,  // random session id, shared by subsessions
+        subsessionId: <uuid>,  // random subsession id
+        previousSessionId: <uuid>, // session id of the previous session, null on first run.
+        previousSubsessionId: <uuid>, // subsession id of the previous subsession (even if it was in a different session),
+                                      // null on first run.
+
+        subsessionCounter: <unsigned integer>, // the running no. of this subsession since the start of the browser session
+        profileSubsessionCounter: <unsigned integer>, // the running no. of all subsessions for the whole profile life time
+
+        sessionStartDate: <ISO date>, // daily precision
+        subsessionStartDate: <ISO date>, // daily precision, ISO date in local time
+        sessionLength: <integer>, // the session length until now in seconds, monotonic
+        subsessionLength: <integer>, // the subsession length in seconds, monotonic
+
+        flashVersion: <string>, // obsolete, use ``environment.addons.activePlugins``
+        addons: <string>, // obsolete, use ``environment.addons``
+      },
+
+      processes: {...},
+      childPayloads: [...], // only present with e10s; reduced payloads from content processes, null on failure
+      simpleMeasurements: {...},
+
+      // The following properties may all be null if we fail to collect them.
+      histograms: {...},
+      keyedHistograms: {...},
+      chromeHangs: {...},
+      threadHangStats: [...],
+      log: [...],
+      webrtc: {...},
+      gc: {...},
+      fileIOReports: {...},
+      lateWrites: {...},
+      addonDetails: {...},
+      addonHistograms: {...},
+      UIMeasurements: [...],
+      slowSQL: {...},
+      slowSQLstartup: {...},
+    }
+
+info
+----
+
+sessionLength
+~~~~~~~~~~~~~
+The length of the current session so far in seconds.
+This uses a monotonic clock, so this may mismatch with other measurements that
+are not monotonic like calculations based on ``Date.now()``.
+
+If the monotonic clock failed, this will be ``-1``.
+
+subsessionLength
+~~~~~~~~~~~~~~~~
+The length of this subsession in seconds.
+This uses a monotonic clock, so this may mismatch with other measurements that are not monotonic (e.g. based on Date.now()).
+
+If ``sessionLength`` is ``-1``, the monotonic clock is not working.
+
+processes
+---------
+This section contains per-process data.
+
+Structure:
+
+.. code-block:: js
+
+    "processes" : {
+      ... other processes ...
+      "parent": {
+        scalars: {...},
+      },
+      "content": {
+        histograms: {...},
+        keyedHistograms: {...},
+      },
+    }
+
+histograms and keyedHistograms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This section contains histograms and keyed histograms accumulated on content processes. Histograms recorded on a content child process have different character than parent histograms. For instance, ``GC_MS`` will be much different in ``processes.content`` as it has to contend with web content, whereas the instance in ``payload.histograms`` has only to contend with browser JS. Also, some histograms may be absent if never recorded on a content child process (``EVENTLOOP_UI_ACTIVITY`` is parent-process-only).
+
+This format was adopted in Firefox 51 via bug 1218576.
+
+scalars
+~~~~~~~
+This section contains the :doc:`../collection/scalars` that are valid for the current platform. Scalars are not created nor submitted if no data was added to them, and are only reported with subsession pings. Scalar data is only currently reported for the main process. Their type and format is described by the ``Scalars.yaml`` file. Its most recent version is available `here <https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/Scalars.yaml>`_. The ``info.revision`` field indicates the revision of the file that describes the reported scalars.
+
+childPayloads
+-------------
+The Telemetry payloads sent by child processes, recorded on child process shutdown (event ``content-child-shutdown`` observed). They are reduced session payloads, only available with e10s. Among some other things, they don't contain histograms, keyed histograms, addon details, addon histograms, or UI Telemetry.
+
+Note: Child payloads are not collected and cleared with subsession splits, they are currently only meaningful when analysed from ``saved-session`` or ``main`` pings with ``reason`` set to ``shutdown``.
+
+Note: Before Firefox 51 and bug 1218576, content process histograms and keyedHistograms were in the individual child payloads instead of being aggregated into ``processes.content``.
+
+simpleMeasurements
+------------------
+This section contains a list of simple measurements, or counters. In addition to the ones highlighted below, Telemetry timestamps (see `here <https://dxr.mozilla.org/mozilla-central/search?q=%22TelemetryTimestamps.add%22&redirect=false&case=true>`_ and `here <https://dxr.mozilla.org/mozilla-central/search?q=%22recordTimestamp%22&redirect=false&case=true>`_) can be reported.
+
+totalTime
+~~~~~~~~~
+A non-monotonic integer representing the number of seconds the session has been alive.
+
+uptime
+~~~~~~
+A non-monotonic integer representing the number of minutes the session has been alive.
+
+addonManager
+~~~~~~~~~~~~
+Only available in the extended set of measures, it contains a set of counters related to Addons. See `here <https://dxr.mozilla.org/mozilla-central/search?q=%22AddonManagerPrivate.recordSimpleMeasure%22&redirect=false&case=true>`_ for a list of recorded measures.
+
+UITelemetry
+~~~~~~~~~~~
+Only available in the extended set of measures. For more see :ref:`uitelemetry`.
+
+startupInterrupted
+~~~~~~~~~~~~~~~~~~
+A boolean set to true if startup was interrupted by an interactive prompt.
+
+js
+~~
+This section contains a series of counters from the JavaScript engine.
+
+Structure:
+
+.. code-block:: js
+
+    "js" : {
+      "setProto": <unsigned integer>, // Number of times __proto__ is set
+      "customIter": <unsigned integer> // Number of times __iterator__ is used (i.e., is found for a for-in loop)
+    }
+
+maximalNumberOfConcurrentThreads
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+An integer representing the highest number of threads encountered so far during the session.
+
+startupSessionRestoreReadBytes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Windows-only integer representing the number of bytes read by the main process up until the session store has finished restoring the windows.
+
+startupSessionRestoreWriteBytes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Windows-only integer representing the number of bytes written by the main process up until the session store has finished restoring the windows.
+
+startupWindowVisibleReadBytes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Windows-only integer representing the number of bytes read by the main process up until after a XUL window is made visible.
+
+startupWindowVisibleWriteBytes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Windows-only integer representing the number of bytes written by the main process up until after a XUL window is made visible.
+
+debuggerAttached
+~~~~~~~~~~~~~~~~
+A boolean set to true if a debugger is attached to the main process.
+
+shutdownDuration
+~~~~~~~~~~~~~~~~
+The time, in milliseconds, it took to complete the last shutdown.
+
+failedProfileLockCount
+~~~~~~~~~~~~~~~~~~~~~~
+The number of times the system failed to lock the user profile.
+
+savedPings
+~~~~~~~~~~
+Integer count of the number of pings that need to be sent.
+
+activeTicks
+~~~~~~~~~~~
+Integer count of the number of five-second intervals ('ticks') the user was considered 'active' (sending UI events to the window). An extra event is fired immediately when the user becomes active after being inactive. This is for some mouse and gamepad events, and all touch, keyboard, wheel, and pointer events (see `EventStateManager.cpp <https://dxr.mozilla.org/mozilla-central/rev/e6463ae7eda2775bc84593bb4a0742940bb87379/dom/events/EventStateManager.cpp#549>`_).
+This measure might be useful to give a trend of how much a user actually interacts with the browser when compared to overall session duration. It does not take into account whether or not the window has focus or is in the foreground. Just if it is receiving these interaction events.
+Note that in ``main`` pings, this measure is reset on subsession splits, while in ``saved-session`` pings it covers the whole browser session.
+
+pingsOverdue
+~~~~~~~~~~~~
+Integer count of pending pings that are overdue.
+
+histograms
+----------
+This section contains the histograms that are valid for the current platform. ``Flag`` and ``count`` histograms are always created and submitted, with their default value being respectively ``false`` and ``0``. Other histogram types (`see here <https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe#Choosing_a_Histogram_Type>`_) are not created nor submitted if no data was added to them. The type and format of the reported histograms is described by the ``Histograms.json`` file. Its most recent version is available `here <https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/Histograms.json>`_. The ``info.revision`` field indicates the revision of the file that describes the reported histograms.
+
+keyedHistograms
+---------------
+This section contains the keyed histograms available for the current platform.
+
+As of Firefox 48, this section does not contain empty keyed histograms anymore.
+
+threadHangStats
+---------------
+Contains the statistics about the hangs in main and background threads. Note that hangs in this section capture the [C++ pseudostack](https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Profiling_with_the_Built-in_Profiler#Native_stack_vs._Pseudo_stack) and an incomplete JS stack, which is not 100% precise.
+
+To avoid submitting overly large payloads, some limits are applied:
+
+* Identical, adjacent "(chrome script)" or "(content script)" stack entries are collapsed together. If a stack is reduced, the "(reduced stack)" frame marker is added as the oldest frame.
+* The depth of the reported stacks is limited to 11 entries. This value represents the 99.9th percentile of the thread hangs stack depths reported by Telemetry.
+
+Structure:
+
+.. code-block:: js
+
+    "threadHangStats" : [
+      {
+        "name" : "Gecko",
+        "activity" : {...}, // a time histogram of all task run times
+        "hangs" : [
+          {
+            "stack" : [
+              "Startup::XRE_Main",
+              "Timer::Fire",
+              "(content script)",
+              "IPDL::PPluginScriptableObject::SendGetChildProperty",
+              ... up to 11 frames ...
+            ],
+            "nativeStack": [...], // optionally available
+            "histogram" : {...}, // the time histogram of the hang times
+            "annotations" : [
+              {
+                "pluginName" : "Shockwave Flash",
+                "pluginVersion" : "18.0.0.209"
+              },
+              ... other annotations ...
+            ]
+          },
+        ],
+      },
+      ... other threads ...
+     ]
+
+chromeHangs
+-----------
+Contains the statistics about the hangs happening exclusively on the main thread of the parent process. Precise C++ stacks are reported. This is only available on Nightly Release on Windows, when building using "--enable-profiling" switch.
+
+Some limits are applied:
+
+* Reported chrome hang stacks are limited in depth to 50 entries.
+* The maximum number of reported stacks is 50.
+
+Structure:
+
+.. code-block:: js
+
+    "chromeHangs" : {
+      "memoryMap" : [
+        ["wgdi32.pdb", "08A541B5942242BDB4AEABD8C87E4CFF2"],
+        ["igd10iumd32.pdb", "D36DEBF2E78149B5BE1856B772F1C3991"],
+        ... other entries in the format ["module name", "breakpad identifier"] ...
+       ],
+      "stacks" : [
+        [
+          [
+            0, // the module index or -1 for invalid module indices
+            190649 // the offset of this program counter in its module or an absolute pc
+          ],
+          [1, 2540075],
+          ... other frames, up to 50 ...
+         ],
+         ... other stacks, up to 50 ...
+      ],
+      "durations" : [8, ...], // the hang durations (in seconds)
+      "systemUptime" : [692, ...], // the system uptime (in minutes) at the time of the hang
+      "firefoxUptime" : [672, ...], // the Firefox uptime (in minutes) at the time of the hang
+      "annotations" : [
+        [
+          [0, ...], // the indices of the related hangs
+          {
+            "pluginName" : "Shockwave Flash",
+            "pluginVersion" : "18.0.0.209",
+            ... other annotations as key:value pairs ...
+          }
+        ],
+        ...
+      ]
+    },
+
+log
+---
+This section contains a log of important or unusual events reported through Telemetry.
+
+Structure:
+
+.. code-block:: js
+
+    "log": [
+      [
+        "Event_ID",
+        3785, // the timestamp (in milliseconds) for the log entry
+        ... other data ...
+      ],
+      ...
+    ]
+
+
+webrtc
+------
+Contains special statistics gathered by WebRTC related components.
+
+So far only a bitmask for the ICE candidate type present in a successful or
+failed WebRTC connection is getting reported through C++ code as
+IceCandidatesStats, because the required bitmask is too big to be represented
+in a regular enum histogram. Further this data differentiates between Loop
+(aka Firefox Hello) connections and everything else, which is categorized as
+WebRTC.
+
+Note: in most cases the webrtc and loop dictionaries inside of
+IceCandidatesStats will simply be empty as the user has not used any WebRTC
+PeerConnection at all during the ping report time.
+
+Structure:
+
+.. code-block:: js
+
+    "webrtc": {
+      "IceCandidatesStats": {
+        "webrtc": {
+          "34526345": {
+            "successCount": 5
+          },
+          "2354353": {
+            "failureCount": 1
+          }
+        },
+        "loop": {
+          "2349346359": {
+            "successCount": 3
+          },
+          "73424": {
+            "successCount": 1,
+            "failureCount": 5
+          }
+        }
+      }
+    },
+
+gc
+--
+Contains statistics about selected garbage collections. To avoid
+bloating the ping, only a few GCs are included. There are two
+selection strategies. We always save the two GCs with the worst
+max_pause time. Additionally, in content processes, two collections
+are selected at random. If a GC runs for C milliseconds and the total
+time for all GCs since the session began is T milliseconds, then the
+GC has a C/T probablility of being selected for one of these "slots".
+
+Structure:
+
+.. code-block:: js
+
+    "gc": {
+      "random": [
+        {
+          // Timestamps are in milliseconds since startup. All the times here
+          // are wall-clock times, which may not be monotonically increasing.
+          "timestamp": 294872.2,
+          // All durations are in milliseconds.
+          "max_pause": 73.629,
+          "total_time": 364.951, // Sum of all slice times.
+          "zones_collected": 9,
+          "total_zones": 9,
+          "total_compartments": 309,
+          "minor_gcs": 44,
+          "store_buffer_overflows": 19,
+          "mmu_20ms": 0,
+          "mmu_50ms": 0,
+          // Reasons include "None", "NonIncrementalRequested",
+          // "AbortRequested", "KeepAtomsSet", "IncrementalDisabled",
+          // "ModeChange", "MallocBytesTrigger", "GCBytesTrigger",
+          // "ZoneChange".
+          "nonincremental_reason": "None",
+          "allocated": 37, // In megabytes.
+          "added_chunks": 54,
+          "removed_chunks": 12,
+          // Total number of slices (some of which may not appear
+          // in the "slices" array).
+          "num_slices": 15,
+          // We record at most 4 slices.
+          "slices": [
+            {
+              "slice": 0,  // The index of this slice.
+              "pause": 23.221,  // How long the slice took.
+              "when": 0,  // Milliseconds since the start of the GC.
+              "reason": "SET_NEW_DOCUMENT",
+              // GC state when the slice started
+              "initial_state": "NotActive",
+              // GC state when the slice ended
+              "final_state": "Mark",
+              // Budget is either "Xms", "work(Y)", or
+              // "unlimited".
+              "budget": "10ms",
+              // Number of page faults during the slice.
+              "page_faults": 0,
+              "start_timestamp": 294875,
+              "end_timestamp": 294879,
+              // Time taken by each phase. There are at most 65 possible
+              // phases, but usually only a few phases run in a given slice.
+              "times": {
+                "wait_background_thread": 0.012,
+                "mark_discard_code": 2.845,
+                "purge": 0.723,
+                "mark": 9.831,
+                "mark_roots": 0.102,
+                "buffer_gray_roots": 3.095,
+                "mark_cross_compartment_wrappers": 0.039,
+                "mark_c_and_js_stacks": 0.005,
+                "mark_runtime_wide_data": 2.313,
+                "mark_embedding": 0.117,
+                "mark_compartments": 2.27,
+                "unmark": 1.063,
+                "minor_gcs_to_evict_nursery": 8.701,
+                ...
+              }
+            },
+            { ... },
+          ],
+          // Sum of the phase times across all slices, including
+          // omitted slices. As before, there are <= 65 possible phases.
+          "totals": {
+            "wait_background_thread": 0.012,
+            "mark_discard_code": 2.845,
+            "purge": 0.723,
+            "mark": 9.831,
+            "mark_roots": 0.102,
+            "buffer_gray_roots": 3.095,
+            "mark_cross_compartment_wrappers": 0.039,
+            "mark_c_and_js_stacks": 0.005,
+            "mark_runtime_wide_data": 2.313,
+            "mark_embedding": 0.117,
+            "mark_compartments": 2.27,
+            "unmark": 1.063,
+            "minor_gcs_to_evict_nursery": 8.701,
+            ...
+          }
+        },
+        ... // Up to four more selected GCs follow.
+      ],
+      "worst": [
+        ... // Same as above, but the 2 worst GCs by max_pause.
+      ]
+    },
+
+fileIOReports
+-------------
+Contains the statistics of main-thread I/O recorded during the execution. Only the I/O stats for the XRE and the profile directories are currently reported, neither of them disclosing the full local path.
+
+Structure:
+
+.. code-block:: js
+
+    "fileIOReports": {
+      "{xre}": [
+        totalTime, // Accumulated duration of all operations
+        creates, // Number of create/open operations
+        reads, // Number of read operations
+        writes, // Number of write operations
+        fsyncs, // Number of fsync operations
+        stats, // Number of stat operations
+      ],
+      "{profile}": [ ... ],
+      ...
+    }
+
+lateWrites
+----------
+This sections reports writes to the file system that happen during shutdown. The reported data contains the stack and the loaded libraries at the time the writes happened.
+
+Structure:
+
+.. code-block:: js
+
+    "lateWrites" : {
+      "memoryMap" : [
+        ["wgdi32.pdb", "08A541B5942242BDB4AEABD8C87E4CFF2"],
+        ... other entries in the format ["module name", "breakpad identifier"] ...
+       ],
+      "stacks" : [
+        [
+          [
+            0, // the module index or -1 for invalid module indices
+            190649 // the offset of this program counter in its module or an absolute pc
+          ],
+          [1, 2540075],
+          ... other frames ...
+         ],
+         ... other stacks ...
+      ],
+    },
+
+addonDetails
+------------
+This section contains per-addon telemetry details, as reported by each addon provider. The XPI provider is the only one reporting at the time of writing (`see DXR <https://dxr.mozilla.org/mozilla-central/search?q=setTelemetryDetails&case=true>`_). Telemetry does not manipulate or enforce a specific format for the supplied provider's data.
+
+Structure:
+
+.. code-block:: js
+
+    "addonDetails": {
+      "XPI": {
+        "adbhelper@mozilla.org": {
+          "scan_items": 24,
+          "scan_MS": 3,
+          "location": "app-profile",
+          "name": "ADB Helper",
+          "creator": "Mozilla & Android Open Source Project",
+          "startup_MS": 30
+        },
+        ...
+      },
+      ...
+    }
+
+addonHistograms
+---------------
+This section contains the histogram registered by the addons (`see here <https://dxr.mozilla.org/mozilla-central/rev/584870f1cbc5d060a57e147ce249f736956e2b62/toolkit/components/telemetry/nsITelemetry.idl#303>`_). This section is not present if no addon histogram is available.
+
+UITelemetry
+-----------
+See the ``UITelemetry data format`` documentation.
+
+slowSQL
+-------
+This section contains the informations about the slow SQL queries for both the main and other threads. The execution of an SQL statement is considered slow if it takes 50ms or more on the main thread or 100ms or more on other threads. Slow SQL statements will be automatically trimmed to 1000 characters. This limit doesn't include the ellipsis and database name, that are appended at the end of the stored statement.
+
+Structure:
+
+.. code-block:: js
+
+    "slowSQL": {
+      "mainThread": {
+        "Sanitized SQL Statement": [
+          1, // the number of times this statement was hit
+          200  // the total time (in milliseconds) that was spent on this statement
+        ],
+        ...
+      },
+      "otherThreads": {
+        "VACUUM /* places.sqlite */": [
+          1,
+          330
+        ],
+        ...
+      }
+    },
+
+slowSQLStartup
+--------------
+This section contains the slow SQL statements gathered at startup (until the "sessionstore-windows-restored" event is fired). The structure of this section resembles the one for `slowSQL`_.
+
+UIMeasurements
+--------------
+This section contains UI specific telemetry measurements and events. This section is mainly populated with Android-specific data and events (`see here <https://dxr.mozilla.org/mozilla-central/search?q=regexp%3AUITelemetry.%28addEvent|startSession|stopSession%29&redirect=false&case=false>`_).
+
+Structure:
+
+.. code-block:: js
+
+    "UIMeasurements": [
+      {
+        "type": "event", // either "session" or "event"
+        "action": "action.1",
+        "method": "menu",
+        "sessions": [],
+        "timestamp": 12345,
+        "extras": "settings"
+      },
+      {
+        "type": "session",
+        "name": "awesomescreen.1",
+        "reason": "commit",
+        "start": 123,
+        "end": 456
+      }
+      ...
+    ],
diff --git a/toolkit/components/telemetry/docs/data/sync-ping.rst b/toolkit/components/telemetry/docs/data/sync-ping.rst
new file mode 100644
index 000000000..775ab008a
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/sync-ping.rst
@@ -0,0 +1,182 @@
+
+"sync" ping
+===========
+
+This is an aggregated format that contains information about each sync that occurred during a timeframe. It is submitted every 12 hours, and on browser shutdown, but only if the syncs property would not be empty. The ping does not contain the enviroment block, nor the clientId.
+
+Each item in the syncs property is generated after a sync is completed, for both successful and failed syncs, and contains measurements pertaining to sync performance and error information.
+
+A JSON-schema document describing the exact format of the ping's payload property can be found at `services/sync/tests/unit/sync\_ping\_schema.json <https://dxr.mozilla.org/mozilla-central/source/services/sync/tests/unit/sync_ping_schema.json>`_.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      version: 4,
+      type: "sync",
+      ... common ping data
+      payload: {
+        version: 1,
+        discarded: <integer count> // Number of syncs discarded -- left out if zero.
+        why: <string>, // Why did we submit the ping? Either "shutdown" or "schedule".
+        // Array of recorded syncs. The ping is not submitted if this would be empty
+        syncs: [{
+          when: <integer milliseconds since epoch>,
+          took: <integer duration in milliseconds>,
+          uid: <string>, // Hashed FxA unique ID, or string of 32 zeros.
+          deviceID: <string>, // Hashed FxA Device ID, hex string of 64 characters, not included if the user is not logged in.
+          didLogin: <bool>, // Optional, is this the first sync after login? Excluded if we don't know.
+          why: <string>, // Optional, why the sync occured, excluded if we don't know.
+
+          // Optional, excluded if there was no error.
+          failureReason: {
+            name: <string>, // "httperror", "networkerror", "shutdownerror", etc.
+            code: <integer>, // Only present for "httperror" and "networkerror".
+            error: <string>, // Only present for "othererror" and "unexpectederror".
+            from: <string>, // Optional, and only present for "autherror".
+          },
+
+          // Optional, excluded if we couldn't get a valid uid or local device id
+          devices: [{
+            os: <string>, // OS string as reported by Services.appinfo.OS,
+            version: <string>, // Firefox version, as reported by Services.appinfo.version
+            id: <string>, // Hashed FxA device id for device
+          }],
+
+          // Internal sync status information. Omitted if it would be empty.
+          status: {
+            sync: <string>, // The value of the Status.sync property, unless it indicates success.
+            service: <string>, // The value of the Status.service property, unless it indicates success.
+          },
+          // Information about each engine's sync.
+          engines: [
+            {
+              name: <string>, // "bookmarks", "tabs", etc.
+              took: <integer duration in milliseconds>, // Optional, values of 0 are omitted.
+
+              status: <string>, // The value of Status.engines, if it holds a non-success value.
+
+              // Optional, excluded if all items would be 0. A missing item indicates a value of 0.
+              incoming: {
+                applied: <integer>, // Number of records applied
+                succeeded: <integer>, // Number of records that applied without error
+                failed: <integer>, // Number of records that failed to apply
+                newFailed: <integer>, // Number of records that failed for the first time this sync
+                reconciled: <integer>, // Number of records that were reconciled
+              },
+
+              // Optional, excluded if it would be empty. Records that would be
+              // empty (e.g. 0 sent and 0 failed) are omitted.
+              outgoing: [
+                {
+                  sent: <integer>, // Number of outgoing records sent. Zero values are omitted.
+                  failed: <integer>, // Number that failed to send. Zero values are omitted.
+                }
+              ],
+              // Optional, excluded if there were no errors
+              failureReason: { ... }, // Same as above.
+
+              // Optional, excluded if it would be empty or if the engine cannot
+              // or did not run validation on itself.
+              validation: {
+                // Optional validator version, default of 0.
+                version: <integer>,
+                checked: <integer>,
+                took: <non-monotonic integer duration in milliseconds>,
+                // Entries with a count of 0 are excluded, the array is excluded if no problems are found.
+                problems: [
+                  {
+                    name: <string>, // The problem identified.
+                    count: <integer>, // Number of times it occurred.
+                  }
+                ],
+                // Format is same as above, this is only included if we tried and failed
+                // to run validation, and if it's present, all other fields in this object are optional.
+                failureReason: { ... },
+              }
+            }
+          ]
+        }]
+      }
+    }
+
+info
+----
+
+discarded
+~~~~~~~~~
+
+The ping may only contain a certain number of entries in the ``"syncs"`` array, currently 500 (it is determined by the ``"services.sync.telemetry.maxPayloadCount"`` preference).  Entries beyond this are discarded, and recorded in the discarded count.
+
+syncs.took
+~~~~~~~~~~
+
+These values should be monotonic.  If we can't get a monotonic timestamp, -1 will be reported on the payload, and the values will be omitted from the engines. Additionally, the value will be omitted from an engine if it would be 0 (either due to timer inaccuracy or finishing instantaneously).
+
+syncs.uid
+~~~~~~~~~
+
+This property containing a hash of the FxA account identifier, which is a 32 character hexidecimal string.  In the case that we are unable to authenticate with FxA and have never authenticated in the past, it will be a placeholder string consisting of 32 repeated ``0`` characters.
+
+syncs.why
+~~~~~~~~~
+
+One of the following values:
+
+- ``startup``: This is the first sync triggered after browser startup.
+- ``schedule``: This is a sync triggered because it has been too long since the last sync.
+- ``score``: This sync is triggered by a high score value one of sync's trackers, indicating that many changes have occurred since the last sync.
+- ``user``: The user manually triggered the sync.
+- ``tabs``: The user opened the synced tabs sidebar, which triggers a sync.
+
+syncs.status
+~~~~~~~~~~~~
+
+The ``engine.status``, ``payload.status.sync``, and ``payload.status.service`` properties are sync error codes, which are listed in `services/sync/modules/constants.js <https://dxr.mozilla.org/mozilla-central/source/services/sync/modules/constants.js>`_, and success values are not reported.
+
+syncs.failureReason
+~~~~~~~~~~~~~~~~~~~
+
+Stores error information, if any is present. Always contains the "name" property, which identifies the type of error it is. The types can be.
+
+- ``httperror``: Indicates that we recieved an HTTP error response code, but are unable to be more specific about the error. Contains the following properties:
+
+    - ``code``: Integer HTTP status code.
+
+- ``nserror``: Indicates that an exception with the provided error code caused sync to fail.
+
+    - ``code``: The nsresult error code (integer).
+
+- ``shutdownerror``: Indicates that the sync failed because we shut down before completion.
+
+- ``autherror``: Indicates an unrecoverable authentication error.
+
+    - ``from``: Where the authentication error occurred, one of the following values: ``tokenserver``, ``fxaccounts``, or ``hawkclient``.
+
+- ``othererror``: Indicates that it is a sync error code that we are unable to give more specific information on. As with the ``syncStatus`` property, it is a sync error code, which are listed in `services/sync/modules/constants.js <https://dxr.mozilla.org/mozilla-central/source/services/sync/modules/constants.js>`_.
+
+    - ``error``: String identifying which error was present.
+
+- ``unexpectederror``: Indicates that some other error caused sync to fail, typically an uncaught exception.
+
+   - ``error``: The message provided by the error.
+
+- ``sqlerror``: Indicates that we recieved a ``mozIStorageError`` from a database query.
+
+    - ``code``: Value of the ``error.result`` property, one of the constants listed `here <https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/MozIStorageError#Constants>`_.
+
+syncs.engine.name
+~~~~~~~~~~~~~~~~~
+
+Third-party engines are not reported, so only the following values are allowed: ``addons``, ``bookmarks``, ``clients``, ``forms``, ``history``, ``passwords``, ``prefs``, and ``tabs``.
+
+syncs.engine.validation.problems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For engines that can run validation on themselves, an array of objects describing validation errors that have occurred. Items that would have a count of 0 are excluded. Each engine will have its own set of items that it might put in the ``name`` field, but there are a finite number. See ``BookmarkProblemData.getSummary`` in `services/sync/modules/bookmark\_validator.js <https://dxr.mozilla.org/mozilla-central/source/services/sync/modules/bookmark_validator.js>`_ for an example.
+
+syncs.devices
+~~~~~~~~~~~~~
+
+The list of remote devices associated with this account, as reported by the clients collection. The ID of each device is hashed using the same algorithm as the local id.
diff --git a/toolkit/components/telemetry/docs/data/uitour-ping.rst b/toolkit/components/telemetry/docs/data/uitour-ping.rst
new file mode 100644
index 000000000..8d17ec55a
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/uitour-ping.rst
@@ -0,0 +1,26 @@
+
+"uitour-tag" ping
+=================
+
+This ping is submitted via the UITour setTreatmentTag API. It may be used by
+the tour to record what settings were made by a user or to track the result of
+A/B experiments.
+
+The client ID is submitted with this ping.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      version: 1,
+      type: "uitour-tag",
+      clientId: <string>,
+      payload: {
+        tagName: <string>,
+        tagValue: <string>
+      }
+    }
+
+See also: :doc:`common ping fields <common-ping>`
+