.NET Core SDK 遥测.NET Core SDK telemetry

本文内容

.NET Core SDK 包含遥测功能，可在 .NET Core CLI 故障时收集使用情况数据和异常信息。.NET Core CLI 附带 .NET Core SDK，是一组用于生成、测试和发布 .NET Core 应用的谓词。请务必让 .NET 团队了解到工具使用情况，以便我们对其做出改进。有关故障的信息可帮助团队解决问题并修复 bug。

数据为匿名收集，并根据 Creative Commons Attribution 许可证以汇总形式发布。

范围Scope

dotnet 具有两个功能：运行应用程序和执行 CLI 命令。按以下格式使用 dotnet 来启动应用程序时，不会收集遥测数据 ：

  • dotnet [path-to-app].dll使用任何 .NET Core CLI 命令时，都会收集遥测数据，如 ：

  • dotnet build

  • dotnet pack
  • dotnet run

如何选择退出How to opt out

.NET Core SDK 遥测功能默认处于启用状态。要选择退出遥测功能，请将 DOTNET_CLI_TELEMETRY_OPTOUT 环境变量设置为 1 或 true。

如果安装成功，.NET Core SDK 安装程序也会发送一个遥测条目。要选择退出，请在安装 .NET Core SDK 之前设置 DOTNET_CLI_TELEMETRY_OPTOUT 环境变量。

公开Disclosure

首次运行其中一个 .NET Core CLI 命令（例如，dotnet build）时，.NET Core SDK 显示以下类似文本。文本可能会因运行的 SDK 版本而略有不同。此“首次运行”体验是 Microsoft 通知用户有关数据收集信息的方式。

  1. Telemetry

The .NET Core tools collect usage data in order to help us improve your experience. The data is anonymous. It is collected by Microsoft and shared with the community. You can opt-out of telemetry by setting the DOTNET_CLI_TELEMETRY_OPTOUT environment variable to '1' or 'true' using your favorite shell.

Read more about .NET Core CLI Tools telemetry: https://aka.ms/dotnet-cli-telemetry

数据点Data points

遥测功能不收集用户名或电子邮件地址等个人数据。也不会扫描代码，更不会提取项目级敏感数据，如名称、存储库或作者。数据通过 Azure Monitor 技术安全地发送到 Microsoft 服务器，提供对保留数据的受限访问权限，并在严格的安全控制下从安全的 Azure 存储系统发布。

保护你的隐私对我们很重要。如果怀疑遥测在收集敏感数据，或认为我们处理数据的方式不安全或不恰当，请在 dotnet/cli 存储库中记录问题或发送电子邮件至 dotnet@microsoft.com 进行调查。

遥测功能收集以下数据：

SDK 版本数据
全部调用时间戳。
全部调用的命令（例如，“build”），从 2.1 开始进行哈希处理。
全部用于确定地理位置的三个八进制数 IP 地址。
全部操作系统和版本。
全部运行 SDK 的运行时 ID (RID)。
全部.NET Core SDK 版本。
全部遥测配置文件：一个可选值，仅在用户显式选择加入时可用，并在 Microsoft 内部使用。
>=2.0命令参数和选项：收集若干参数和选项（非任意字符串）。请参阅收集的选项。从 2.1.300 后进行哈希处理。
>=2.0SDK 是否在容器中运行。
>=2.0目标框架（来自 TargetFramework 事件），从 2.1 开始进行哈希处理。
>=2.0经过哈希处理的媒体访问控制 (MAC) 地址：计算机的加密 (SHA256) 匿名唯一 ID。
>=2.0经过哈希处理的当前工作目录。
>=2.0安装成功报告，包含进行了哈希处理的安装程序 exe 文件名。
>=2.1.300内核版本。
>=2.1.300Libc 发行/版本。
>=3.0.100是否已重定向输出（true 或 false）。
>=3.0.100CLI/SDK 故障时的异常类型及其堆栈跟踪（发送的堆栈跟踪中仅包含 CLI/SDK 代码）。有关详细信息，请参阅收集的 .NET Core CLI/SDK 故障异常遥测。

收集的选项Collected options

某些命令发送其他数据。小部分命令发送第一个参数：

命令发送的第一个参数数据
dotnet help <arg>正在查询命令帮助。
dotnet new <arg>模板名称（进行哈希处理）。
dotnet add <arg>单词 package 或 reference。
dotnet remove <arg>单词 package 或 reference。
dotnet list <arg>单词 package 或 reference。
dotnet sln <arg>单词 add、list 或 remove。
dotnet nuget <arg>单词 delete、locals 或 push。

一小部分命令发送所选项目（如果使用）及其值：

选项命令
—verbosity所有命令
—languagedotnet new
—configurationdotnet build, dotnet clean, dotnet publish, dotnet run, dotnet test
—frameworkdotnet build, dotnet clean, dotnet publish, dotnet run, dotnet test, dotnet vstest
—runtimedotnet build、dotnet publish
—platformdotnet vstest
—loggerdotnet vstest
—sdk-package-versiondotnet migrate

除 —verbosity 和 —sdk-package-version 外，从 .NET Core 2.1.100 SDK 开始，所有其他值都会进行哈希处理。

收集的 .NET Core CLI/SDK 故障异常遥测.NET Core CLI/SDK crash exception telemetry collected

如果 .NET Core CLI/SDK 故障，则会收集 CLI/SDK 代码的异常和跟踪堆栈名称。收集此信息是为了评估问题并改善 .NET Core SDK 和 CLI 的质量。本文提供了所收集数据的信息。本文还提供了有关生成自己的 .NET Core SDK 版本的用户如何避免无意泄露个人或敏感信息的提示。

收集的数据类型Types of collected data

.NET Core CLI 只收集有关 CLI/SDK 异常的信息，不收集应用程序中的异常信息。收集的数据包含异常和堆栈跟踪的名称。此堆栈跟踪为 CLI/SDK 代码。

下面的示例显示所收集的数据类型：

  1. System.IO.IOException
  2. at System.ConsolePal.WindowsConsoleStream.Write(Byte[] buffer, Int32 offset, Int32 count)
  3. at System.IO.StreamWriter.Flush(Boolean flushStream, Boolean flushEncoder)
  4. at System.IO.StreamWriter.Write(Char[] buffer)
  5. at System.IO.TextWriter.WriteLine()
  6. at System.IO.TextWriter.SyncTextWriter.WriteLine()
  7. at Microsoft.DotNet.Cli.Utils.Reporter.WriteLine()
  8. at Microsoft.DotNet.Tools.Run.RunCommand.EnsureProjectIsBuilt()
  9. at Microsoft.DotNet.Tools.Run.RunCommand.Execute()
  10. at Microsoft.DotNet.Tools.Run.RunCommand.Run(String[] args)
  11. at Microsoft.DotNet.Cli.Program.ProcessArgs(String[] args, ITelemetry telemetryClient)
  12. at Microsoft.DotNet.Cli.Program.Main(String[] args)

避免意外泄露信息Avoid inadvertent disclosure information

.NET Core 参与者以及运行自己生成的 .NET Core SDK 版本的任何其他人都应考虑其 SDK 源代码的路径。如果在使用属于自定义调试生成或者使用自定义生成符号文件配置的 .NET Core SDK 时出现故障，则生成计算机的 SDK 源文件路径将作为堆栈跟踪的一部分收集，并且不会进行哈希处理。

因此，.NET Core SDK 的自定义生成不应位于路径名公开个人或敏感信息的目录中。

请参阅See also