Mach 遥测

Glean 用于收集遥测数据,并使用树内 metrics.yaml 文件中定义的指标。这些文件都在一个 生成的文档中进行了说明。

向新的命令添加指标

如果您想从您的 mach @Command 提交遥测指标,您应该执行以下两个步骤

  1. 使用 metrics_path 参数化您的 @Command 注解。

  2. 使用 MachCommandBase 提供的 command_context.metrics 处理程序

例如

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')

更新生成的指标文档

当添加/更改/删除 metrics.yaml 时,需要更新 指标文档

./mach doc mach-telemetry