File: telemetry.rst

package info (click to toggle)
firefox-esr 140.7.0esr-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,552,668 kB
  • sloc: cpp: 7,431,180; javascript: 6,390,089; ansic: 3,712,363; python: 1,393,777; xml: 628,165; asm: 426,916; java: 184,004; sh: 65,744; makefile: 19,302; objc: 13,059; perl: 12,912; yacc: 4,583; cs: 3,846; pascal: 3,352; lex: 1,720; ruby: 1,226; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (37 lines) | stat: -rw-r--r-- 1,113 bytes parent folder | download | duplicates (20) 
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