-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Move dotnet-scaffold telemetry article to docs/core/tools/ #55211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
15
commits into
main
Choose a base branch
from
copilot/move-dotnet-scaffold-telemetry-article
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+80
−0
Open
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
922473f
Initial plan
Copilot d639044
Add dotnet-scaffold telemetry article and TOC entry
Copilot 107faa1
Apply suggestions from code review
wadepickett b0fde13
Apply suggestions from code review
wadepickett 922b475
Apply suggestion from @gewarren
wadepickett a174ca7
Update ms.date in dotnet-scaffold telemetry doc
wadepickett 8f51a18
Apply suggestions from code review
wadepickett 80e4267
Apply suggestion from @wadepickett
wadepickett 16c8a05
Revise telemetry data collection information
wadepickett 06a89a4
Apply suggestions from code review
wadepickett 50bba0d
Update dotnet-scaffold-telemetry.md
wadepickett e29cf77
Update telemetry documentation for dotnet-scaffold
wadepickett 3d4559b
Apply suggestions from code review
wadepickett 5f8c496
Apply suggestions from code review
wadepickett a7b0f9e
Update dotnet-scaffold-telemetry.md
wadepickett File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: dotnet-scaffold telemetry | ||
| description: Learn about the telemetry collected by the dotnet-scaffold CLI tool. | ||
| author: tdykstra | ||
| ms.author: tdykstra | ||
| ms.date: 08/03/2026 | ||
| ai-usage: ai-assisted | ||
| --- | ||
| # dotnet-scaffold telemetry | ||
|
|
||
| The `dotnet-scaffold` command includes a telemetry feature that collects usage data. This feature helps the `dotnet-scaffold` team understand how the tool is used so they can improve it. | ||
|
|
||
| ## How to opt out | ||
|
|
||
| The `dotnet-scaffold` telemetry feature is enabled by default. To opt out of the telemetry feature, set the `DOTNET_SCAFFOLD_TELEMETRY_OPTOUT` environment variable to `1` or `true`. | ||
|
|
||
| ## Disclosure | ||
|
|
||
| When you run the `dotnet-scaffold` tool for the first time, it displays output similar to the following example. The text might vary slightly depending on the version of the tool you're running. This "first run" experience is how Microsoft notifies you about data collection. | ||
|
|
||
| ```console | ||
| dotnet-scaffold collects usage data in order to help us improve your experience. The data is collected by Microsoft and shared with the community. You can opt-out of telemetry by setting the DOTNET_SCAFFOLD_TELEMETRY_OPTOUT environment variable to '1' or 'true' using your favorite shell. | ||
|
|
||
| Read more about dotnet-scaffold telemetry: | ||
| https://aka.ms/dotnet-scaffold/telemetry | ||
| Read more about .NET CLI Tools telemetry: | ||
| https://aka.ms/dotnet-cli-telemetry | ||
| ``` | ||
|
|
||
| To suppress the "first run" experience text, set the `DOTNET_SCAFFOLD_SKIP_FIRST_TIME_EXPERIENCE` environment variable to `1` or `true`. | ||
|
|
||
| ## Data points | ||
|
|
||
| The telemetry feature doesn't collect: | ||
|
|
||
| * Personal data, such as usernames, email addresses, or URLs. | ||
| * Any project data. | ||
|
|
||
| The data is sent securely to Microsoft servers and held under restricted access. | ||
|
|
||
| Protecting your privacy is important to us. If you suspect the telemetry feature is collecting sensitive data or the data is being insecurely or inappropriately handled, take one of the following actions: | ||
|
|
||
| * File an issue in the [dotnet/scaffolding](https://github.com/dotnet/scaffolding/issues) repository. | ||
| * Send an email to [dotnet@microsoft.com](mailto:dotnet@microsoft.com) for investigation. | ||
|
|
||
| The telemetry feature collects the following data for .NET SDK version 8.0 and later: | ||
|
|
||
| * Timestamp of invocation. | ||
| * Three-octet IP address used to determine the geographical location. | ||
| * Operating system and version. | ||
| * Runtime ID (RID) the tool is running on. | ||
| * Whether the tool is running in a container. | ||
| * Hashed Media Access Control (MAC) address: a cryptographically (SHA256) hashed and unique ID for a machine. | ||
| * Kernel version. | ||
| * dotnet-scaffold version. | ||
| * Hashed tool information (tool name, tool version, tool package name, tool package version, chosen scaffolder category, related scaffolding categories). | ||
| * Tool level (global or local tool). | ||
| * Hashed command invoked (for example, `mvccontroller`) and whether it succeeded. | ||
| * dotnet-scaffold-aspnet scaffolder name, step names, and whether they succeeded. | ||
| * dotnet-scaffold-aspire scaffolder name and whether it succeeded. | ||
| * dotnet-scaffold-aspnet scaffolder validation method name and whether it succeeded. | ||
| * dotnet-scaffold-aspire scaffolder validation method name and whether it succeeded. | ||
|
|
||
| ## Additional resources | ||
|
|
||
| * [.NET SDK telemetry](telemetry.md) | ||
| * [.NET CLI telemetry data](https://dotnet.microsoft.com/platform/telemetry) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.