Repository navigation
[docs] Document dashboard self-telemetry OTLP service name - #1821
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
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
Bot
added
the
docs-from-code
4 of 14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#20600
@JamesNKTarget branch
Targeting
release/17.0based on the source PR milestone17.0(exact match found onmicrosoft/aspire.dev).Why this is needed
microsoft/aspire#20600 configures the Aspire dashboard's own OTLP trace export to use
aspire-dashboardas the defaultservice.name(instead of the generic OpenTelemetry SDK default), and disables automaticservice.instance.idgeneration so the resource identity stays stable. This is a user-facing configuration change (the PR body includes an explicit "User-facing usage" section describingOTEL_EXPORTER_OTLP_ENDPOINT/OTEL_SERVICE_NAMEbehavior), but the dashboard configuration reference didn't previously document the dashboard's own self-telemetry export at all.What changed
Added a new "Dashboard self-telemetry" subsection under
## OTLPinsrc/frontend/src/content/docs/dashboard/configuration.mdx, explaining:OTEL_EXPORTER_OTLP_ENDPOINTis set.service.nameisaspire-dashboard.OTEL_SERVICE_NAME, orservice.nameinOTEL_RESOURCE_ATTRIBUTES;OTEL_SERVICE_NAMEtakes precedence when both are set.service.instance.idisn't auto-generated for the dashboard's own resource, but a value supplied viaOTEL_RESOURCE_ATTRIBUTESis preserved.This mirrors the behavior added in
DashboardWebApplication.cs(DefaultOtlpServiceName = "aspire-dashboard",ConfigureResource(...).AddService(..., autoGenerateServiceInstanceId: false)) and the correspondingsrc/Aspire.Dashboard/README.mdupdate in the source PR.Files modified
src/frontend/src/content/docs/dashboard/configuration.mdx— added the "Dashboard self-telemetry" subsection (new content only, no existing text changed).No new pages were created; this is a targeted addition to the existing dashboard configuration reference page.