Firefox 上的 Glean 入门 (FOG)

本文档旨在帮助以下人群:

  • Firefox 桌面版数据收集新手

  • 熟悉 Firefox 桌面版数据收集,但不了解 Glean 类型

  • 希望复习相关知识的人员。

什么是 FOG?

Firefox 上的 Glean (FOG) 是一个库,它将 Glean SDK(Mozilla 的现代数据收集系统)引入到 Firefox 桌面版中。

FOG 的代码位于 toolkit/components/glean 中,被认为是 Toolkit :: Telemetry 模块 的一部分。针对 FOG 的 Bug 可以 在 Bugzilla 中提交,产品为 Toolkit,组件为 Telemetry。(请勿提交有关添加新检测的 Bug。您可以将这些 Bug 提交到您想要检测的组件中。)您可以在以下地方找到可以帮助您解答有关 FOG 问题的人员:

除了 Glean 嵌入器通常提供的功能(用户参与度监控、网络上传配置、数据上传偏好监视等)之外,FOG 还提供了特定于 Firefox 桌面的功能

  • 特权 JS API

  • C++ API

  • IPC

  • 测试偏好设置

  • 支持 xpcshell、浏览器 chrome mochitests、GTest 和 rusttests

  • about:glean

  • …等等。

关于 Glean 我需要了解什么?

您可以使用 Glean SDK 提供的 API 来检测 Mozilla 项目。

检测的单位是**指标**。记录用户打开新标签页的次数?这是一个指标。计时每次 JS 垃圾回收器执行需要多长时间?也是一个指标。

Glean 有关于 如何添加新指标 的文档,您应该阅读它以了解如何向 Firefox 桌面版添加指标。您还应该查看一些 Firefox 桌面版特有的细节。不要忘记为 mozilla 项目中的任何新的或扩展的数据收集获得 数据收集审查

通过添加指标,您告诉了 Glean SDK 您想要的检测形状。通过使用指标的 API 来检测您的代码,您将有趣的数据放入了该指标中。但是,数据如何离开 Firefox 桌面版并到达 Mozilla 的数据管道?

相关指标的批次被收集到**Ping**中,并根据其特定的时间表提交。如果您没有另行说明,任何非 event 指标都将发送到 内置的 Glean“metrics”Ping 中,大约每天一次。(event 指标发送到 “events”Ping 中,频率更高)。

数据发送到 Mozilla 的数据管道后,如何分析它?

在不知道您要回答的许多问题的情况下,这个问题是不可能完全回答的。但是,一般来说,如果您想查看您的检测正在收集哪些数据,请 转到 Glean Dictionary 中的页面,您将在那里找到有关如何继续操作的链接和信息。

在哪里可以了解更多信息?

FOG 用户文档 中,您将找到 FOG 特定的详细信息,例如 如何编写检测测试,或 如何使用 Glean API 将数据镜像到 Telemetry

作为检测器,您应该关注的大部分内容都记录在 Glean 指南 中。例如,其 说明性术语表所有指标类型的列表,或我们长期运行的博客系列 本周的 Glean 的索引。

对于您需要的任何其他帮助,请在 #glean:mozilla.org 中找到我们。我们很乐意帮助您了解更多关于 FOG 和 Glean 的信息。