Open
Improve OTLP observability example: add usings, reorder steps, refresh versions#55623
Conversation
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
… versions and port guidance Co-authored-by: adegeo <67293991+adegeo@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update OTEL article with additional coding information
Improve OTLP observability example: add usings, reorder steps, refresh versions
Aug 20, 2026
The Program.cs under snippets/OTLP-Example/csharp is shared with observability-applicationinsights.md, so editing it for this article risked breaking that unrelated article. Create a dedicated snippets/observability-otlp-example/csharp project (via dotnet new web) with its own Program.cs, NuGet package references, and snippet region markers, and point this article's code references at it. Revert the Snippet_Usings markers that had been added to the shared file. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ge commands Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Move the NuGet package reference step right after project creation - Drop the trailing (); when referencing builder.Build in prose - Simplify the OTEL configuration step intro instead of linking back - Fix a comment typo and add spacing/comment in the metrics setup Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Convert passive voice to active voice throughout - Replace weak instruction language with imperative mood - Remove first-person plural (we/our), gerund clauses, and 'there are' constructions - Fix word choice (may->might/can, as->because, additional->other, env vars->environment variables) - Format file names and identifiers as code, not italics - Rename gerund headings (Viewing the metrics/tracing -> Metrics view/Tracing view) - Add ai-usage: ai-assisted front matter Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Add a new opening paragraph stating what the article shows how to do - Shorten title/H1 to 'Use OpenTelemetry with OTLP and the Aspire Dashboard' (drop redundant 'Example:' and 'standalone') - Rewrite meta description as a concise, keyword-focused summary - Update the matching link text in observability-with-otel.md and the TOC entry Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
adegeo
marked this pull request as ready for review
August 21, 2026 15:55
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.
What was changed:
Fixes #45899
Fixes #55622
Copilot's stuff...
The OTLP/Aspire Dashboard example article required trial and error to follow: it omitted
usingdirectives, had readers ping-pong between later and earlier insertion points inProgram.cs, referenced an outdated package version, and hardcoded a port that doesn't match whatdotnet runactually outputs.Article structure
Snippet_Usingsmarker inProgram.csbuilder.Build();) now come before the API endpoint step (which comes afterbuilder.Build();), so readers no longer jump backward to insert earlier codeContent fixes
1.9.0to1.17.0, matching the sample.csprojcurl -k http://localhost:7275example with guidance to read the actual listening port from thedotnet runconsole output, since it can differ per environmentInternal previews