Skip to content

[docs] Document dashboard startup telemetry - #1867

Open
aspire-repo-bot[bot] wants to merge 4 commits into
release/17.0from
docs/pr-20846-38053277142-1-3dcb328d25fcd0af
Open

aspire-repo-bot[bot] wants to merge 4 commits into
release/17.0from
docs/pr-20846-38053277142-1-3dcb328d25fcd0af

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20846

@JamesNK

Target branch

Targeting release/17.0 based on the source PR milestone 17.0.

Why this is needed

microsoft/aspire#20846 adds an aspire/dashboard/startup product telemetry event recording startup result, duration, launch context, and (on failure) an error type. It also introduces the Dashboard:LaunchContext configuration option (DASHBOARD__LAUNCHCONTEXT environment variable), which the AppHost, the aspire dashboard run CLI 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.cs was changed to set the new DASHBOARD__LAUNCHCONTEXT environment variable to cli.
  • 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 the aspire/dashboard/startup event — 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 same ASPIRE_DASHBOARD_TELEMETRY_OPTOUT opt-out.
  • src/frontend/src/content/docs/dashboard/configuration.mdx: Added a Dashboard:LaunchContext row to the "Other" options table, documenting the environment variable, default launchers, and fallback-to-unknown behavior.

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.

Generated by PR Documentation Check for #20846 · copilot · auto · 77.2 AIC · ⌖ 13.7 AIC · ⊞ 20.4K · ◷

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>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Oct 10, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1867. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1867 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Comment thread src/frontend/src/content/docs/dashboard/configuration.mdx Outdated
Co-authored-by: James Newton-King <james@newtonking.com>
@JamesNK
James Newton-King (JamesNK) marked this pull request as ready for review October 12, 2026 14:14
Copilot AI balanced review requested due to automatic review settings October 12, 2026 14:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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:LaunchContext configuration 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.

Comment thread src/frontend/src/content/docs/dashboard/configuration.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants