Configure dashboard OTLP service name by JamesNK · Pull Request #20600 · microsoft/aspire

James Newton-King (JamesNK) · 2026-09-30T08:28:26Z

Description

Dashboard traces exported through OTLP now use aspire-dashboard as the default service.name, making dashboard telemetry identifiable instead of inheriting the OpenTelemetry SDK's generic default. Deployments can continue to override the name with OTEL_SERVICE_NAME.

The dashboard configures its OpenTelemetry resource only when the OTLP exporter is enabled and disables automatic service instance ID generation to keep the resource stable. Integration coverage verifies both the default and configured service names.

User-facing usage

Set OTEL_EXPORTER_OTLP_ENDPOINT to enable dashboard trace export. Optionally set OTEL_SERVICE_NAME to replace the default aspire-dashboard service name:

OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4317
OTEL_SERVICE_NAME=custom-dashboard

Validation:

dotnet test --project tests\Aspire.Dashboard.Tests\Aspire.Dashboard.Tests.csproj --no-launch-profile -- --filter-method "*.OtlpExporterConfigured_ConfiguresServiceName" --filter-not-trait "quarantined=true" --filter-not-trait "outerloop=true"
Passed: 2, Failed: 0, Skipped: 0

Fixes # (issue)

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-09-30T08:28:36Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 20600

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 20600"

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Copilot review overview

🟡 Changes recommended

The new fallback overrides service.name configured through OTEL_RESOURCE_ATTRIBUTES.

Review effort: Balanced
Findings: 1

Open (1)

Preserve OTEL_RESOURCE_ATTRIBUTES service.name override over dashboard fallback · New

What changed in this PR

Configures exported dashboard traces with an identifiable default service name.

Changes:

Defaults OTLP service.name to aspire-dashboard.
Supports OTEL_SERVICE_NAME overrides and adds integration coverage.

File	Description
`src/Aspire.Dashboard/DashboardWebApplication.cs`	Configures the OpenTelemetry resource service name.
`tests/Aspire.Dashboard.Tests/Integration/HealthTests.cs`	Tests default and explicitly configured names.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Copilot

Copilot review overview

🟡 Changes recommended

Automatic service instance ID generation remains enabled and the test incorrectly enforces that unstable behavior.

Review effort: Balanced
Findings: 3

Open (3)

Disable automatic service instance ID generation · New
Update assertion for disabled instance ID generation · New
Preserve OTEL_RESOURCE_ATTRIBUTES service.name override over dashboard fallback

David Pine (IEvangelist)

Consider the Copilot PR feedback, otherwise looks good.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Copilot review overview

🟢 Approval recommended

The scoped change has focused integration coverage; the remaining validation-description nit is non-blocking.

Review effort: Balanced
Findings: None

Resolved since last review (3)

Update assertion for disabled instance ID generation
Disable automatic service instance ID generation
Preserve OTEL_RESOURCE_ATTRIBUTES service.name override over dashboard fallback

github-actions · 2026-10-03T01:28:20Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

github-actions · 2026-10-03T02:21:50Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Copilot review overview

🟢 Approval recommended

The change is narrowly scoped, preserves environment overrides, and has focused regression coverage with no unresolved findings.

Review effort: Balanced
Findings: None

James Newton-King (JamesNK)

Found one confirmed configuration-compatibility regression (P2); reproduced both service-name configuration paths. No code changes made.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Copilot review overview

🟢 Approval recommended

The configured SDK supports application configuration overrides, and the focused implementation has no blocking findings.

Review effort: Balanced
Findings: None

github-actions · 2026-10-03T03:59:11Z

Tests selector

13 / 98 PR test projects · 2 PR jobs, from 2 changed files.

Selected PR test projects (13 / 98)

Aspire.Dashboard.Components.Tests, Aspire.Dashboard.Tests, Aspire.Hosting.Azure.Kubernetes.Tests, Aspire.Hosting.Azure.Tests, Aspire.Hosting.Blazor.Tests, Aspire.Hosting.Dotnet.Tests, Aspire.Hosting.DotnetTool.Tests, Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.Radius.Tests, Aspire.Hosting.Testing.Tests, Aspire.Hosting.Tests, Aspire.Playground.Tests, Aspire.Templates.Tests

Selected PR jobs (2)

extension-e2e, native-dashboard-validation

How these were chosen — grouped by what changed

⚠️ 11 of the 13 selected test projects come from a single change — src/Aspire.Dashboard/DashboardWebApplication.cs.

🔧 src/Aspire.Dashboard/DashboardWebApplication.cs (changed source)
→ 11 via the project graph: Aspire.Dashboard.Components.Tests, Aspire.Hosting.Azure.Kubernetes.Tests (3 hops), Aspire.Hosting.Azure.Tests (2 hops), Aspire.Hosting.Blazor.Tests (2 hops), Aspire.Hosting.Dotnet.Tests (2 hops), Aspire.Hosting.DotnetTool.Tests (2 hops), Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.Radius.Tests (2 hops), Aspire.Hosting.Testing.Tests, Aspire.Hosting.Tests, Aspire.Playground.Tests (2 hops)

📦 affected project Aspire.Dashboard
→ 1 test: Aspire.Templates.Tests

🧪 tests/Aspire.Dashboard.Tests/Integration/HealthTests.cs (changed test)
→ 1 directly: Aspire.Dashboard.Tests

Job reasons

Job	Triggered by
`extension-e2e`	• `src/Aspire.Dashboard/DashboardWebApplication.cs` • affected project `Aspire.Dashboard`
`native-dashboard-validation`	affected project `Aspire.Dashboard`

Selection computed for commit f919290.

github-actions · 2026-10-03T04:50:51Z

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

Documents the aspire-dashboard default service.name and OTEL_SERVICE_NAME override behavior for dashboard self-telemetry export, from microsoft/aspire#20600. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

aspire-repo-bot · 2026-10-03T05:10:34Z

Pull request created: #1821

Generated by PR Documentation Check · copilot · auto · 98 AIC · ⌖ 12.5 AIC · ⊞ 20.3K

aspire-repo-bot · 2026-10-03T05:10:52Z

📝 Documentation has been drafted in microsoft/aspire.dev#1821 targeting release/17.0.

Step 5: docs_optional→no, actually recommendation was docs_required (triggered signals: pr_body_has_cli_flag_mention, pr_body_has_user_facing_section — evidence: PR body's "User-facing usage" section documenting OTEL_EXPORTER_OTLP_ENDPOINT/OTEL_SERVICE_NAME and a test-command snippet). Drafted docs PR adds a "Dashboard self-telemetry" subsection to dashboard/configuration.mdx under ## OTLP, documenting: the dashboard exports its own traces only when OTEL_EXPORTER_OTLP_ENDPOINT is set; the default service.name is aspire-dashboard; override via OTEL_SERVICE_NAME or service.name in OTEL_RESOURCE_ATTRIBUTES (with OTEL_SERVICE_NAME precedence); and that service.instance.id is preserved from OTEL_RESOURCE_ATTRIBUTES but not auto-generated — matching DashboardWebApplication.cs's DefaultOtlpServiceName/autoGenerateServiceInstanceId: false and the PR's README.md update.

Note

This draft PR needs human review before merging.

Configure dashboard OTLP service name

af960fb

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

James Newton-King (JamesNK) requested a review from Adam Ratzman (adamint) as a code owner September 30, 2026 08:28

aspire-repo-bot Bot requested a balanced review from Copilot September 30, 2026 08:28

github-actions Bot added the area-dashboard label Sep 30, 2026

Copilot started reviewing on behalf of James Newton-King (JamesNK) September 30, 2026 08:29

View session

This comment has been minimized.

Sign in to view

Generate dashboard OTLP service instance ID

6b4746e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI reviewed Sep 30, 2026

View reviewed changes

Comment thread src/Aspire.Dashboard/DashboardWebApplication.cs Outdated

aspire-repo-bot Bot requested a balanced review from Copilot September 30, 2026 08:35

Copilot started reviewing on behalf of James Newton-King (JamesNK) September 30, 2026 08:36

View session

This comment has been minimized.

Sign in to view

Copilot AI reviewed Sep 30, 2026

View reviewed changes

Comment thread src/Aspire.Dashboard/DashboardWebApplication.cs Outdated

Comment thread tests/Aspire.Dashboard.Tests/Integration/HealthTests.cs Outdated

github-actions Bot mentioned this pull request Sep 30, 2026

[repo-pulse] Daily Report #16404

Open

David Pine (IEvangelist) approved these changes Oct 2, 2026

View reviewed changes

Preserve dashboard OTLP resource overrides

709d16c

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

aspire-repo-bot Bot requested a balanced review from Copilot October 3, 2026 00:34

Copilot started reviewing on behalf of James Newton-King (JamesNK) October 3, 2026 00:35

View session

This comment has been minimized.

Sign in to view

Copilot AI reviewed Oct 3, 2026

View reviewed changes

Isolate dashboard OTLP environment tests

398a5e9

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

aspire-repo-bot Bot requested a balanced review from Copilot October 3, 2026 03:30

Copilot started reviewing on behalf of James Newton-King (JamesNK) October 3, 2026 03:31

View session

This comment has been minimized.

Sign in to view

James Newton-King (JamesNK) enabled auto-merge (squash) October 3, 2026 03:34

Copilot AI reviewed Oct 3, 2026

View reviewed changes

James Newton-King (JamesNK) commented Oct 3, 2026

View reviewed changes

Comment thread src/Aspire.Dashboard/DashboardWebApplication.cs Outdated

Honor dashboard OTLP application configuration

f919290

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

aspire-repo-bot Bot requested a balanced review from Copilot October 3, 2026 03:50

Copilot started reviewing on behalf of James Newton-King (JamesNK) October 3, 2026 03:51

View session

Copilot AI reviewed Oct 3, 2026

View reviewed changes

James Newton-King (JamesNK) merged commit 1ce8ac6 into main Oct 3, 2026
300 of 303 checks passed

microsoft-github-policy-service Bot added this to the 17.0 milestone Oct 3, 2026

aspire-repo-bot Bot mentioned this pull request Oct 3, 2026

[docs] Document dashboard self-telemetry OTLP service name microsoft/aspire.dev#1821

Draft

Conversation

James Newton-King (JamesNK) commented Sep 30, 2026

Description

User-facing usage

Checklist

Uh oh!

github-actions Bot commented Sep 30, 2026

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

David Pine (IEvangelist) left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

github-actions Bot commented Oct 3, 2026

Uh oh!

github-actions Bot commented Oct 3, 2026

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

James Newton-King (JamesNK) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟢 Approval recommended

Uh oh!

github-actions Bot commented Oct 3, 2026

Tests selector

Selected PR test projects (13 / 98)

Selected PR jobs (2)

Job reasons

Uh oh!

github-actions Bot commented Oct 3, 2026

Uh oh!

Uh oh!

aspire-repo-bot Bot commented Oct 3, 2026

Uh oh!

aspire-repo-bot Bot commented Oct 3, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants