Skip to content

Commit 8f86746

Browse files
adamintAdam RatzmanIEvangelist
authored
add doc around dashboard telemetry (#2846)
* wip * wip * update * add image * Revision based on suggestions, add to TOC * Apply suggestions from code review * Clarify command/resource type names not sent --------- Co-authored-by: Adam Ratzman <[email protected]> Co-authored-by: David Pine <[email protected]>
1 parent 94bab3c commit 8f86746

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Microsoft-collected dashboard telemetry
3+
description: Learn about what telemetry the .NET Aspire dashboard sends and how to opt out.
4+
ms.date: 3/25/2025
5+
---
6+
7+
# Microsoft-collected dashboard telemetry
8+
9+
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.
10+
11+
## Scope
12+
13+
.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.
14+
15+
## How to opt out
16+
17+
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:
18+
19+
- Visual Studio: 17.14 or later.
20+
- C# Dev Kit: [VSC RELEASE VERSION] or later.
21+
22+
- Set the `DOTNET_DASHBOARD_ENABLE_TELEMETRY` environment variable to `false`. This will apply to all users accessing the Aspire dashboard.
23+
- Disable telemetry collection in the host IDE. Learn how to opt out in [Visual Studio](/visualstudio/ide/visual-studio-experience-improvement-program) or [Visual Studio Code](https://code.visualstudio.com/docs/configure/telemetry#_disable-telemetry-reporting).
24+
25+
## Disclosure
26+
27+
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.
28+
29+
## Data points
30+
31+
.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.
32+
33+
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.
34+
35+
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:
36+
37+
| .NET Aspire dashboard versions | Data | Notes |
38+
|--|--|--|
39+
| 9.3 | Page navigation history. | Includes page settings. |
40+
| 9.3 | Resource types being used. | Custom resource type names are not sent to Microsoft. |
41+
| 9.3 | Request user agent. | |
42+
| 9.3 | Invoked dashboard commands. | Custom command names are not sent to Microsoft. |
43+
| 9.3 | Request language and set dashboard language. | |
44+
| 9.3 | Resource restart times. | |
45+
| 9.3 | OTel data processing times. | |
46+
| 9.3 | Dashboard-related unhandled exceptions. | |
47+
48+
## See also
49+
50+
- [.NET Aspire dashboard](overview.md)
51+
- [.NET Aspire dashboard configuration](configuration.md)

docs/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ items:
9393
href: fundamentals/dashboard/enable-browser-telemetry.md
9494
- name: Security considerations
9595
href: fundamentals/dashboard/security-considerations.md
96+
- name: Microsoft-collected dashboard telemetry
97+
href: fundamentals/dashboard/microsoft-collected-dashboard-telemetry.md
9698

9799
- name: Testing
98100
items:

0 commit comments

Comments
 (0)