Skip to content
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.

Sign up for GitHub

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] Update readme after inclusion of process.runtime.dotnet.gc.objects.size #772

Merged
merged 9 commits into from
Nov 28, 2022
Merged

[Instrumentation.Runtime] Update readme after inclusion of process.runtime.dotnet.gc.objects.size #772

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
01d3834
update readme
lachmatt Nov 17, 2022
50ae456
formatting
lachmatt Nov 17, 2022
6e3624b
formatting cntd
lachmatt Nov 17, 2022
b04b72a
Merge branch 'main' into objects-size-readme
cijothomas Nov 17, 2022
bd9b487
include PR suggestions
lachmatt Nov 18, 2022
439ebdf
Merge branch 'main' into objects-size-readme
lachmatt Nov 18, 2022
12919a6
additional suggestions
lachmatt Nov 28, 2022
95b5992
Merge branch 'main' into objects-size-readme
lachmatt Nov 28, 2022
f8c200d
fix spelling
lachmatt Nov 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/OpenTelemetry.Instrumentation.Runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,25 @@ The API used to retrieve the value is:
The number of times garbage collection has occurred for the specified generation
of objects.

#### process.runtime.dotnet.**gc.objects.size**

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not very clear statement.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


| Units | Instrument Type | Value Type | Attribute Key(s) | Attribute Values |
|---------|-------------------------|------------|-------------------|------------------|
| `bytes` | ObservableUpDownCounter | `Int64` | No Attributes | N/A |

The API used to retrieve the value is:

* [GC.GetTotalMemory](https://docs.microsoft.com/dotnet/api/system.gc.gettotalmemory):
utpilla marked this conversation as resolved.
Show resolved Hide resolved
Retrieves the number of bytes currently thought to be allocated.
The value is an approximate count. API is called with `false`
as a value of forceFullCollection parameter. Returns an instantaneous
value at the time of observation.

#### process.runtime.dotnet.**gc.allocations.size**

Count of bytes allocated on the managed GC heap since the process start.
Expand Down