Skip to content

Commit 8eb2e3d

Browse files
ManickaPgewarren
andauthored
Update telemetry events documentation with PII warning (#51284)
* Update telemetry events documentation with PII warning Added information about potential PII in internal diagnostics events and provided an example command to consume these events using dotnet-trace. * Update docs/fundamentals/networking/telemetry/events.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --------- Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent 6993c96 commit 8eb2e3d

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

  • docs/fundamentals/networking/telemetry

docs/fundamentals/networking/telemetry/events.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,14 +288,20 @@ You should think about such events separately. Monitor DNS resolutions or TLS ha
288288
## Internal diagnostics
289289

290290
Some components in .NET are instrumented with additional debug-level events that provide more insight into exactly what's happening internally.
291-
These events come with high performance overhead and their shape is constantly changing. As the name suggests, they are not part of the public API and you should therefore not rely on their behavior or existence.
291+
These events come with high performance overhead and their shape is constantly changing. As the name suggests, they are not part of the public API and you should therefore not rely on their behavior or existence. Moreover, they are not redacted and might contain PII.
292292

293293
Regardless, these events can offer a lot of insights when all else fails.
294294
The `System.Net` stack emits such events from `Private.InternalDiagnostics.System.Net.*` namespaces.
295295

296296
If you change the condition in the `EventListener` example above to `eventSource.Name.Contains("System.Net")`, you will see 100+ events from different layers in the stack.
297297
For more information, see the [full example](https://github.com/dotnet/docs/tree/main/docs/fundamentals/networking/snippets/internal-diag-telemetry/Program.cs).
298298
299+
To consume them outside of the process, use `dotnet-trace`, for example:
300+
301+
```console
302+
dotnet-trace collect --providers Private.InternalDiagnostics.System.Net.Http:0xf --process-id 1234
303+
```
304+
299305
## Samples
300306

301307
- [Measure DNS resolutions for a given endpoint](#measure-dns-resolutions-for-a-given-endpoint)

0 commit comments

Comments
 (0)