Backed out changeset 882a43e7e21a (bug 1318297)
authorCarsten "Tomcat" Book <cbook@mozilla.com>
Mon, 24 Jul 2017 16:16:22 +0200
changeset 419314 3538dbc8dbfed1ca5153304f21f6c899e353750d
parent 419313 7b77ed78841f72748a1da9f0830f4317b21a5661
child 419315 a035857a0533e01d312cf03cbc441a4a9a98e76e
push id7566
push usermtabara@mozilla.com
push dateWed, 02 Aug 2017 08:25:16 +0000
treeherdermozilla-beta@86913f512c3c [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
bugs1318297
milestone56.0a1
backs out882a43e7e21ab3d595f01dbb344fcff870d1e5d4
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
Backed out changeset 882a43e7e21a (bug 1318297)
toolkit/components/telemetry/docs/data/health-ping.rst
deleted file mode 100644
--- a/toolkit/components/telemetry/docs/data/health-ping.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-
-"health" ping
-============
-
-This ping is intended to provide data about problems arise when submitting other pings.
-The ping is submitted at most once per hour. On shutdown an additional ping is submitted
-to avoid losing collected data.
-
-This ping is intended to be really small.
-The client id is submitted with this ping.
-
-.. code-block:: js
-
-    {
-      "type": "health", // type
-      ... common ping data
-      "clientId": <UUID>, // client id, e.g.
-                            // "c641eacf-c30c-4171-b403-f077724e848a"
-      "payload": {
-        "os": {
-            "name": <string>, // OS name
-            "version": <string> // OS version
-        },
-        "reason": <string>, // When ping was triggered, e.g. "immediate" or "shutdown".
-        "pingDiscardedForSize": {
-            "main": <number>, // Amount of occurrences for a specific ping type.
-            "core": <number>
-            ...
-        },
-        "sendFailure": {
-            "timeout": <number>, // Amount of occurrences for a specific failure.
-            "abort": <number>
-            ...
-        }
-      }
-    }
-
-Send behavior
--------------
-
-``TelemetryHealthPing.jsm`` tracks several problems:
-
-* The size of other assembled ping exceed the ping limit.
-* There was a failure while sending other ping.
-
-After recording the data, ping will be sent:
-
-* immediately, with the reason ``immediate`` , if it is first ping in the session or it passed at least one hour from the previous submission.
-* after 1 hour minus the time passed from previous submission, with the reason ``delayed`` , if less than an hour passed from the previous submission.
-* on shutdown, with the reason ``shutdown`` , if recorded data is not empty.
-
-Field details
--------------
-
-reason
-~~~~~~
-The ``reason`` field contains the information about when "health" ping was submitted. Now it supports three types:
-
-* immediate: The health ping was submitted immediately after recording a failure.
-* delayed: The health ping was submitted after a delay.
-* shutdown: The health ping was submitted on shutdown.
-
-pingDiscardedForSize
-~~~~~~~~~~~~~~~~~~~~
-The ``pingDiscardedForSize`` field contains the information about top ten pings, whose size exceeded the
-ping size limit (1 mb). This field lists the number of discarded pings per ping type.
-
-This field is optional.
-
-sendFailure
-~~~~~~~~~~~
-The ``sendFailure`` field contains the information about pings, which had failures on sending.
-This field lists the number of failed pings per ping send failure type.
-
-This field is optional.
-
-.. note::
-
-    Although both ``pingDiscardedForSize`` and ``sendFailure`` fields are optional, the health ping will only
-    be submitted if one of this field not empty.