Skip to content

Commit d45bdfb

Browse files
authored
Update telemetry topic (#6062)
* update topic * remove outdated link * update links * reduce line length
1 parent c60adfb commit d45bdfb

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

docs/core/tools/telemetry.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: .NET Core CLI Tools telemetry
3-
description: Discover the .NET Core tools telemetry features that collect usage information for analysis, which data is collected and how to disable it.
2+
title: .NET Core SDK telemetry
3+
description: Discover the .NET Core SDK telemetry features that collect usage information for analysis, which data is collected and how to disable it.
44
author: richlander
55
ms.author: mairaw
6-
ms.date: 08/04/2017
6+
ms.date: 06/20/2018
77
---
8-
# .NET Core CLI Tools telemetry
8+
# .NET Core SDK telemetry
99

10-
The [.NET Core SDK](index.md) includes a [telemetry feature](https://github.com/dotnet/cli/pull/2145) that collects usage information. It's important that the .NET Team understands how the tools are used so that we can improve them. For more information, see [What we've learned from .NET Core SDK Telemetry](https://blogs.msdn.microsoft.com/dotnet/2017/07/21/what-weve-learned-from-net-core-sdk-telemetry/).
10+
The [.NET Core SDK](index.md) includes a [telemetry feature](https://github.com/dotnet/cli/tree/master/src/dotnet/Telemetry) that collects usage information. It's important that the .NET Team understands how the tools are used so they can be improved. For more information, see [What we've learned from .NET Core SDK Telemetry](https://blogs.msdn.microsoft.com/dotnet/2017/07/21/what-weve-learned-from-net-core-sdk-telemetry/).
1111

12-
The collected data is anonymous and published in an aggregated form for use by both Microsoft and the community under the [Creative Commons Attribution License](https://creativecommons.org/licenses/by/4.0/).
12+
The collected data is anonymous and published in an aggregated form for use by both Microsoft and the community under the [Creative Commons Attribution License](https://creativecommons.org/licenses/by/4.0/).
1313

1414
## Scope
1515

@@ -27,10 +27,9 @@ Telemetry *is enabled* when using the [.NET Core CLI commands](index.md), such a
2727
- `dotnet restore`
2828
- `dotnet run`
2929

30+
## How to opt out
3031

31-
## Behavior
32-
33-
The .NET Core CLI Tools telemetry feature is enabled by default. Opt-out of the telemetry feature by setting the `DOTNET_CLI_TELEMETRY_OPTOUT` environment variable to `1` or `true`.
32+
The .NET Core SDK telemetry feature is enabled by default. Opt out of the telemetry feature by setting the `DOTNET_CLI_TELEMETRY_OPTOUT` environment variable to `1` or `true`.
3433

3534
## Data points
3635

@@ -52,16 +51,17 @@ Starting with .NET Core SDK 2.0, new data points are collected:
5251
- `dotnet` command arguments and options: only known arguments and options are collected (not arbitrary strings).
5352
- Whether the SDK is running in a container.
5453
- Target frameworks.
55-
- Hashed MAC address: a cryptographically (SHA256) anonymous and unique ID for a machine. This metric is not published.
54+
- Hashed MAC address: a cryptographically (SHA256) anonymous and unique ID for a machine. This metric isn't published.
5655
- Hashed current working directory.
5756

5857
The feature doesn't collect personal data, such as usernames or email addresses. It doesn't scan your code and doesn't extract sensitive project-level data, such as name, repo, or author. The data is sent securely to Microsoft servers using [Microsoft Azure Application Insights](https://azure.microsoft.com/services/application-insights/) technology, held under restricted access, and published under strict security controls from secure [Azure Storage](https://azure.microsoft.com/services/storage/) systems.
5958

60-
We want to know how the tools are used and if they're working well, not what you're building with the tools. If you suspect that the telemetry is collecting sensitive data or that we're insecurely or inappropriately handling data, [file an issue in the dotnet/cli repo issues](https://github.com/dotnet/cli/issues) for investigation.
59+
The .NET team wants to know how the tools are used and if they're working well, not what you're building with the tools. If you suspect that the telemetry is collecting sensitive data or that the data is being insecurely or inappropriately handled, file an issue in the [dotnet/cli](https://github.com/dotnet/cli/issues) repository for investigation.
6160

6261
## Published data
6362

6463
Published data is available quarterly and are listed at [.NET Core SDK Usage Data](https://github.com/dotnet/core/blob/master/release-notes/cli-usage-data.md). The columns of a data file are:
64+
6565
- Timestamp
6666
- Occurrences†
6767
- Command
@@ -71,7 +71,7 @@ Published data is available quarterly and are listed at [.NET Core SDK Usage Dat
7171
- OSVersion
7272
- SDKVersion
7373

74-
†The *Occurrences* column displays the aggregate count of that command's use for that row's metrics that day.
74+
†The *Occurrences* column displays the aggregate count of that command's use for that row's metrics that day.
7575

7676
‡Typically, the *Geography* column displays the name of a country. In some cases, the continent of Antarctica appears in this column, either due to researchers using .NET Core in Antarctica or incorrect location data.
7777

@@ -86,13 +86,13 @@ Published data is available quarterly and are listed at [.NET Core SDK Usage Dat
8686
[2016 - Q3](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2016-q3.tsv)
8787
[2016 - Q4](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2016-q4.tsv)
8888
[2017 - Q1](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2017-q1.tsv)
89-
[2017 - Q2](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2017-q2.tsv)
89+
[2017 - Q2](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2017-q2.tsv)
90+
[2017 - Q3](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2017-q3.tsv)
91+
[2017 - Q4](https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-2017-q4.tsv)
9092

91-
Additional datasets are posted using a standard URL format. Replace `<YEAR>` with the year and replace `<QUARTER>` with the quarter of the year (use `1`, `2`, `3`, or `4`). The files are in tab-separated values (*TSV*) format.
93+
Additional datasets are posted using a standard URL format. Replace `<YEAR>` with the year and replace `<QUARTER>` with the quarter of the year (use `1`, `2`, `3`, or `4`). The files are in tab-separated values (*TSV*) format.
9294

93-
```
94-
https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-<YEAR>-q<QUARTER>.tsv
95-
```
95+
`https://dotnetcli.blob.core.windows.net/usagedata/dotnet-cli-usage-<YEAR>-q<QUARTER>.tsv`
9696

9797
## License
9898

@@ -104,22 +104,26 @@ The Microsoft distribution of .NET Core is licensed with the [MICROSOFT .NET LIB
104104
105105
## Disclosure
106106

107-
The .NET Core CLI Tools display the following text when you first run one of the commands (for example, `dotnet restore`). Text may vary slightly depending on the version of the SDK you're running. This "first run" experience is how Microsoft notifies you about data collection.
107+
The .NET Core SDK displays the following text when you first run one of the [.NET Core CLI commands](index.md) (for example, `dotnet restore`). Text may vary slightly depending on the version of the SDK you're running. This "first run" experience is how Microsoft notifies you about data collection.
108108

109109
```console
110110
Welcome to .NET Core!
111111
---------------------
112-
Learn more about .NET Core @ https://aka.ms/dotnet-docs. Use dotnet --help to see available commands or go to https://aka.ms/dotnet-cli-docs.
113-
112+
Learn more about .NET Core: https://aka.ms/dotnet-docs
113+
Use 'dotnet --help' to see available commands or visit: https://aka.ms/dotnet-cli-docs
114+
114115
Telemetry
115-
--------------
116-
The .NET Core tools collect usage data in order to improve your experience. The data is anonymous and does not include command-line arguments. The data is collected by Microsoft and shared with the community.
117-
You can opt out of telemetry by setting a DOTNET_CLI_TELEMETRY_OPTOUT environment variable to 1 using your favorite shell.
118-
You can read more about .NET Core tools telemetry @ https://aka.ms/dotnet-cli-telemetry.
116+
---------
117+
The .NET Core tools collect usage data in order to help us improve your experience.
118+
The data is anonymous and doesn't include command-line arguments.
119+
The data is collected by Microsoft and shared with the community.
120+
You can opt-out of telemetry by setting the DOTNET_CLI_TELEMETRY_OPTOUT environment variable to '1' or 'true' using your favorite shell.
121+
122+
Read more about .NET Core CLI Tools telemetry: https://aka.ms/dotnet-cli-telemetry
119123
```
120124

121125
## See also
122126

123127
[What we've learned from .NET Core SDK Telemetry](https://blogs.msdn.microsoft.com/dotnet/2017/07/21/what-weve-learned-from-net-core-sdk-telemetry/)
124-
[Telemetry reference source (dotnet/cli repo; release/2.0.0 branch)](https://github.com/dotnet/cli/tree/release/2.0.0/src/dotnet/Telemetry)
125-
[.NET Core SDK Usage Data](https://github.com/dotnet/core/blob/master/release-notes/cli-usage-data.md)
128+
[Telemetry reference source (dotnet/cli repo)](https://github.com/dotnet/cli/tree/master/src/dotnet/Telemetry)
129+
[.NET Core SDK Usage Data](https://github.com/dotnet/core/blob/master/release-notes/cli-usage-data.md)

0 commit comments

Comments
 (0)