bug 1490945 - Improve Telemetry Event docs slightly r=Dexter
authorChris H-C <chutten@mozilla.com>
Wed, 24 Oct 2018 06:12:28 +0000
changeset 491160 1dc4651530f8290007b9440c9013493cc0ef65f2
parent 491159 481aad44be651f02ef3c7596802011ccd40631c1
child 491161 b732bad1fa11286fd516c37501a79cab475a921a
push id247
push userfmarier@mozilla.com
push dateSat, 27 Oct 2018 01:06:44 +0000
reviewersDexter
bugs1490945
milestone65.0a1
bug 1490945 - Improve Telemetry Event docs slightly r=Dexter Differential Revision: https://phabricator.services.mozilla.com/D9562
toolkit/components/telemetry/docs/collection/events.rst
--- a/toolkit/components/telemetry/docs/collection/events.rst
+++ b/toolkit/components/telemetry/docs/collection/events.rst
@@ -14,17 +14,17 @@ For events recorded into Firefox Telemet
 
     Every new data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection#Requesting_Approval>`_ from a data collection peer. Just set the feedback? flag for one of the data peers. We try to reply within a business day.
 
 .. _events.serializationformat:
 
 Serialization format
 ====================
 
-Events are submitted as an array, e.g.:
+Events are submitted in an :doc:`../data/event-ping` as an array, e.g.:
 
 .. code-block:: js
 
   [
     [2147, "ui", "click", "back_button"],
     [2213, "ui", "search", "search_bar", "google"],
     [2892, "ui", "completion", "search_bar", "yahoo",
       {"querylen": "7", "results": "23"}],
@@ -129,16 +129,20 @@ The following event properties are valid
 - ``extra_keys`` *(optional, object)*: An object that specifies valid keys for the ``extra`` argument and a description - see the example above.
 - ``products`` *(optional, list of strings)*: A list of products the event can be recorded on. It defaults to ``all``. Currently supported values are:
 
   - ``firefox``
   - ``fennec``
   - ``geckoview``
   - ``all`` (record on all products)
 
+.. note::
+
+  Combinations of ``category``, ``method``, and ``object`` defined in the file must be unique.
+
 The API
 =======
 
 Public JS API
 -------------
 
 ``recordEvent()``
 ~~~~~~~~~~~~~~~~~