blob: 2d185a970e6dfcf32fcdcab9f76ace0c2d140e94 (
plain)
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
|
.. _mach_telemetry:
==============
Mach Telemetry
==============
`Glean <https://mozilla.github.io/glean/>`_ is used to collect telemetry, and uses the metrics
defined in the ``metrics.yaml`` files in-tree.
These files are all documented in a single :ref:`generated file here<metrics>`.
.. toctree::
:maxdepth: 1
metrics
Adding Metrics to a new Command
===============================
If you would like to submit telemetry metrics from your mach ``@Command``, you should take two steps:
#. Parameterize your ``@Command`` annotation with ``metrics_path``.
#. Use the ``command_context.metrics`` handle provided by ``MachCommandBase``
For example::
METRICS_PATH = os.path.abspath(os.path.join(__file__, '..', '..', 'metrics.yaml'))
@Command('custom-command', metrics_path=METRICS_PATH)
def custom_command(command_context):
command_context.metrics.custom.foo.set('bar')
Updating Generated Metrics Docs
===============================
When a ``metrics.yaml`` is added/changed/removed, :ref:`the metrics document<metrics>` will need to be updated::
./mach doc mach-telemetry
|
