[docs] Dashboard telemetry API defaults and otel command standalone usage#732
Merged
IEvangelist merged 1 commit intorelease/13.3from Apr 21, 2026
Conversation
aspire-repo-bot
Bot
added
the
docs-from-code
12 tasks
JamesNK
force-pushed
the
docs/pr-16326-dashboard-api-defaults-d63365865374aa44
branch
2 times, most recently
from
30d0122 to
4b8e2e0
Compare
JamesNK
force-pushed
the
docs/pr-16326-dashboard-api-defaults-d63365865374aa44
branch
3 times, most recently
from
fe40830 to
ed73df4
Compare
- Dashboard:Api:Enabled now defaults to true (API enabled by default) - Dashboard:Api:AuthMode now defaults to ApiKey - Add Dashboard:Api:Disabled as the new preferred config to disable the API - Mark Dashboard:Api:Enabled as deprecated in docs - Update PrimaryApiKey default to note auto-generation - Add --dashboard-url and --api-key options to aspire otel logs/spans/traces - Document login URL support: passing http://host/login?t=<token> auto-exchanges the token for an API key - Update aspire otel main page description to mention standalone dashboard usage Documents changes from microsoft/aspire#16326 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JamesNK
force-pushed
the
docs/pr-16326-dashboard-api-defaults-d63365865374aa44
branch
from
ed73df4 to
8643486
Compare
JamesNK
requested review from
IEvangelist,
JamesNK and
mitchdenny
as code owners
IEvangelist
approved these changes
Apr 21, 2026
IEvangelist
deleted the
docs/pr-16326-dashboard-api-defaults-d63365865374aa44
branch
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
1 participant
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#16326
Thanks to @JamesNK for the implementation.
Why this PR is needed
PR microsoft/aspire#16326 changed the default behavior of the Aspire Dashboard's telemetry API and improved the
aspire otelCLI commands for standalone dashboard use. The existing documentation had outdated defaults and was missing documentation for key CLI options.What changed
Dashboard API configuration (
dashboard/configuration.mdx)The dashboard's Telemetry HTTP API is now enabled by default (previously required explicit opt-in):
Dashboard:Api:Enabled— default changed fromfalsetotrue; marked as deprecated (useDashboard:Api:Disabledinstead)Dashboard:Api:Disabled— new config option; set totrueto disable the API; also available asASPIRE_DASHBOARD_API_DISABLEDenvironment variableDashboard:Api:AuthMode— default changed fromUnsecuredtoApiKeyDashboard:Api:PrimaryApiKey— default updated to note that a 128-bit key is auto-generated when none is suppliedaspire otelCLI commands (reference/cli/commands/aspire-otel*.mdx)Added previously undocumented
--dashboard-urland--api-keyoptions toaspire otel logs,aspire otel spans, andaspire otel traces. The key new behavior:--dashboard-urlnow accepts a full login URL (for example, `(localhost/redacted) — the browser token is automatically exchanged for an API key, so users can copy-paste the dashboard login URL directlyaspire otelparent page description to highlight standalone dashboard usageFiles modified
src/frontend/src/content/docs/dashboard/configuration.mdxDashboard:Api:Disabledsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel.mdxsrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx--dashboard-url,--api-keyoptions and login URL examplesrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx--dashboard-url,--api-keyoptions and login URL examplesrc/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx--dashboard-url,--api-keyoptions and login URL exampleNote
This is a draft PR that needs human review before merging. Please verify the exact option names and descriptions match the shipped CLI behavior.