Make "Built in Metrics for Runtime" doc accurate for memory metrics #44616
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…llection.heap.size` should be called gc.heap.generation See DotNet repository - https://github.com/dotnet/runtime/blob/adf123c23ee42262515c36562b09fa0b19959599/src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/RuntimeMetrics.cs#L191C110-L191C128
dotnet-policy-service
bot
added
dotnet-fundamentals/svc
community-contribution
jwreford99
changed the title
|
@tommcdon is there anything I can do to help get this merged? Sorry, am pretty new to this process so not sure if I need to do anymore steps to make your life easier! TIA 😄 |
noahfalk
approved these changes
Feb 18, 2025
There was a problem hiding this comment.
@jwreford99 - Thanks so much for taking the time to correct the docs!
This looks good to me assuming you merge in @gewarren's formatting suggestions.
|
Thanks for the reviews and for sorting the formatting suggestions! 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I was looking at https://learn.microsoft.com/en-us/dotnet/core/diagnostics/built-in-metrics-runtime and spotted a couple of things which don't seem to align with reality, so I've tried to fix them with this PR.
Firstly, the metrics
dotnet.gc.last_collection.heap.sizeanddotnet.gc.collectionslistdotnet.gc.heap.generationas an attribute to mark the generation they are referring to. But when I checked the source code, the attribute is calledgc.heap.generation. This is also what I have experienced while using this new meter.Secondly, the metric
dotnet.gc.last_collection.heap.fragmentation.sizehas no attributes listed. But when I checked the source code it had an attribute similarly calledgc.heap.generation. This has been my experience with the library as well. To address that I have copied the table from thedotnet.gc.last_collection.heap.sizemetric because it is exactly the same concept.Hopefully this format of submission is okay, I'm still pretty new to open source submissions!
Internal previews