Introduce EventCounters overview article and tutorial doc #19635
Conversation
|
Hey, @noahfalk I'd love your thoughts on these - based on your #17027 (comment). |
IEvangelist
changed the title
|
Thanks @IEvangelist : ) I've got a few other reviews already queued up, but now this one is in the list too |
There was a problem hiding this comment.
Thanks @IEvangelist for your work putting these together! Hope the feedback is useful : )
IEvangelist
force-pushed
the
event-counters
branch
from
052d6da to
c2de932
Compare
|
/cc @josalem |
docs/core/diagnostics/snippets/EventCounters/ConditionalEventCounterSource.cs
Show resolved
Hide resolved
Co-authored-by: Noah Falk <[email protected]>
IEvangelist
force-pushed
the
event-counters
branch
from
a4a4415 to
d8f791d
Compare
|
|
||
| The .NET Core runtime and a few .NET libraries publish basic diagnostics information using EventCounters starting in .NET Core 3.0. Apart from the EventCounters that are provided by the .NET runtime, you may choose to implement your own EventCounters. EventCounters can be used to track various metrics. | ||
|
|
||
| EventCounters live as a part of an <xref:System.Diagnostics.Tracing.EventSource>, and are automatically pushed to listener tools on a regular basis. Like all other events on an <xref:System.Diagnostics.Tracing.EventSource>, they can be consumed both in-proc and out-of-proc via <xref:System.Diagnostics.Tracing.EventListener> and EventPipe. This article focuses on the cross-platform capabilities of EventCounters, and intentionally excludes PerfView and ETW (Event Tracing for Windows) - although both can be used with EventCounters. |
There was a problem hiding this comment.
Is there an intro to EventPipe that we can link to?
There was a problem hiding this comment.
Based on this issue, I'm assuming we should write a new article for it: dotnet/diagnostics#1183. As there isn't anything to link to yet. EventPipe would then link back to EventSource.
EventCounter <-> EventSource <-> EventPipe
|
|
||
| Throughout various .NET packages, basic metrics on GC, Just-in-Time (JIT), assemblies, exceptions, threading, networking, and web requests are published using EventCounters. | ||
|
|
||
| ### "System.Runtime" counters |
There was a problem hiding this comment.
Are quotation marks necessary here (and in the other headings that have them)?
There was a problem hiding this comment.
I choose to use them, as they are the name in which to directly access the counters. And they vary ever so slightly, notice the naming conventions inconsistently use . vs - delimiters.
Co-authored-by: Tom Dykstra <[email protected]>
Summary
Fixes #17027
Preview
✔️ EventCounters in .NET Core
✔️ Measure event frequency with EventCounters