Bug 1339195 - Clearly document event extra fields requiring string keys and values. r=Dexter
authorGeorg Fritzsche <georg.fritzsche@googlemail.com>
Tue, 09 May 2017 14:49:46 +0700
changeset 357288 e69c902071600ff38c287b8891435251807cd637
parent 357287 7c66e8805fcb1e42b529325911c8b059e4f36ff4
child 357289 6baa8102c70d55ad18c93728f270663ad6513d77
push id90086
push userryanvm@gmail.com
push dateTue, 09 May 2017 14:38:30 +0000
treeherdermozilla-inbound@6baa8102c70d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersDexter
bugs1339195
milestone55.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 1339195 - Clearly document event extra fields requiring string keys and values. r=Dexter
toolkit/components/telemetry/docs/collection/events.rst
--- a/toolkit/components/telemetry/docs/collection/events.rst
+++ b/toolkit/components/telemetry/docs/collection/events.rst
@@ -38,17 +38,17 @@ Each event is of the form:
 
 Where the individual fields are:
 
 - ``timestamp``: ``Number``, positive integer. This is the time in ms when the event was recorded, relative to the main process start time.
 - ``category``: ``String``, identifier. The category is a group name for events and helps to avoid name conflicts.
 - ``method``: ``String``, identifier. This describes the type of event that occured, e.g. ``click``, ``keydown`` or ``focus``.
 - ``object``: ``String``, identifier. This is the object the event occured on, e.g. ``reload_button`` or ``urlbar``.
 - ``value``: ``String``, optional, may be ``null``. This is a user defined value, providing context for the event.
-- ``extra``: ``Object``, optional, may be ``null``. This is an object of the form ``{"key": "value", ...}``, used for events where additional context is needed.
+- ``extra``: ``Object``, optional, may be ``null``. This is an object of the form ``{"key": "value", ...}``, both keys and values need to be strings. This is used for events where additional richer context is needed.
 
 .. _eventlimits:
 
 Limits
 ------
 
 Each ``String`` marked as an identifier is restricted to the following regex pattern: ``^[:alpha:][:alnum:_.]*[:alnum:]$``.