[Instrumentation.Runtime] Update readme after inclusion of process.runtime.dotnet.gc.objects.size #772
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
Kielek
approved these changes
Nov 17, 2022
utpilla
reviewed
Nov 17, 2022
utpilla
added
the
comp:instrumentation.runtime
cijothomas
reviewed
Nov 17, 2022
|
|
||
| * [GC.GetTotalMemory](https://docs.microsoft.com/dotnet/api/system.gc.gettotalmemory): | ||
| Retrieves the number of bytes currently thought to be allocated. | ||
| The value is an approximate count. |
There was a problem hiding this comment.
would be nice to indicate that this value is not the snapshot from the last GC event, and also that this metric will be available irrespective of if a GC event has occured or not.
cijothomas
reviewed
Nov 18, 2022
| Count of bytes currently in use by objects in the GC heap that haven't been | ||
| collected yet. | ||
| Fragmentation and other GC committed memory pools are excluded. | ||
| The value is available irrespective of GC events. |
There was a problem hiding this comment.
Updated again in 12919a6.
I tried to be consistent with other metrics description.
Indication that value is not a snapshot is included in description of API used.
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
utpilla
approved these changes
Nov 28, 2022
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.
Changes
Requested in #683 (comment)
Update
README.mdto reflect addition ofprocess.runtime.dotnet.gc.objects.sizemetric.Key distinctions between
process.runtime.dotnet.gc.objects.sizeand other heap size metrics as identified here included in metric description.