Skip to content

[docs] Document dashboard sidebar resource availability #2069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aspire-repo-bot wants to merge 1 commit into
base: release/17.0
Choose a base branch
from
Draft

[docs] Document dashboard sidebar resource availability #2069

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/frontend/src/content/docs/dashboard/explore.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,16 @@ For more information about configuring a resource service, see [Dashboard config

The Aspire dashboard provides various ways to view logs, traces, and metrics for your app. This information enables you to track the behavior and performance of your app and to diagnose any issues that arise.

### Resource availability in the sidebar

The resource sidebar on the console logs, terminal, structured logs, traces, and metrics pages shows what's available for each resource in the current view. A resource can be running and healthy but still have no telemetry, so availability is shown separately from resource health and selection.

- **No logs**, **No traces**, and **No metrics** badges appear next to resources that haven't sent that signal. The rows are muted but still selectable, and selecting one opens the normal empty view. When the resource sends telemetry, the badge disappears and the data appears without reselecting the resource. If the signal is cleared, the badge and empty state return.
- **Not applicable** appears for parameters. Hover or keyboard-focus a parameter to see why the current feature doesn't apply to it, such as no console logs, structured logs, traces, metrics, or terminal. Press <Kbd windows="Enter" mac="Return" linux="Enter" /> or select the parameter to open its overview.
- In the aggregate view, only **Select all** is highlighted. Individual, <Kbd windows="Ctrl" mac="Cmd" linux="Ctrl" />-click, <Kbd windows="Shift" mac="Shift" linux="Shift" />-click range, and group selections keep their existing selection indicators.

Resources that don't send OpenTelemetry data can still appear in **Traces** when other resources send traces that reference them.

### Console logs page

The **Console logs** page displays text that each resource in your app has sent to standard output. Logs are a useful way to monitor the health of your app and diagnose issues. Logs are displayed differently depending on the source, such as project, container, or executable.
Expand Down
Loading