Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The dotnet-coverage global tool and Microsoft.CodeCoverage.Console.exe collect telemetry data to help Microsoft understand how to improve the products. For example, this usage data helps prioritize new features and debug issues. Both tools share the same command surface, so they collect the same telemetry.
You can disable telemetry at any time. For more information about how Microsoft handles data, see the Microsoft Privacy Statement.
Types of telemetry data
The code coverage tools collect only Usage Data. The usage data indicates which commands are used and which options are set when the tools run. This information helps Microsoft prioritize product improvements.
Disable telemetry reporting
To disable telemetry, set the DOTNET_COVERAGE_TELEMETRY_OPTOUT environment variable to 1.
Telemetry is also disabled when the standard .NET CLI opt-out variable DOTNET_CLI_TELEMETRY_OPTOUT is set to 1. Therefore, opting out of .NET SDK telemetry also opts you out of telemetry from the code coverage tools.
Disclosure
The tools display text similar to the following the first time you run them. This first-run experience notifies you about data collection.
Telemetry
---------
The code coverage tools collect usage data in order to help us improve your experience. The data is collected by Microsoft. You can opt out of telemetry by setting the DOTNET_COVERAGE_TELEMETRY_OPTOUT environment variable to '1' using your favorite shell.
This message is displayed only once. Set the DOTNET_COVERAGE_NOLOGO environment variable to '1' to suppress it in the future.
The notice is displayed only once. To suppress it, for example in scripts or continuous integration (CI), set the DOTNET_COVERAGE_NOLOGO environment variable to 1 or true. This behavior mirrors DOTNET_NOLOGO.
Data points
The telemetry feature doesn't collect personal data, such as usernames or email addresses. It doesn't scan your code or extract project-level data, such as the repository or author.
It doesn't extract the contents of data files accessed or created by your applications, memory dumps of your application objects, or clipboard contents.
The data is sent securely to Microsoft servers by using Azure Monitor technology. The data is held under restricted access and published under strict security controls from secure Azure Storage systems.
Values that might contain user data, such as file paths, the user-provided session ID (from --session-id), and command lines, are never sent verbatim. Instead, only the fact that an option or argument was provided is recorded as the Boolean value true.
If you suspect that telemetry is collecting sensitive data or that data is being handled insecurely or inappropriately, file an issue in the microsoft/codecoverage GitHub repository.
The telemetry feature collects the following data points:
| Version | Data |
|---|---|
| 18.10 | Name of the tool that produced the event, such as dotnet-coverage or Microsoft.CodeCoverage.Console. |
| 18.10 | Version of the tool. |
| 18.10 | Version of the telemetry schema. |
| 18.10 | Operating system, version, and architecture. |
| 18.10 | Process architecture. |
| 18.10 | .NET runtime framework. |
| 18.10 | Runtime identifier (RID). For more information, see .NET RID Catalog. |
| 18.10 | Whether the tool is running in a CI environment. |
| 18.10 | Three-octet IP address used to determine the geographical location. |
| 18.10 | Timestamp of invocation. |
| 18.10 | Auto-generated correlation ID (a GUID) used to correlate events from a single tool run. This value is distinct from the user-provided session ID. |
| 18.10 | Name of the command invoked, such as collect or merge. |
| 18.10 | Whether a settings file was provided. |
| 18.10 | Whether an output path was provided. |
| 18.10 | Whether a list of include files was provided. |
| 18.10 | Whether application arguments were provided for the connect command. |
| 18.10 | Whether a log file path was provided. |
| 18.10 | Whether server mode was enabled. |
| 18.10 | Whether background mode was enabled. |
| 18.10 | Whether input files are removed after a merge. |
| 18.10 | Whether a recursive merge was requested. |
| 18.10 | Whether the snapshot was reset. |
| 18.10 | Whether a tag name was provided. |
| 18.10 | Whether a tag identifier was provided. |
| 18.10 | Whether dependencies are instrumented. |
| 18.10 | Whether console output was disabled. |
| 18.10 | Whether the logo or first-run notice was suppressed. |
| 18.10 | Output format, such as cobertura or xml. |
| 18.10 | Log level, such as Debug. |
| 18.10 | Timeout value. |
Shared context
Because telemetry is delivered through Azure Application Insights, each event also includes standard, nonpersonal context: the operating system description and a randomly generated correlation ID used to correlate events from a single run. This correlation ID isn't the user-provided session ID. This context doesn't include the contents of your code, assemblies, or coverage data.