Sylvestre Ledru
4965b8c815
Convert python/{docs,mach/docs,mozperftest/perfdocs,mozboot,
mozbuild/mozbuild/vendor/docs} RST to MyST-flavored Markdown, plus
the top-level READMEs for python/mach, python/mozboot, and
python/mozperftest.
Differential Revision: https://phabricator.services.mozilla.com/D304229
1001 B
1001 B
(mach-telemetry)=
Mach Telemetry
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>.
: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
@Commandannotation withmetrics_path. - Use the
command_context.metricshandle provided byMachCommandBase
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