1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
Glean Parser
=============
This linter verifies that Glean telemetry definitions files (metrics.yaml
and pings.yaml) are following the Glean schema and best practices
by using the built-in linting functionality from ``glean_parser``.
Common Issues
-------------
Empty Data Review
~~~~~~~~~~~~~~~~~
The most common error is having empty or placeholder values in the ``data_reviews`` field:
.. code-block:: yaml
metrics:
example:
counter_metric:
data_reviews:
- "" # This will cause an error
- "TODO" # This will also cause an error
The ``data_reviews`` field must contain a valid URL to a data review.
Run Locally
-----------
This mozlint linter can be run using mach:
.. parsed-literal::
$ mach lint --linter glean-parser <file paths>
To run on all Glean configuration files:
.. parsed-literal::
$ mach lint --linter glean-parser .
Configuration
-------------
This linter is enabled by default and will run automatically when you make changes to Glean definitions files.
Sources
-------
* :searchfox:`Configuration (YAML) <tools/lint/glean-parser.yml>`
* :searchfox:`Source <tools/lint/glean-parser/__init__.py>`
|
