1296311 - Plan Event Telemetry integration into addon builds

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[Georg Fritzsche [:gfritzsche]]

We plan to have one YAML event registry file for each individual system addon.
For convenience and error-robustness, we need to integrate into the addon build process to generate automatic event registration with Telemetry.

This will make event properties like expiry, opt-in/opt-out, etc. registered automatically and allows us to discard all unregistered event submissions.

Comment 1

[Georg Fritzsche [:gfritzsche]]

From talking this over with bsmedberg and the addons team, we came up with the following process:
* engineers specify measurements they want record in a "registry" YAML file (in the addons source tree)
* the YAML file would be used for data collection review, documentation, tooling, ...
* at build time, this YAML file is processed and an optimized JSON file gets generated that ships with the addon
* when the addon starts & before it records any measurements, it will call into Telemetry and pass the generated JSON to register its events

I am currently reaching out to potentially affected parties to see whether this seems feasible to integrate into their addon builds:
* test pilot
* shield studies
* e10s system addon
* general GoFaster drivers

Comment 2

[Georg Fritzsche [:gfritzsche]]

While we didn't get feedback from everyone yet, the approach seems to be fine with other teams so far.
I updated the draft with the details and will move forward with this.