-
Notifications
You must be signed in to change notification settings - Fork 168
add doc around dashboard telemetry #2846
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5d66a5a
wip
82f3012
wip
adamint f5c2c8a
update
35b0546
add image
446a3be
Merge branch 'main' into dev/adamint/telemetry-dashboard-docs
437c2e2
Revision based on suggestions, add to TOC
adamint d09a4ba
Apply suggestions from code review
IEvangelist 6d6a218
Clarify command/resource type names not sent
adamint 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
51 changes: 51 additions & 0 deletions
51
docs/fundamentals/dashboard/microsoft-collected-dashboard-telemetry.md
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,51 @@ | ||
| --- | ||
| title: Microsoft-collected dashboard telemetry | ||
| description: Learn about what telemetry the .NET Aspire dashboard sends and how to opt out. | ||
| ms.date: 3/25/2025 | ||
| --- | ||
|
|
||
| # Microsoft-collected dashboard telemetry | ||
|
|
||
| The .NET Aspire dashboard collects diagnostic data to help developers monitor and analyze their applications. Separately, when the dashboard is launched through Visual Studio or Visual Studio Code as part of a running .NET Aspire application, Microsoft collects usage data about the dashboard itself. This data helps the .NET Aspire team improve the product. Additionally, unhandled exception details from the dashboard are sent to Microsoft to assist in identifying and resolving issues. | ||
|
|
||
| ## Scope | ||
|
|
||
| .NET Aspire dashboard usage telemetry is collected only when running the dashboard from Visual Studio or Visual Studio Code. Telemetry is gathered while the dashboard is open in the browser, unless you have [opted out](#how-to-opt-out) of telemetry collection. | ||
|
|
||
| ## How to opt out | ||
|
|
||
| Starting with .NET Aspire 9.2, dashboard usage telemetry is enabled by default. Dashboard usage telemetry is not collected in early version. This feature aligns with the following IDE versions: | ||
|
|
||
| - Visual Studio: 17.14 or later. | ||
| - C# Dev Kit: [VSC RELEASE VERSION] or later. | ||
|
|
||
| - Set the `DOTNET_DASHBOARD_ENABLE_TELEMETRY` environment variable to `false`. This will apply to all users accessing the Aspire dashboard. | ||
| - Disable telemetry collection in the host IDE. Learn how to opt out in [Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/visual-studio-experience-improvement-program) or [Visual Studio Code](https://code.visualstudio.com/docs/configure/telemetry#_disable-telemetry-reporting). | ||
|
|
||
| ## Disclosure | ||
|
|
||
| When dashboard usage telemetry is enabled, there's a disclosure statement at the bottom of the settings panel, informing you that telemetry is enabled. This disclosure statement appears anytime usage telemetry is enabled. | ||
|
|
||
| ## Data points | ||
|
|
||
| .NET Aspire dashboard usage telemetry doesn't collect personal data, such as, IP addresses or use browser fingerprinting. It doesn't scan your code and doesn't extract source code, authorship, or deployment configuration. The data is sent securely to Microsoft using [https://azure.microsoft.com/services/monitor/](Azure Monitor) through existing telemetry APIs in Visual Studio and Visual Studio Code. | ||
|
|
||
| Protecting your privacy is important to Microsoft. If you suspect that telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, file an issue in the [:::image type="icon" source="../../media/github-mark.svg border="false"::: GitHub dotnet/aspire](https://github.com/dotnet/aspire) repository for investigation. | ||
|
|
||
| The .NET Aspire dashboard doesn't collect telemetry on Visual Studio versions `< 17.14` or C# Dev Kit versions `< [VSC RELEASE VERSION]`. It collects the following data: | ||
|
|
||
| | .NET Aspire dashboard versions | Data | Notes | | ||
| |--|--|--| | ||
| | 9.3 | Page navigation history. | Includes page settings. | | ||
| | 9.3 | Resource types being used. | | | ||
| | 9.3 | Request user agent. | | | ||
| | 9.3 | Invoked dashboard commands. | Command name is securely hashed. | | ||
| | 9.3 | Request language and set dashboard language. | | | ||
| | 9.3 | Resource restart times. | | | ||
| | 9.3 | OTel data processing times. | | | ||
| | 9.3 | Dashboard-related unhandled exceptions. | | | ||
|
|
||
| ## See also | ||
|
|
||
| - [.NET Aspire dashboard](overview.md) | ||
| - [.NET Aspire dashboard configuration](configuration.md) | ||
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.