Skip to content

Commit 7272d7b

Browse files
Update the Explore the .NET Aspire Dashboard article for v9.2.0 (#3125)
* Added new features of the dashboard. * Integrated feedback from @IEvangelist and @JamesNK. * Fixed one JPEG link.
1 parent 4ef95d8 commit 7272d7b

14 files changed

+36
-4
lines changed

docs/fundamentals/dashboard/explore.md

+36-4
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Some values are formatted as JSON or XML. In these cases, the text visualizer en
146146

147147
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:
148148

149-
:::image type="content" source="media/explore/resource-details.png" lightbox="media/explore/resource-details.png" alt-text="A screenshot of the .NET Aspire dashboard Resources page with the details of a selected resource displayed.":::
149+
:::image type="content" source="media/explore/resource-details-thumb.png" lightbox="media/explore/resource-details.png" alt-text="A screenshot of the .NET Aspire dashboard Resources page with the details of a selected resource displayed.":::
150150

151151
The search bar in the upper right of the dashboard also provides the option to filter the list, which is useful for .NET 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:
152152

@@ -168,7 +168,7 @@ Selecting the error count badge navigates to the [Structured logs](#structured-l
168168

169169
To see the log entry in detail for the error, select the **View** button to open a window below the list with the structured log entry details:
170170

171-
:::image type="content" source="media/explore/structured-logs-errors-view.png" lightbox="media/explore/structured-logs-errors-view.png" alt-text="A screenshot of the .NET Aspire dashboard Structured logs page, showing a lower window with the structured log entry details.":::
171+
:::image type="content" source="media/explore/structured-logs-errors-view-thumb.png" lightbox="media/explore/structured-logs-errors-view.png" alt-text="A screenshot of the .NET Aspire dashboard Structured logs page, showing a lower window with the structured log entry details.":::
172172

173173
For more information and examples of Structured logs, see the [Structured logs page](#structured-logs-page) section.
174174

@@ -199,6 +199,10 @@ If you select a container or executable, formatting is different from a project
199199

200200
:::image type="content" source="media/explore/container-logs.png" lightbox="media/explore/container-logs.png" alt-text="A screenshot of the .NET Aspire dashboard Console logs page with a container source selected.":::
201201

202+
You can download any console log to your local machine and use your preferred text programs to analyze it:
203+
204+
:::image type="content" source="media/explore/download-console-logs.png" lightbox="media/explore/download-console-logs.png" alt-text="A screenshot of the .NET Aspire dashboard Console logs page showing how to download a log to your local machine.":::
205+
202206
#### Resource replicas
203207

204208
When project resources are replicated using the <xref:Aspire.Hosting.ProjectResourceBuilderExtensions.WithReplicas%2A> API, they're represented in the resource selector under a top-level named resource entry with an icon to indicator. Each replicated resource is listed under the top-level resource entry, with its corresponding unique name. Consider the following example screenshot of a replicated project resource:
@@ -283,18 +287,22 @@ Each trace has a color, which is generated to help differentiate between spans
283287

284288
:::image type="content" source="media/explore/traces.png" lightbox="media/explore/traces.png" alt-text="A screenshot of the .NET Aspire dashboard Traces page.":::
285289

286-
You can also select the **View** button to navigate to a detailed view of the request and the duration of time it spent traveling through each application layer. Consider an example selection of a trace to view its details:
290+
In the **Actions** column, you can select **View details** to navigate to a detailed view of the request and the duration of time it spent traveling through each application layer. Consider an example selection of a trace to view its details:
287291

288292
:::image type="content" source="media/explore/trace.png" lightbox="media/explore/trace.png" alt-text="A screenshot of the .NET Aspire dashboard Trace details page.":::
289293

290-
For each span in the trace, select **View** to see more details:
294+
For each span in the trace, select **View details** to see more details:
291295

292296
:::image type="content" source="media/explore/trace-span-details.png" lightbox="media/explore/trace-span-details.png" alt-text="A screenshot of the .NET Aspire dashboard Trace details page with the details of a span displayed.":::
293297

294298
Scroll down in the span details pain to see full information. At the bottom of the span details pane, some span types, such as this call to a cache, show span event timings:
295299

296300
:::image type="content" source="media/explore/trace-span-event-details.png" lightbox="media/explore/trace-span-event-details.png" alt-text="A screenshot of the .NET Aspire dashboard Trace details page with the event timings for a span displayed.":::
297301

302+
For complex traces with many spans, use the **Filter** textbox to display only matching spans:
303+
304+
:::image type="content" source="media/explore/filter-spans-trace-details.png" lightbox="media/explore/filter-spans-trace-details.png" alt-text="A screenshot of the .NET Aspire dashboard Trace details page with the filter used to display only weather spans.":::
305+
298306
When errors are present, the page renders an error icon next to the trace name. Consider an example screenshot of traces with errors:
299307

300308
:::image type="content" source="media/explore/traces-errors.png" lightbox="media/explore/traces-errors.png" alt-text="A screenshot of the .NET Aspire dashboard Traces page, showing traces with errors.":::
@@ -349,6 +357,30 @@ Selecting the exemplar indicator opens the trace details page, where you can vie
349357

350358
For more information, see [OpenTelemetry Docs: Exemplars](https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exemplars).
351359

360+
### Interact with telemetry
361+
362+
Telemetry information is generated continuously while you run a .NET Aspire application and it can flood the dashboard with information. The dashboard includes tools you can use to reduce the amount of data displayed in monitoring pages and make it easier to target specific events.
363+
364+
#### Pause telemetry output
365+
366+
In the **Console logs**, **Structured logs**, **Traces**, and **Metrics** pages, you can pause the collection of telemetry data:
367+
368+
:::image type="content" source="media/explore/pause-telemetry.png" lightbox="media/explore/pause-telemetry.png" alt-text="A screenshot of the .NET Aspire dashboard Console logs page, showing how to pause telemetry.":::
369+
370+
The pause button affects only the type of telemetry displayed on that page. So, for example, if you pause console logs collection, your app continues to collect structured logs, traces, and metrics telemetry.
371+
372+
#### Remove data
373+
374+
Next to the **Pause** button, the **Remove data** button enables you to clear the telemetry on the current page. Drop down the list, and choose whether to remove the telemetry for all resource, or only for the current resource:
375+
376+
:::image type="content" source="media/explore/remove-telemetry-data-thumb.png" lightbox="media/explore/remove-telemetry-data.png" alt-text="A screenshot of the .NET Aspire dashboard Structured logs page, showing how to remove telemetry.":::
377+
378+
The button is available for control logs, structured logs, traces, and metrics. It works independently for each type of data.
379+
380+
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:
381+
382+
:::image type="content" source="media/explore/remove-all-telemetry.png" lightbox="media/explore/remove-all-telemetry.png" alt-text="A screenshot of the .NET Aspire dashboard Settings page, showing how to remove all telemetry.":::
383+
352384
## Settings dialog
353385

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

0 commit comments

Comments
 (0)