Bug 1561017 - Clarify Event Telemetry docs about dynamic event categories r=janerik
authorChris H-C <chutten@mozilla.com>
Mon, 01 Jul 2019 08:25:20 +0000
changeset 540580 9ea5e6e45f29c75f59d06477123c75b3faf08595
parent 540579 30c37c6d291df4c204d74a02e9c5398937c0a46d
child 540581 a64eedd73f97ab3669a71835bc154ff4d812ffc9
push id11529
push userarchaeopteryx@coole-files.de
push dateThu, 04 Jul 2019 15:22:33 +0000
treeherdermozilla-beta@ebb510a784b8 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjanerik
bugs1561017
milestone69.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 1561017 - Clarify Event Telemetry docs about dynamic event categories r=janerik Differential Revision: https://phabricator.services.mozilla.com/D36337
toolkit/components/telemetry/docs/collection/events.rst
--- a/toolkit/components/telemetry/docs/collection/events.rst
+++ b/toolkit/components/telemetry/docs/collection/events.rst
@@ -193,17 +193,19 @@ Example:
 
 ``setEventRecordingEnabled()``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: js
 
   Services.telemetry.setEventRecordingEnabled(category, enabled);
 
-Event recording is currently disabled by default. Privileged add-ons and Firefox code can enable & disable recording events for specific categories using this function.
+Event recording is currently disabled by default for events registered in Events.yaml.
+Dynamically-registered events (those registered using ``registerEvents()``) are enabled by default, and cannot be disabled.
+Privileged add-ons and Firefox code can enable & disable recording events for specific categories using this function.
 
 Example:
 
 .. code-block:: js
 
   Services.telemetry.setEventRecordingEnabled("ui", true);
   // ... now events in the "ui" category will be recorded.
   Services.telemetry.setEventRecordingEnabled("ui", false);
@@ -230,17 +232,17 @@ Register new events from add-ons.
 
   * ``methods`` - *(required, list of strings)* The valid event methods.
   * ``objects`` - *(required, list of strings)* The valid event objects.
   * ``extra_keys`` - *(optional, list of strings)* The valid extra keys for the event.
   * ``record_on_release`` - *(optional, bool)*
   * ``expired`` - *(optional, bool)* Whether this event entry is expired. This allows recording it without error, but it will be discarded. Defaults to false.
 
 For events recorded from add-ons, registration happens at runtime. Any new events must first be registered through this function before they can be recorded.
-The registered categories will automatically be enabled for recording.
+The registered categories will automatically be enabled for recording, and cannot be disabled.
 If a dynamic event uses the same category as a static event, the category will also be enabled upon registration.
 
 After registration, the events can be recorded through the ``recordEvent()`` function. They will be submitted in event pings like static events are, under the ``dynamic`` process.
 
 New events registered here are subject to the same limitations as the ones registered through ``Events.yaml``, although the naming was in parts updated to recent policy changes.
 
 When add-ons are updated, they may re-register all of their events. In that case, any changes to events that are already registered are ignored. The only exception is expiry; an event that is re-registered with ``expired: true`` will not be recorded anymore.