Bug 1253338 - Add docs for core ping creation date fields. r=gfritzsche
authorMichael Comella <michael.l.comella@gmail.com>
Fri, 06 May 2016 14:35:39 -0700
changeset 321078 6ad2696e1878da89486c58e353cd7734deba0d65
parent 321077 40958aebbb80cb96f275abfb9c88c1827b6ee9fa
child 321079 09b791894c43736972be1b29918ee718792a8164
push id9671
push userraliiev@mozilla.com
push dateMon, 06 Jun 2016 20:27:52 +0000
treeherdermozilla-aurora@cea65ca3d0bd [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgfritzsche
bugs1253338
milestone49.0a1
Bug 1253338 - Add docs for core ping creation date fields. r=gfritzsche MozReview-Commit-ID: GQS8tny2BoJ
toolkit/components/telemetry/docs/core-ping.rst
--- a/toolkit/components/telemetry/docs/core-ping.rst
+++ b/toolkit/components/telemetry/docs/core-ping.rst
@@ -20,32 +20,36 @@ Submission will be per the Edge server s
 * ``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::
 
     {
-      "v": 3, // ping format version
+      "v": 5, // 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
       "experiments": [<string>, …], // Optional, array of identifiers
                                     // for the active experiments
     }
 
 Field details
 -------------
 
 device
@@ -103,16 +107,17 @@ all of the following events occur:
 #. 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.
 
 Version history
 ---------------
+* 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
 ~~~~~