使用 Firefox on Glean 记录旧版遥测事件¶
要使用 Glean API 记录旧版遥测事件,您需要以下两样东西
一个 Glean 事件定义来生成 Glean API
这将放在一个
metrics.yaml
文件中 可能在您的组件中如果您熟悉遥测事件,您可能希望阅读 这部分简短内容,了解 Glean 事件的不同之处。
在 Glean
event
指标文档 中有一个 示例定义,您可能会发现它很有用。如果您已经知道一个与您想要的类似的旧版遥测事件定义,您可以使用
./mach gifft <Legacy Telemetry event name like readermode.view>
从该旧版遥测事件定义生成一个 Gleanevent
指标定义。
一个旧版遥测事件定义,用于 Glean 接口用于 Firefox 遥测 镜像
使用
./mach event-into-legacy <Glean event metric name like privacy.sanitize.dialog_open>
自动生成此定义。将其放在
toolkit/components/telemetry/Events.yaml
中确保将
telemetry-mirror
属性添加到步骤 1 中的 Gleanevent
定义中。您可以按照./mach event-into-legacy
输出中的说明操作,或 此指南手动确定旧版遥测事件的枚举名称。
现在构建 Firefox。
要记录您的新事件,请使用 Glean record(...)
API。
要测试您的新事件,请使用 Glean testGetValue()
API。
当您的代码被触发时,您的旧版遥测事件将显示在 about:telemetry
中,以确认一切按预期工作。
构件构建支持¶
Firefox on Glean 支持构件构建,因此您可以使用构件构建来检测和测试您的 Glean 检测。但是,镜像需要使用旧版遥测事件的 C++ 枚举,这意味着测试旧版遥测事件或在 about:telemetry
中查看其值 需要完整编译的构建。