Bug 1210658 - Explicitly document optional Telemetry ping properties. r=dexter
authorGeorg Fritzsche <georg.fritzsche@googlemail.com>
Mon, 19 Oct 2015 18:23:58 +0200
changeset 268338 9a1f6c87afc860defd4da1f5ea249bf492a9d5ff
parent 268337 28a844f6cd11a1023f8bb062f52ed81d4b4d6d87
child 268339 120b11e0e644b9dcf27ba078d0b89ca1f38b3ee3
push id29550
push usercbook@mozilla.com
push dateTue, 20 Oct 2015 09:59:51 +0000
treeherdermozilla-central@3f17d8a0a201 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdexter
bugs1210658
milestone44.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 1210658 - Explicitly document optional Telemetry ping properties. r=dexter
toolkit/components/telemetry/docs/main-ping.rst
--- a/toolkit/components/telemetry/docs/main-ping.rst
+++ b/toolkit/components/telemetry/docs/main-ping.rst
@@ -38,27 +38,28 @@ Structure::
         profileSubsessionCounter: <number>, // 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: <number>, // the session length until now in seconds, monotonic
         subsessionLength: <number>, // the subsession length in seconds, monotonic
       },
 
-      childPayloads: {...}, // only present with e10s; a reduced payload from content processes
+      childPayloads: {...}, // only present with e10s; a reduced payload from content processes, null on failure
+      simpleMeasurements: {...},
 
-      simpleMeasurements: { ... },
-      histograms: {},
-      keyedHistograms: {},
-      chromeHangs: {},
-      threadHangStats: {},
-      log: [],
+      // The following properties may all be null if we fail to collect them.
+      histograms: {...},
+      keyedHistograms: {...},
+      chromeHangs: {...},
+      threadHangStats: {...},
+      log: [...],
       fileIOReports: {...},
       lateWrites: {...},
-      addonDetails: { ... },
+      addonDetails: {...},
       addonHistograms: {...},
       UIMeasurements: {...},
       slowSQL: {...},
       slowSQLstartup: {...},
     }
 
 info
 ----