Bug 1307568 - document the system add-on diagnostic telemetry ping r?bsmedberg
MozReview-Commit-ID: GY2lGgqocwi
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>,
+ }
+ }