遥测扩展作者指南

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 不一致。