Skip to content
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

Distributed tracing in networking #44063

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

antonfirsov
Copy link
Member

@antonfirsov antonfirsov commented Dec 23, 2024

This is a major rework of #42830, extending the content, making the information more specific and IMO easier to follow. The biggest change is the in the collection paragraphs:

  • I dropped the definitions of terms instrumentation, collection, export, OpenTelemetry etc., given that we were already using them in the intro, so it felt rather pointless to define them at that point; IMO the reader is looking for practical guidelines and examples anyways.
  • Instead, I added a summary of the available methods, so readers can navigate the document following their preferences and goals.
  • Metrics.md: Added back the dotnet-monitor example. Reintroduced a short paragraph on prometheus/grafana, since the referenced docs need some augmentation.

Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/distributed-tracing-builtin-activities.md Built-in activities in .NET
docs/fundamentals/networking/telemetry/metrics.md Networking metrics
docs/fundamentals/networking/telemetry/overview.md Networking telemetry in .NET
docs/fundamentals/networking/telemetry/tracing.md docs/fundamentals/networking/telemetry/tracing
docs/fundamentals/toc.yml docs/fundamentals/toc

@antonfirsov antonfirsov modified the milestones: December 2024, April 2025 Dec 25, 2024
@antonfirsov antonfirsov marked this pull request as ready for review January 8, 2025 18:44
@antonfirsov antonfirsov requested a review from samsp-msft January 8, 2025 18:45
Copy link
Member

@samsp-msft samsp-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great content. Lets make the changes to the core telemetry example so you don't need to document how to modify it.

docs/fundamentals/networking/telemetry/metrics.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/metrics.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/metrics.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/metrics.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/tracing.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/tracing.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/tracing.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/tracing.md Outdated Show resolved Hide resolved
docs/fundamentals/networking/telemetry/tracing.md Outdated Show resolved Hide resolved
@antonfirsov antonfirsov requested a review from gewarren January 23, 2025 18:25
@antonfirsov
Copy link
Member Author

@gewarren would you mind doing a language review on this? (Though I think it's mostly ok, so it's optional.)

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll wait to review the rest until you've run Acrolinx (see one of the comments I left).

@@ -17,16 +17,20 @@ They are also [multi-dimensional](../../../core/diagnostics/metrics-instrumentat
> [!TIP]
> For a comprehensive list of all built-in instruments together with their attributes, see [System.Net metrics](../../../core/diagnostics/built-in-metrics-system-net.md).

## Collect System.Net metrics
## Collecting System.Net metrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've been trained not to use -ing words in headings and titles - see for example https://review.learn.microsoft.com/help/platform/metadata-required-articles?branch=main#title.


There are two parts to using metrics in a .NET app:
In order to take advangage of the built-in metrics instrumentation, a .NET app needs to be configured to collect these metrics. This typically means transforming them for external storage and analysis, e.g., to monitoring systems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you edit these files in VS Code? If so, it would be good to run Acrolinx on them to find a lot of the stuff that I would otherwise find. See https://review.learn.microsoft.com/en-us/help/platform/acrolinx-vscode-setup?branch=main#install-acrolinx-in-visual-studio-code.


There are two parts to using metrics in a .NET app:
In order to take advangage of the built-in metrics instrumentation, a .NET app needs to be configured to collect these metrics. This typically means transforming them for external storage and analysis, e.g., to monitoring systems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to take advangage of the built-in metrics instrumentation, a .NET app needs to be configured to collect these metrics. This typically means transforming them for external storage and analysis, e.g., to monitoring systems.
To take advantage of the built-in metrics instrumentation, a .NET app needs to be configured to collect these metrics. This typically means transforming them for external storage and analysis, for example, for monitoring systems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants