遥测 - 实现、审查、续期¶
请参阅 https://github.com/mozilla-mobile/fenix/wiki/Telemetry-Checklist,了解实现新探针的步骤。
创建 Glean 注解¶
Glean 注解存储库:https://github.com/mozilla/glean-annotations
请参阅 为事件添加 Glean 注解 获取说明。
更多信息 此处
数据审查¶
所有添加新遥测或修改现有遥测的 PR 都需要进行数据审查。
填写完表单后,请联系 数据管理员 安排审查。注意:数据审查并不替代代码审查!PR 必须经过数据审查和代码审查才能合并。
数据审查完成后,将审批链接添加到
metrics.yaml
文件中指标的data_reviews
子部分。示例
download_notification:
resume:
type: event
description: |
A user resumed a download in the download notification
bugs:
- https://github.com/mozilla-mobile/fenix/issues/5583
data_reviews:
- https://github.com/mozilla-mobile/fenix/pull/6554
- https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
- https://github.com/mozilla-mobile/fenix/pull/18143
data_sensitivity:
- interaction
notification_emails:
- fenix-core@mozilla.com
expires: "2021-07-01"
续期遥测探针时,请勿从 metrics.yaml
中删除旧的数据审查链接。新的审批应添加到现有列表中。
确保您选择了正在收集的数据的正确类别:https://wiki.mozilla.org/Data_Collection#Data_Collection_Categories
续期现有遥测¶
从 Fenix 的 metrics.yaml 文件中收集将在该月到期的指标列表 a. 目前正在 此文档 中编译这些指标 b. 这应该在事件/指标到期日期至少几周前完成 c. 包括指标名称、原始数据审查 PR 链接、描述(如果名称不清楚)
确定每个指标的所有者(谁需要批准续期/删除) a. 大多数续期都需要产品审批 b. 其他审批可能来自工程团队(例如
preferences.remote_debugging_enabled
)、GV、应用程序服务、性能(例如startup.timeline.framework_primary
)等。回答指标所有者提出的任何未解决的问题,并获得他们的批准以:a. 续期指标(多长时间?6 个月?1 年?) b. 选择不续期(但不删除) c. 选择删除指标 d. 续期指标并设置为永不过期(这仅适用于业务关键指标)
填写每个指标的 续期请求,其中问题 3(“为什么最初的收集期限不足?”)由所有者回答
为续期打开 PR a. 如果有多个所有者,有时将续期拆分为多个 PR 会更容易:例如 产品续期、性能续期、Fission 续期(2021 年 12 月)
获得 续期请求 的数据审查,并在 metrics.yaml 中更新每个指标的数据审查以反映这一点
审批流程¶
对于我们想要续期的每个遥测探针,数据审查将向我们询问 这些问题。每个探针/相关探针组都应有这些问题的答案(示例)。
续期数据请求示例¶
# Request for Data Collection Renewal
`search_shortcuts:`
selected
1) Provide a link to the initial Data Collection Review Request for this collection.
- https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449
- https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
- https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
2) When will this collection now expire? 08/01/2022
3) Why was the initial period of collection insufficient?
Important for revenue tracking and optimization.
`Toolbar_settings:`
changed_position:
1) Provide a link to the initial Data Collection Review Request for this collection.
- https://github.com/mozilla-mobile/fenix/pull/6608
- https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
- https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
2) When will this collection now expire? 08/01/2022
3) Why was the initial period of collection insufficient?
The data didn’t initially tell us what we wanted (there were bugs), so we want to continue tracking this so we can answer our questions.
`login_dialog:`
displayed:
cancelled
saved
never_save
1) Provide a link to the initial Data Collection Review Request for this collection.
- https://github.com/mozilla-mobile/fenix/pull/13050
- https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
2) When will this collection now expire? 08/01/2022
3) Why was the initial period of collection insufficient?
Still need to optimize this feature and we want trends from 6+mo of data.
对于产品定义的遥测,这将涉及与产品经理会面并讨论每个探针。有三个选项:将探针续期一段时间(通常为 6 个月)、让探针过期以稍后评估是否仍然需要探针,或完全删除探针。