Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 42 additions & 5 deletions src/frontend/src/content/docs/dashboard/explore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ import metricsPageExemplars from '@assets/dashboard/explore/metrics-page-exempla
import tracePageFromExemplars from '@assets/dashboard/explore/trace-page-from-exemplars.png';
import pauseTelemetry from '@assets/dashboard/explore/pause-telemetry.png';
import removeTelemetryData from '@assets/dashboard/explore/remove-telemetry-data.png';
import removeAllTelemetry from '@assets/dashboard/explore/remove-all-telemetry.png';

import manageDataDialog from '@assets/dashboard/explore/manage-data-dialog.png';
import manageDataExpanded from '@assets/dashboard/explore/manage-data-expanded.png';
import settingsManageTelemetry from '@assets/dashboard/explore/settings-manage-telemetry.png';
import themeSelection from '@assets/dashboard/explore/theme-selection.png';
import themeSelectionLight from '@assets/dashboard/explore/theme-selection-light.png';
import dashboardHelp from '@assets/dashboard/explore/dashboard-help.png';
Expand Down Expand Up @@ -522,17 +525,51 @@ Next to the **Pause** button, the **Remove data** button enables you to clear th

<Image src={removeTelemetryData} alt="A screenshot of the Aspire dashboard Structured logs page, showing how to remove telemetry." />

The button is available for control logs, structured logs, traces, and metrics. It works independently for each type of data.
The button is available for console logs, structured logs, traces, and metrics. It works independently for each type of data.

For more advanced data management, including exporting and importing telemetry, see [Manage data](#manage-data).

#### Manage data

The Aspire dashboard provides a **Manage logs and telemetry** dialog that lets you export, import, and remove telemetry data across all resources. To open it, select the **Settings** icon in the top-right corner of the dashboard, then select **Manage** under **Resource logs and telemetry**:

<Image src={settingsManageTelemetry} alt="A screenshot of the Aspire dashboard Settings dialog, showing the Manage button under Resource logs and telemetry." />

The dialog displays a grid of resources and their available data types. Each resource row shows icons summarizing which data types are present: **Resource** details, **Console logs**, **Structured logs**, **Traces**, and **Metrics**. You can expand a resource to see and select individual data types:

<Image src={manageDataExpanded} alt="A screenshot of the Aspire dashboard Manage logs and telemetry dialog, showing a resource expanded to display individual data types." />

Use the checkboxes to select resources or individual data types, then choose an action:

##### Export data

Select the resources and data types you want to export, then select **Export selected**. The dashboard downloads a `.zip` file containing the selected data organized by type:

- **Resources**: JSON files with resource details.
- **Console logs**: Text files with console output.
- **Structured logs**: OTLP JSON files with structured log entries.
- **Traces**: OTLP JSON files with distributed trace spans.
- **Metrics**: OTLP JSON files with metric data points.

The exported `.zip` file is named `aspire-telemetry-export-{timestamp}.zip` and can be shared with team members or imported back into another dashboard session.

##### Import data

Select **Import logs and telemetry** to import previously exported data. The dashboard accepts `.zip` files (exported from the dashboard) and individual `.json` files containing OTLP telemetry data. The maximum file size is 100 MB.

Imported data appears alongside any existing telemetry in the dashboard, enabling you to review data from previous sessions or data shared by other team members.

##### Remove data

If you want to remove all telemetry of all types and for all resources in a single step, use the **Remove all** button in the **Settings** dialog:
To remove data for specific resources or data types, select the items you want to clear, then select **Remove selected**. This provides more granular control than the per-page **Remove data** button, and enables you to clear multiple data types across multiple resources in a single step.

<Image src={removeAllTelemetry} alt="A screenshot of the Aspire dashboard Settings page, showing how to remove all telemetry." />
<Image src={manageDataDialog} alt="A screenshot of the Aspire dashboard Manage logs and telemetry dialog, showing resources with available data types and export, remove, and import buttons." />

## Settings dialog

<span id="theme-selection"></span>

The Aspire dashboard provides a settings dialog that allows you to configure the theme, the language, functionality to clear all the logs and telemetry, and the .NET version used by the dashboard.
The Aspire dashboard provides a settings dialog that allows you to configure the theme, the language, manage logs and telemetry data, and view the .NET version used by the dashboard.

By default, the theme is set to follow the System theme, which means the dashboard uses the same theme as your operating system. You can also select the **Light** or **Dark** theme to override the system theme. Theme selections are persisted.

Expand Down