diff --git a/src/frontend/src/content/docs/dashboard/explore.mdx b/src/frontend/src/content/docs/dashboard/explore.mdx index d92338d94..b9c7e7b5e 100644 --- a/src/frontend/src/content/docs/dashboard/explore.mdx +++ b/src/frontend/src/content/docs/dashboard/explore.mdx @@ -217,34 +217,24 @@ You can also obtain the login token from the container logs. For more informatio Management integrations such as pgAdmin, pgweb, phpMyAdmin, Kafka UI, Mongo Express, and Attu hide their management containers and expose **Manage** links on the resources they administer. These links appear ahead of other resource URLs. Built-in management endpoints, including RabbitMQ and Qdrant, also use the **Manage** label. -The Aspire dashboard's home page shows the resources in your application, including projects, containers, and executables. For example, the starter application includes two projects: +On desktop, the Aspire dashboard opens to a full-page resource list. The list includes the projects, containers, and executables in your Aspire solution. For example, the starter application includes two projects: - **apiservice**: A backend API project built using Minimal APIs. - **webfrontend**: The frontend UI project built using Blazor. The dashboard also provides essential details about each resource: -- **Type**: Displays whether the resource is a project, container, or executable. - **Name**: The name of the resource. -- **State**: Displays whether or not the resource is currently running. - - **Errors**: Within the **State** column, errors are displayed as a badge with the error count. It's useful to understand quickly what resources are reporting errors. Selecting the badge takes you to the [semantic logs](#structured-logs-page) for that resource with the filter at an error level. -- **Start time**: When the resource started running. -- **Source**: The location of the resource on the device. -- **Endpoints**: One or more URLs to reach the running resource directly. -- **Logs**: A link to the resource logs page. -- **Actions**: A [set of actions](#resource-actions) that can be performed on the resource: - - **Highlighted commands**: Up to two highlighted commands for the resource, such as **Stop** or **Start**. - - **Ellipsis**: A submenu with extra resource specific actions: - - **View details**: View the resource details. - - **Console log**: Navigate to the resource's console logs. - - **Structured logs**: Navigate to the resource's structured logs. - - **Traces**: Navigate to the resource's traces. - - **Metrics**: Navigate to the resource's metrics. - - **Restart**: Stop and then start the resource. - -Consider the following screenshot of the resources page: - - +- **Type**: The kind of resource, such as a project, container, or executable. +- **State**: The current state of the resource. An unviewed error count badge links to [structured logs](#structured-logs-page) filtered to errors for that resource. +- **Start or stop time**: How long ago the resource started or stopped, shown in a short form such as "7m ago". +- **Source**: The source of the resource, such as a project file or container image. +- **URLs**: The first URL for the resource. When more URLs are available, select the "+N" button to see them. A URL's tooltip shows its address. +- **Actions**: The available [resource actions](#resource-actions), such as starting or stopping a resource. + +Select **All resources** at the top of the list to open the overview for all resources, or select a resource to open its overview. On narrow screens, the dashboard opens to the overview for all resources instead of the full-page list. Select the dashboard's name or logo to return to the full-page list on desktop. + +Use the **Console**, **Structured logs**, **Traces**, and **Metrics** tabs to view data for the selected resources. On the structured logs, traces, and metrics tabs, a resource without the corresponding data is muted in the list, and its tooltip explains why. Alternatively, you can view the resources as a graph. The graph view provides a visual representation of the resources and their dependencies. This view is useful for understanding how the different resources in your app are connected and how they interact with each other: @@ -265,6 +255,8 @@ When the **Overview layout** setting is **Summary**, the Overview page opens wit - **Live activity**: A chart of incoming requests, bucketed every 30 seconds over the last 15 minutes. Hover a bar to see its request and failure counts. If there's no traffic yet, the chart prompts you to interact with your app. For a past run, the chart is titled **Activity** and covers the final 15 minutes of that run. - **Insights**: **Slowest endpoints** ranks endpoints by latency, **Busiest resources** shows request and failure counts per resource, and **Error hotspots** ranks resources by failed requests plus error logs. + + ### Resource overview panels Selecting a single resource opens its overview, which is made up of panels: **Status**, **Endpoints**, **Metrics**, **Terminal** (when the resource has one), **Console**, **Structured logs**, **Traces**, **Relationships**, and **Properties**. Use the **Panels** toggle in the page toolbar to choose which panels appear: @@ -385,24 +377,13 @@ Resources that depend on other resources that are stopped, or restarted, might e ##### Resource submenu actions -Selecting the horizontal ellipsis icon in the **Actions** column opens a submenu with additional resource-specific actions. In addition to the built-in resource submenu actions, you can also define custom resource actions by defining custom commands. For more information, see [Custom resource commands in Aspire](/fundamentals/custom-resource-commands/). For the built-in resource submenu actions, consider the following screenshot: +Select the horizontal ellipsis in a resource row to open its actions menu. Available actions depend on the resource and can include viewing JSON, opening telemetry, and restarting the resource. You can also define custom actions. For more information, see [Custom resource commands in Aspire](/fundamentals/custom-resource-commands/). - + -The following submenu actions are available: +The available actions can differ for other resources: -- **View details**: View the resource details. -- **Console log**: Navigate to the resource's console logs. -- **Structured logs**: Navigate to the resource's structured logs. -- **Traces**: Navigate to the resource's traces. -- **Metrics**: Navigate to the resource's metrics. -- **Restart**: Stop and then start the resource. - - + #### Copy or Open in text visualizer @@ -425,9 +406,9 @@ The text visualizer automatically selects an appropriate format for recognized f ### Resource details -You can obtain full details about each resource by selecting the ellipsis button in the **Actions** column and then selecting **View details**. The **Details** page provides a comprehensive view of the resource: +Select a resource in the list to open its **Overview** tab. This view shows resource details, including properties, environment variables, and available endpoints. Matching endpoint addresses are grouped, and the tooltip shows an additional address when one is available. - + The search bar in the upper right of the dashboard also provides the option to filter the list, which is useful for Aspire projects with many resources. To select the types of resources that are displayed, drop down the arrow to the left of the filter textbox: