Repository navigation
Document dashboard data persistence - #1649
Merged
David Pine (IEvangelist) merged 2 commits intoSep 11, 2026
Merged
Conversation
James Newton-King (JamesNK)
requested a review
from David Pine (IEvangelist)
as a code owner
September 11, 2026 08:44
Copilot started reviewing on behalf of
James Newton-King (JamesNK)
September 11, 2026 08:45
View session
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Correct the AppHost configuration paths and clarify persistence defaults before approval.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Documents dashboard data persistence, including modes, storage, retention, configuration, and security.
Changes:
- Adds a dedicated persistence guide.
- Documents AppHost, CLI, and standalone container configuration.
- Updates deployment, overview, security, and navigation documentation.
File summaries
| File | Reviewed change |
|---|---|
src/frontend/src/content/docs/dashboard/telemetry-after-deployment.mdx |
Updates deployment telemetry guidance. |
src/frontend/src/content/docs/dashboard/standalone.mdx |
Adds standalone persistence instructions. |
src/frontend/src/content/docs/dashboard/security-considerations.mdx |
Documents persisted-data security considerations. |
src/frontend/src/content/docs/dashboard/overview.mdx |
Highlights dashboard persistence capabilities. |
src/frontend/src/content/docs/dashboard/data-persistence.mdx |
Adds persistence modes, storage, retention, and compatibility guidance. |
src/frontend/src/content/docs/dashboard/configuration.mdx |
Adds persistence configuration references and examples. |
src/frontend/src/content/docs/app-host/configuration.mdx |
Adds AppHost persistence settings. |
src/frontend/config/sidebar/dashboard.topics.ts |
Adds the persistence page to navigation. |
Review details
Suppressed comments (2)
src/frontend/src/content/docs/dashboard/configuration.mdx:125
- This replacement repeats the same C# AppHost issue in the common configuration table:
aspire.config.jsonis not the launch-profile file for project-based or file-based C# AppHosts. Please refer to the selected AppHost launch profile (with the language-specific locations documented at/app-host/configuration/) instead of naming onlyaspire.config.json.
| `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL`<br/>Default: `http://localhost:18890` | The [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. When the dashboard is launched by the Aspire AppHost the OTLP/HTTP endpoint isn't configured by default. To configure an OTLP/HTTP endpoint with the AppHost, set an `ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` environment variable in an _aspire.config.json_ launch profile. Securing the dashboard with HTTPS is recommended. |
src/frontend/src/content/docs/dashboard/telemetry-after-deployment.mdx:20
- The table's
Temporary by defaultwording is misleading for the main Aspire scenario: the AppHost-launched dashboard defaults toRunpersistence, while only standalone mode defaults toNone. A reader following this page would incorrectly expect AppHost telemetry to disappear on every restart; distinguish the AppHost and standalone defaults here.
| **Retention** | Temporary by default; persistence is configurable | Configurable (days, months, indefinitely) |
- Files reviewed: 8/8 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+28
to
+30
| The AppHost automatically configures the dashboard, but you can override values if needed. The recommended way to configure the dashboard from the AppHost is to add environment variables to a launch profile in _aspire.config.json_. This configuration works with both C# and TypeScript AppHosts. | ||
|
|
||
| ```json title="launchSettings.json" {14} | ||
| ```json title="aspire.config.json" {6} |
| - Real-time tracking of logs, traces, and environment configurations. | ||
| - User interface to [stop, start, and restart resources](/dashboard/explore/#resource-actions). | ||
| - Collects and displays logs and telemetry; [view structured logs, traces, and metrics](/dashboard/explore/#monitoring-pages) in an intuitive UI. | ||
| - Persists resources and telemetry so you can inspect and compare completed application runs. |
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Updated data persistence documentation to include FileTree component for data layout visualization.
David Pine (IEvangelist)
approved these changes
Sep 11, 2026
David Pine (IEvangelist)
enabled auto-merge (squash)
September 11, 2026 11:37
David Pine (IEvangelist)
deleted the
docs/dashboard-data-persistence
branch
September 11, 2026 12:05
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.
Summary
Documents the dashboard persistence behavior introduced by microsoft/aspire#18924.
Third-party links and affiliations
None.
Validation
git diff --checksrc/frontend/node_modules/.bin/eslint.cmd src/frontend/config/sidebar/dashboard.topics.tsThe full frontend test suite was not run because the local dependency installation is incomplete and completing it would require downloading packages.