用于遥测的 WebExtension API¶
使用 browser.telemetry API 将遥测数据发送到 Mozilla 遥测服务。仅限于 Mozilla 权限 WebExtensions。
类型¶
ScalarType¶
标量类型：数值使用 'count'，字符串使用 'string'，布尔值使用 'boolean'。映射到 nsITelemetry.SCALAR_TYPE_*。
ScalarData¶
表示遥测标量的注册数据。
属性
kind- 请参阅 ScalarType。keyed- (可选，布尔值) 如果这是键控标量，则为 true。默认为false。record_on_release- (可选，布尔值) 如果此数据应在发布时记录，则为 true。默认为false。expired- (可选，布尔值) 如果此标量条目已过期，则为 true。对已过期标量的操作不会出错（对未定义标量的操作会出错），但操作是无操作的。不会记录任何数据。默认为false。
EventData¶
表示遥测事件的注册数据。
属性
methods- (数组) 此事件条目的方法列表。objects- (数组) 此事件条目的对象列表。extra_keys- (数组) 此事件条目允许的额外键列表。record_on_release- (可选，布尔值) 如果此数据应在发布时记录，则为 true。默认为false。expired- (可选，布尔值) 如果此事件条目已过期，则为 true。记录已过期事件不会出错（对未定义事件的操作会出错）。不会记录任何数据。默认为false。
函数¶
submitPing¶
browser.telemetry.submitPing(type, message, options);
将自定义 Ping 提交到遥测后端。请参阅 提交自定义 Ping。
type- (字符串) Ping 的类型。message- (对象) Ping 的数据有效负载。options- (可选，对象) 选项对象。addClientId- (可选，布尔值) 如果 Ping 应包含客户端 ID 和配置文件组 ID，则为 true。默认为false。addEnvironment- (可选，布尔值) 如果 Ping 应包含环境数据，则为 true。默认为false。overrideEnvironment- (可选，对象) 设置为覆盖环境数据。默认：未设置。usePingSender- (可选，布尔值) 如果为 true，则使用 PingSender 发送 Ping。默认为false。
canUpload¶
browser.telemetry.canUpload();
检查遥测上传是否已启用。
scalarAdd¶
browser.telemetry.scalarAdd(name, value);
将值添加到给定的标量。
name- (字符串) 标量名称。value- (整数) 要添加到标量的数值。仅支持无符号整数。
scalarSet¶
browser.telemetry.scalarSet(name, value);
将命名标量设置为给定值。如果值类型与标量类型不匹配，则抛出异常。
name- (字符串) 标量名称。value- (字符串|布尔值|整数|对象) 要设置标量到的值。
scalarSetMaximum¶
browser.telemetry.scalarSetMaximum(name, value);
将标量设置为当前值和传递值的较大值
name- (字符串) 标量名称。value- (整数) 要设置标量到的数值。仅支持无符号整数。
recordEvent¶
从 Firefox 132 开始，此方法为无操作。请参阅 错误 1894533。
相反，请使用 Glean API 记录事件。
registerScalars¶
browser.telemetry.registerScalars(category, data);
注册新的标量以从加载项中记录它们。请参阅 registerScalars() 以了解更多详细信息。
category- (字符串) 注册标量的唯一类别。data- (对象) 包含多个标量注册数据的对象。每个属性名称都是标量名称，相应的属性值是 ScalarData 类型的对象。
registerEvents¶
从 Firefox 132 开始，此方法为无操作。请参阅 错误 1894533。
相反，请使用 Glean 事件定义 用于扩展的事件。
setEventRecordingEnabled¶
从 Firefox 133 开始，此方法为无操作。默认情况下，事件记录始终启用。请参阅 错误 1920562。
相反，请使用 Glean 事件定义 用于扩展的事件。