遥测扩展作者指南
Visual Studio Code 收集使用情况数据并将其发送给 Microsoft,以帮助改进我们的产品和服务。阅读我们的隐私声明和遥测文档了解更多信息。
本主题为扩展作者提供了指南,以便他们的扩展可以符合 VS Code 遥测要求和最佳实践。
注意:如果你不想向 Microsoft 发送使用情况数据,可以将
telemetry.telemetryLevel
用户设置为off
。
遥测模块
VS Code 团队维护着 @vscode/extension-telemetry npm 模块,它提供了一种在 VS Code 中收集遥测的一致且安全的方式。该模块将遥测报告给 Azure Monitor 和 Application Insights,并保证与旧版 VS Code 的向后兼容性。
按照本指南设置Azure Monitor 并获取你的 Application Insights 检测密钥。
不使用遥测模块
不希望使用 Application Insights 的扩展作者可以利用自己的自定义解决方案发送遥测数据。在这种情况下,扩展作者仍然需要通过使用 isTelemetryEnabled
和 onDidChangeTelemetryEnabled
API 来尊重用户的选择。通过这样做,用户将有一个集中的地方来控制他们的遥测设置。
自定义遥测设置
扩展可能希望为用户提供对独立于 VS Code 遥测的扩展特定遥测的控制权。在这种情况下,我们建议你引入一个特定的扩展设置。建议将自定义遥测设置标记为 telemetry
和 usesOnlineServices
,以便用户可以在设置 UI 中更轻松地查询它们。添加自定义遥测设置并不意味着可以不尊重用户的决定,并且必须始终尊重 isTelemetryEnabled
和 onDidChangeTelemetryEnabled
标志。如果 isTelemetryEnabled
报告为 false,即使你的设置已启用,也绝不能发送遥测数据。
telemetry.json
我们理解遥测对于许多用户来说可能是一个敏感话题,我们的目标是尽可能保持透明。核心 VS Code 产品和大多数第一方扩展在其根目录中都包含一个 telemetry.json
文件。这允许用户使用带有 --telemetry
标志的 VS Code CLI 来接收 VS Code 生成的所有遥测数据的转储。扩展作者可以在其根目录中包含 telemetry.json
文件,该文件也将出现在 CLI 转储中。
注意事项
✔️ 建议
- 如果使用 Application Insights 适合你,请使用 @vscode/extension-telemetry npm 模块。
- 否则,请尊重
isTelemetryEnabled
和onDidChangeTelemetryEnabled
API。 - 如果你有自定义遥测设置,请将其标记为
telemetry
和usesOnlineServices
。 - 尽可能少地收集遥测数据。
- 尽可能向用户透明地说明你收集了什么数据。
❌ 不建议
- 引入未经用户同意的自定义遥测收集解决方案。
- 收集个人身份信息 (PII)。
- 收集不必要的遥测数据。
- 仅使用
telemetry.telemetryLevel
设置,因为它与isTelemetryEnabled
相比有时可能不准确。