Skip to content

[docs] Document dashboard self-telemetry OTLP service name #1821

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
+11 −0
Draft

[docs] Document dashboard self-telemetry OTLP service name #1821

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
11 changes: 11 additions & 0 deletions src/frontend/src/content/docs/dashboard/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,17 @@ export DASHBOARD__OTLP__ALLOWEDCERTIFICATES__0__THUMBPRINT="HEX_SHA256_THUMBPRIN
If no allowed certificates are configured then all certificates that pass [ASP.NET Core certificate validation](https://learn.microsoft.com/aspnet/core/security/authentication/certauth#configure-certificate-validation) can authenticate.
</Aside>

### Dashboard self-telemetry

The dashboard can export its own traces over OTLP, separate from the telemetry it receives from your app's resources. Set `OTEL_EXPORTER_OTLP_ENDPOINT` to enable export; the dashboard doesn't configure an OpenTelemetry resource or export its own traces unless this variable is set.

Exported traces use `aspire-dashboard` as the default `service.name`. Override it with `OTEL_SERVICE_NAME`, or with `service.name` in `OTEL_RESOURCE_ATTRIBUTES`. `OTEL_SERVICE_NAME` takes precedence when both are specified. The dashboard doesn't generate a `service.instance.id` for itself, but preserves one supplied through `OTEL_RESOURCE_ATTRIBUTES`.

```bash
export OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317"
export OTEL_SERVICE_NAME="custom-dashboard"
```

## Data persistence

The dashboard stores resources and telemetry in a SQLite database. Persistence behavior depends on how the dashboard is started: an AppHost-launched dashboard defaults to retaining separate application runs, while the standalone dashboard defaults to deleting its temporary database when it stops. The [application name](#other) is used to partition persisted data.
Expand Down
Loading