Skip to content

Updates to .NET Aspire dashboard content #1016

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.

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

Merged
merged 2 commits into from
May 30, 2024
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
16 changes: 15 additions & 1 deletion docs/fundamentals/dashboard/configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire dashboard configuration
description: .NET Aspire dashboard configuration options
ms.date: 05/18/2024
ms.date: 05/30/2024
ms.topic: reference
---

Expand All @@ -19,6 +19,8 @@ There are a number of ways to provide configuration:

Consider the following example, which shows how to configure the dashboard when started from a Docker container:

## [Bash](#tab/bash)

```bash
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
-e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' \
Expand All @@ -27,6 +29,18 @@ docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

## [PowerShell](#tab/powershell)

```powershell
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard `
-e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' `
-e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' `
-e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' `
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

---

Alternatively, these same values could be configured using a JSON configuration file that is specified using `DOTNET_DASHBOARD_CONFIG_FILE_PATH`:

```json
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion docs/fundamentals/dashboard/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire dashboard overview
description: Overview of .NET Aspire dashboard and getting started.
ms.date: 05/18/2024
ms.date: 05/30/2024
ms.topic: reference
---

Expand All @@ -21,11 +21,22 @@ For more information about using the dashboard during .NET Aspire development, s

The .NET Aspire dashboard is also shipped as a Docker image and can be used standalone, without the rest of .NET Aspire. The standalone dashboard provides a great UI for viewing telemetry and can be used by any application.

## [Bash](#tab/bash)

```bash
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

## [PowerShell](#tab/powershell)

```powershell
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard `
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

---

The preceding Docker command:

- Starts a container from the `mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0` image.
Expand Down
15 changes: 14 additions & 1 deletion docs/fundamentals/dashboard/security-considerations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire dashboard security considerations
description: Security considerations for running the .NET Aspire dashboard
ms.date: 03/13/2024
ms.date: 05/30/2024
ms.topic: reference
---

Expand Down Expand Up @@ -51,13 +51,26 @@ To prevent untrusted apps from sending telemetry to .NET Aspire, the OTLP endpoi

API key authentication can be enabled on the telemetry endpoint with some additional configuration:

## [Bash](#tab/bash)

```bash
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
-e DASHBOARD__OTLP__AUTHMODE='ApiKey' \
-e DASHBOARD__OTLP__PRIMARYAPIKEY='{MY_APIKEY}' \
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

## [PowerShell](#tab/powershell)

```powershell
docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard `
-e DASHBOARD__OTLP__AUTHMODE='ApiKey' `
-e DASHBOARD__OTLP__PRIMARYAPIKEY='{MY_APIKEY}' `
mcr.microsoft.com/dotnet/aspire-dashboard:8.0.0
```

---

The preceding Docker command:

- Starts the .NET Aspire dashboard image and exposes OTLP endpoint as port 4317
Expand Down
4 changes: 2 additions & 2 deletions docs/fundamentals/dashboard/standalone.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Standalone .NET Aspire dashboard
description: How to use the .NET Aspire dashboard standalone.
ms.date: 05/18/2024
ms.date: 05/30/2024
ms.topic: reference
---

Expand All @@ -12,7 +12,7 @@ The [.NET Aspire dashboard](overview.md) provides a great UI for viewing telemet
- Ships as a container image that can be used with any OpenTelemetry enabled app.
- Can be used standalone, without the rest of .NET Aspire.

:::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.":::
:::image type="content" source="media/standalone/standalone-mode.png" lightbox="media/standalone/standalone-mode.png" alt-text="A screenshot of the .NET Aspire dashboard running in standalone mode.":::

## Start the dashboard

Expand Down
Loading