add doc around dashboard telemetry #2846
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,49 @@ | ||||||
| --- | ||||||
| title: .NET Aspire dashboard telemetry | ||||||
| description: Learn about what telemetry the .NET Aspire dashboard sends and how to opt out. | ||||||
| ms.date: 03/05/2025 | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| --- | ||||||
|
|
||||||
| # .NET Aspire dashboard telemetry | ||||||
|
There was a problem hiding this comment. What do you think about this for the title instead?
Suggested change
".NET Aspire telemetry" is now officially an oxymoron; in that it has two contradictory meanings. Before 9.2, the dashboard was all about display resource telemetry, obviously we all know that, but now, we're saying ".NET Aspire telemetry" in this article is about the data Microsoft collects to improve the dashboard experience. Or perhaps something like ".NET Aspire dashboard usage telemetry"? There was a problem hiding this comment. Microsoft-collected dashboard telemetry works for me! |
||||||
|
|
||||||
| The Aspire dashboard includes a telemetry feature that collects usage data when the dashboard is launched through Visual Studio or Visual Studio Code as part of a running Aspire application. This information is sent to Microsoft to help the Aspire team understand how the dashboard is used and help improve the product. Exception information is also sent when unhandled exceptions occur in the dashboard. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Scope | ||||||
|
|
||||||
| .NET Aspire dashboard usage telemetry is supported when using Visual Studio or Visual Studio Code to run an Aspire application containing a dashboard resource. | ||||||
|
|
||||||
| Telemetry is collected only when the Aspire dashboard is open in the browser and the instance of Visual Studio or Visual Studio Code has not opted out of telemetry collection. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## How to opt out | ||||||
|
|
||||||
| .NET Aspire dashboard telemetry is enabled by default for `Aspire >= 9.2` when launched through Visual Studio `>= 17.14` or C# Dev Kit `>= [VSC RELEASE VERSION]`. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| To opt out, you may either: | ||||||
|
|
||||||
| - Set the `DOTNET_DASHBOARD_ENABLE_TELEMETRY` environment variable to `false`. This will apply to all users accessing the Aspire dashboard. | ||||||
|
There was a problem hiding this comment. Could a user alternatively set an AppContext.SetSwitch("DOTNET_DASHBOARD_ENABLE_TELEMETRY", true);There was a problem hiding this comment. Not currently. That pattern is not currently supported for any dashboard configuration option, so it needs further discussion. @davidfowl how do you feel about supporting switches? |
||||||
| - Disable telemetry collection in the host IDE. | ||||||
|
There was a problem hiding this comment. How does one disable telemetry collection in the host IDE? There was a problem hiding this comment. added links for VSC and VS |
||||||
|
|
||||||
| ## Disclosure | ||||||
|
|
||||||
| If dashboard telemetry is enabled, there will be a disclosure statement at the bottom of the settings panel informing that telemetry is enabled. This statement will appear any time telemetry collection is enabled. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| :::image type="content" source="media/explore/dashboard-settings-drawer.png" lightbox="media/explore/dashboard-settings-drawer.png" alt-text="A screenshot of the .NET Aspire dashboard settings drawer."::: | ||||||
|
|
||||||
| ## Data points | ||||||
|
|
||||||
| Aspire dashboard telemetry does not collect personal data like IP addresses or use browser fingerprinting. It does not scan your code and does not 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. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Protecting your privacy is important to us. If you suspect that telemetry is collecting sensitive data or the data is being insecurely or inappropriately handled, file an issue in the [dotnet/aspire](https://github.com/dotnet/aspire) repository for investigation. | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| The Aspire dashboard does not collect telemetry on Visual Studio versions `< 17.14` or C# Dev Kit versions `< [VSC RELEASE VERSION`. It collects the following data: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| | Aspire dashboard versions | Data | Notes | | ||||||
| |--------------|------|------| | ||||||
| | 9.2 | 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. | | | ||||||
adamint marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you get an even larger image? If so, that should be used as the lightbox. Right now, using the same image in this situation doesn't make sense as when you select it, it's not larger than the one currently rendered. Also, we've been defaulting to using the dark theme for docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can, but on second thought, I'm not sure this image is necessary to include at all. What's your opinion? In the meantime, I removed it.