1580812 - Add a "linter" for Glean metrics

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, defect, P1)

Description

[Michael Droettboom [:mdroettboom]]

It would be nice to have an automated way to fail when suggestions about Glean metrics aren't being followed.

Example of some checks:

• if the name of the metric starts with the category name
• if the name contains a unit

It is unlikely we'll be able to create something "perfect". I would prefer make these violations hard fail -- if they are just warnings, they will just be lost in a sea of build output. Therefore, we will need some way to opt-out on a case-by-case basis.

I would propose adding a new metric parameter "no_lint", which is an object mapping metric parameter names to lists of linting checks to skip for that parameter. For example:

performance:
   performance_frame_load:
      no_lint:
         name:
            - REDUNDANT_CATEGORY

The error message when lints fail would describe how to do this to make it easy for the user.

Comment 1

[Alessio Placitelli [:Dexter]]

Note: 'glinter' and 'glint' are good tool names (from IRC :D)

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c8bec0d818a6
[components] 1580812: Add "glinter" for linting glean metrics