Bug 1461651 - Document that event category is enabled on registration, even if from a static event. r?chutten draft
authorJan-Erik Rediger <jrediger@mozilla.com>
Tue, 29 May 2018 13:07:11 +0200
changeset 800846 96540f58bdde72d381e1e9cb1aef6e179a329181
parent 800719 35aa0dde259f5f51c0aaf86935a54b8087c2e8c6
push id111504
push userbmo:jrediger@mozilla.com
push dateTue, 29 May 2018 11:09:01 +0000
reviewerschutten
bugs1461651
milestone62.0a1
Bug 1461651 - Document that event category is enabled on registration, even if from a static event. r?chutten MozReview-Commit-ID: FWbXYj7hirV
toolkit/components/telemetry/docs/collection/events.rst
--- a/toolkit/components/telemetry/docs/collection/events.rst
+++ b/toolkit/components/telemetry/docs/collection/events.rst
@@ -204,16 +204,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.
+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 the main pings payload under ``processes.dynamic.events``.
 
 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.
 
 Example: