Bug 1307568 - document the system add-on diagnostic telemetry ping r?bsmedberg draft
authorRobert Helmer <rhelmer@mozilla.com>
Wed, 25 Jan 2017 11:49:21 -0800
changeset 466287 f72f13052d7479bf21cc81d8b8a6d44b34aab1a6
parent 466286 24d9eb148461bb4789848b9880867c63c783a2ca
child 466953 63df1720087d4255371360bd3dcb47a2d1e5d5f4
child 467009 63cdff26ad28ae1b109ac5333325b3969359b581
child 468117 5b316de35533849b4bb09fa7fb6a63320f8a1cdf
push id42860
push userrhelmer@mozilla.com
push dateWed, 25 Jan 2017 19:50:00 +0000
reviewersbsmedberg
bugs1307568
milestone54.0a1
Bug 1307568 - document the system add-on diagnostic telemetry ping r?bsmedberg MozReview-Commit-ID: GY2lGgqocwi
toolkit/components/telemetry/docs/data/system-addons-diagnostics-ping.rst
new file mode 100644
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/system-addons-diagnostics-ping.rst
@@ -0,0 +1,24 @@
+
+System Add-on Diagnostics Ping
+==============================
+
+This ping is generated by an add-on created by Mozilla and shipped to users on current Firefox beta and release (51,52).
+The ping contains information about successful install and startup of the diagnostic add-on, to diagnose suspected delivery and installation problems.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: "system-addon-deployment-diagnostics",
+      ...
+      clientId: <UUID>,
+      environment: { ... },
+      // Common ping data.
+      payload: {
+        // The version of the diagnostic add-on - future versions are planned.
+        version: <int>,
+        // The installation phase that has completed successfully - either "install" or "startup"
+        phase: <string>,
+      }
+    }