Repository navigation
[docs] Document dashboard startup telemetry - #1867
Open
aspire-repo-bot[bot] wants to merge 4 commits into
Open
aspire-repo-bot[bot] wants to merge 4 commits into
aspire-repo-bot[bot] wants to merge 4 commits into
Conversation
Document the aspire/dashboard/startup product telemetry event added in microsoft/aspire#20846: startup result, duration, launch context, and failure error type. Add the Dashboard:LaunchContext configuration option to the dashboard configuration reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: James Newton-King <james@newtonking.com>
James Newton-King (JamesNK)
marked this pull request as ready for review
October 12, 2026 14:14
James Newton-King (JamesNK)
requested a review
from David Pine (IEvangelist)
as a code owner
October 12, 2026 14:14
James Newton-King (JamesNK)
approved these changes
Oct 12, 2026
James Newton-King (JamesNK)
enabled auto-merge (squash)
October 12, 2026 14:15
Copilot started reviewing on behalf of
James Newton-King (JamesNK)
October 12, 2026 14:15
View session
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The promised telemetry details are absent, configuration behavior is incomplete, and an existing disclosure row is removed.
3 open findings
What changed in this PR
Documents Aspire 17.0 dashboard startup telemetry and its launch-context configuration.
Changes:
- Adds dashboard startup to the telemetry disclosure table.
- Adds the
Dashboard:LaunchContextconfiguration option.
| File | Description |
|---|---|
microsoft-collected-dashboard-telemetry.mdx |
Adds startup telemetry disclosure. |
configuration.mdx |
Documents launch-context configuration. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
James Newton-King (JamesNK)
disabled auto-merge
October 12, 2026 14:41
James Newton-King (JamesNK)
enabled auto-merge (squash)
October 12, 2026 14:42
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.


Documents changes from microsoft/aspire#20846
@JamesNKTarget branch
Targeting
release/17.0based on the source PR milestone17.0.Why this is needed
microsoft/aspire#20846 adds an
aspire/dashboard/startupproduct telemetry event recording startup result, duration, launch context, and (on failure) an error type. It also introduces theDashboard:LaunchContextconfiguration option (DASHBOARD__LAUNCHCONTEXTenvironment variable), which the AppHost, theaspire dashboard runCLI command, and container deployments use to report where the dashboard was launched from. This is new user-facing telemetry behavior and a new configuration option, neither of which was previously documented.This PR was drafted because the automated signal check flagged
docs_required, based on:cli_command_file_changed—src/Aspire.Cli/Commands/DashboardRunCommand.cswas changed to set the newDASHBOARD__LAUNCHCONTEXTenvironment variable tocli.pr_body_has_cli_flag_mention— the PR body includes CLI command usage.What changed
src/frontend/src/content/docs/dashboard/microsoft-collected-dashboard-telemetry.mdx: Added a new "Startup telemetry" section describing theaspire/dashboard/startupevent — startup result, duration, launch context values (apphost,cli,container,unknown), and the failure error types (invalid_config,address_in_use,canceled, or the exception type). Notes that this event is always recorded (not IDE-scoped like other usage telemetry) and uses the sameASPIRE_DASHBOARD_TELEMETRY_OPTOUTopt-out.src/frontend/src/content/docs/dashboard/configuration.mdx: Added aDashboard:LaunchContextrow to the "Other" options table, documenting the environment variable, default launchers, and fallback-to-unknownbehavior.Both pages were updated in place; no new pages were created.
Validation
Documentation-only change; no build or test commands were run. Content follows the existing structure and tables already used on both pages.