Bug 1325243 - Update UI Telemetry docs to reflect usage of "extras". r=grisha draft
authorChenxia Liu <liuche@mozilla.com>
Wed, 21 Dec 2016 17:04:45 -0800
changeset 452716 19faab136578f616014212538a1f2996b1b3a0a2
parent 452404 10a5e2fc24e4e24fbe115fb190bcc28df4627ee2
child 540275 e35f849def6bc1b0ffbe568efeede80c652fe2c1
push id39458
push usercliu@mozilla.com
push dateThu, 22 Dec 2016 01:18:25 +0000
reviewersgrisha
bugs1325243
milestone53.0a1
Bug 1325243 - Update UI Telemetry docs to reflect usage of "extras". r=grisha MozReview-Commit-ID: 9FBXQioCZ2A
mobile/android/docs/uitelemetry.rst
--- a/mobile/android/docs/uitelemetry.rst
+++ b/mobile/android/docs/uitelemetry.rst
@@ -61,17 +61,17 @@ Events capture key occurrences. They sho
 
 ``action``
   The name of the event. Should be brief and lowercase. If needed, you can make use of namespacing with a '``.``' separator. Example event names: ``panel.switch``, ``panel.enable``, ``panel.disable``, ``panel.install``.
 
 ``method`` (Optional)
   Used for user actions that can be performed in many ways. This field specifies the method by which the action was performed. For example, users can add an item to their reading list either by long-tapping the reader icon in the address bar, or from within reader mode. We would use the same event name for both user actions but specify two methods: ``addressbar`` and ``readermode``.
 
 ``extras`` (Optional)
-  For extra information that may be useful in understanding the event. Make an effort to keep this brief.
+  For extra information that may be useful in understanding the event (such as a short string, a json blob, etc).
 
 ``timestamp`` (Optional)
   The time at which the event occurred. If not specified, this field defaults to the current value of the realtime clock.
 
 Versioning
 ==========
 
 As a we improve on our Telemetry methods, it is foreseeable that our probes will change over time. Different versions of a probe could carry different data or have different interpretations on the server-side. To make it easier for the server to handle these changes, you should add version numbers to your event and session names. An example of a versioned session is ``homepanel.1``; this is version 1 of the ``homepanel`` session. This approach should also be applied to event names, an example being: ``panel.enable.1`` and ``panel.enable.2``.