1497800 - Implement a generic metric registry parser

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Alessio Placitelli [:Dexter]]

This bug is about designing and implementing a generic YAML metric registry parser for the mobile SDK. The same generic parser could be eventually used on desktop as well.

On Firefox for Desktop, we have a few different parsers (histograms, events, scalars, use counters) that all share the same features: they parse JSON or YAML files, look for specific metric properties, check for valid values, abstract the read data as Python object and then transform these objects to some language constructs (C++ on Desktop).

The Mobile SDK supports many different metric types. We should aim for a design that:

- allows to read one or more YAML file (even if only one file is used in early development, on mobile);
- allows to define the supported types and the expected values for the metric specific properties;
- allows to define how the extracted data is transformed into the final language (Kotlin for the mobile SDK);

Comment 1

[Michael Droettboom [:mdroettboom]]

Design document: https://docs.google.com/document/d/1uJyjnq3-fPv9QWTdCi9rm7vIuZcFNdoveLD5Vkh0FMs/edit?usp=sharing

Comment 2

[Alessio Placitelli [:Dexter]]

Attachment: GitHub Pull Request

Comment 3

[Michael Droettboom [:mdroettboom]]

The first pass of the implementation has been reviewed and merged.

The repository URL is: https://github.com/mozilla/glean_parser

Coming next:
- PyPI deployment
- Usage docs

Comment 4

[Michael Droettboom [:mdroettboom]]

Attachment: PyPI entry for this project