-
Notifications
You must be signed in to change notification settings - Fork 279
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
[Instrumentation.Runtime] Add description for metrics in README.md
#475
Conversation
README.md
README.md
Codecov Report
@@ Coverage Diff @@
## main #475 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 163 163
Lines 4983 4983
=====================================
Misses 4983 4983
|
…that it doens't include generation counts on other generations
@@ -60,6 +60,138 @@ using var meterProvider = Sdk.CreateMeterProviderBuilder() | |||
Refer to [Program.cs](../../examples/runtime-instrumentation/Program.cs) for a | |||
complete demo. | |||
|
|||
## Metrics | |||
|
|||
### GC related metrics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest to use heading for each of the metric, instead of the table. It'll be easier to link to individual metric that way. And we can write very long, details about the metric. (Description in this doc is not that important, as it is already part of metric descripption.) We could do more here, like "what value is considered typically okay, what is the action item if this value is high/low etc."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eventually "tutorials:" like this : https://docs.microsoft.com/en-us/dotnet/core/diagnostics/debug-threadpool-starvation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was more of thinking to make it easier for people who want to have a quick glance to know what to expect without having to dive into the code. I like your tutorial idea, and we can also include tools to use, etc. but it would be much more than the scope of this PR.
Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
@xiang17 Looks good to me |
Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Changes
Add description for metrics in
README.md
For significant contributions please make sure you have completed the following items: