dotnet / dotnet/runtime

Diagnostic documentation and scripts for System.Net EventSource tracing is wrong

Open
#123,449 6 comments 0 reactions 0 assignees View on GitHub
area-System.Diagnostics.Tracing documentation
Dominant language
C#
Stars
18.3k
Forks
5.6k
PR merge metrics
PR metrics pending

Description

I was trying to use the System.Net EventSource tracing [as documented here](https://github.com/dotnet/runtime/blob/main/docs/workflow/debugging/libraries/windows-instructions.md#systemnet-namespaces) to diagnose a production issue, and I wasn't getting any events captured. I thought maybe I was specifying things incorrectly so tried to use the [scripts provided here](https://github.com/dotnet/runtime/tree/main/src/libraries/Common/tests/Scripts/Tools) to do the event capturing.

Both the documentation and the scripts have the wrong information in them. The original EventSource providers were renamed in PR #40781, and new EventSource providers were created with different events such as [the one here](https://github.com/dotnet/runtime/blob/main/src/libraries/System.Net.Http/src/System/Net/Http/HttpTelemetry.cs).

The documentation needs to be updated as searching the source code for EventSource implementations to find the names being used is not the ideal way to discover this information (and requires a bit more domain knowledge of the implementation than is reasonable). Even now I don't know what the practical difference is between the two sets of EventSource implementations, which should I be capturing (or should I capture both)?

I wasted a lot of time due to the documentation being wrong. At the very least the incorrect documentation should be deleted as in this case wrong information was worse than if there was no information.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.