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.

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
19 changes: 19 additions & 0 deletions src/OpenTelemetry.Instrumentation.Runtime/README.md
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 even before first garbage collection has occurred.

| 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