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

Jump to bottom

Add JVM implementation information and memory semantic conventions #2777

Closed
wants to merge 2 commits into from
Closed

Add JVM implementation information and memory semantic conventions #2777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
087ae39
Add JVM information and memory semantic conventions
Roiocam Sep 8, 2022
703e98b
Add changelog entry
Roiocam Sep 8, 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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ release.
([#2691](https://github.com/open-telemetry/opentelemetry-specification/pull/2691)).
- Add OpenSearch to db.system semantic conventions
([#2718](https://github.com/open-telemetry/opentelemetry-specification/pull/2718)).
- Add semantic conventions for JVM implementation information and memory usage.
([#2776](https://github.com/open-telemetry/opentelemetry-specification/pull/2777)).

### Compatibility

Expand Down
56 changes: 36 additions & 20 deletions specification/metrics/semantic_conventions/runtime-environment-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,28 +61,44 @@ consider, for example pthreads vs green thread implementations.

All JVM metric attributes are required unless otherwise indicated.

| Name | Description | Unit | Unit ([UCUM](README.md#instrument-units)) | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values |
|--------------------------------------------|----------------------------------------------------------|---------|-------------------------------------------|---------------------------------------------------|------------|---------------|-----------------------|
| process.runtime.jvm.memory.usage | Measure of memory used | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.init | Measure of initial memory requested | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.committed | Measure of memory committed | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.limit | Measure of max obtainable memory | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.threads.count | Number of executing threads | threads | `{threads}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.classes.loaded | Number of classes loaded since JVM start | classes | `{classes}` | Counter | Int64 | | |
| process.runtime.jvm.classes.unloaded | Number of classes unloaded since JVM start | classes | `{classes}` | Counter | Int64 | | |
| process.runtime.jvm.classes.current_loaded | Number of classes currently loaded | classes | `{classes}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.cpu.utilization | Recent cpu utilization for the process [2] | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.system.cpu.utilization | Recent cpu utilization for the whole system [2] | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.system.cpu.load_1m | Average CPU load of the whole system for the last minute | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.buffer.usage | Measure of memory used by buffers | Bytes | `By` | UpDownCounter | Int64 | pool | Name of pool[3] |
| process.runtime.jvm.buffer.limit | Measure of total memory capacity of buffers | Bytes | `By` | UpDownCounter | Int64 | pool | Name of pool[3] |
| process.runtime.jvm.buffer.count | Number of buffers in the pool | buffers | `{buffers}` | UpDownCounter | Int64 | pool | Name of pool[3] |
| Name | Description | Unit | Unit ([UCUM](README.md#instrument-units)) | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values |
|------------------------------------------------|----------------------------------------------------------|--------------|-------------------------------------------|---------------------------------------------------|------------|---------------|-------------------------|
| process.runtime.jvm.memory.usage | Measure of memory used | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| process.runtime.jvm.memory.init | Measure of initial memory requested | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| process.runtime.jvm.memory.committed | Measure of memory committed | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| process.runtime.jvm.memory.limit | Measure of max obtainable area | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| process.runtime.jvm.memory.pool.usage | Measure of memory pool used | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.pool.init | Measure of initial memory pool requested | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
Roiocam marked this conversation as resolved.
Show resolved Hide resolved
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.pool.committed | Measure of memory pool committed | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.memory.pool.limit | Measure of max obtainable memory pool | Bytes | `By` | UpDownCounter | Int64 | type | `"heap"`, `"nonheap"` |
| | | | | | | pool | Name of pool [1] |
| process.runtime.jvm.threads.count | Number of executing threads | threads | `{threads}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.classes.loaded | Number of classes loaded since JVM start | classes | `{classes}` | Counter | Int64 | | |
| process.runtime.jvm.classes.unloaded | Number of classes unloaded since JVM start | classes | `{classes}` | Counter | Int64 | | |
| process.runtime.jvm.classes.current_loaded | Number of classes currently loaded | classes | `{classes}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.cpu.utilization | Recent cpu utilization for the process [2] | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.system.cpu.utilization | Recent cpu utilization for the whole system [2] | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.system.cpu.load_1m | Average CPU load of the whole system for the last minute | 1 | 1 | Asynchronous Gauge | Double | | |
| process.runtime.jvm.buffer.usage | Measure of memory used by buffers | Bytes | `By` | UpDownCounter | Int64 | pool | Name of pool[3] |
| process.runtime.jvm.buffer.limit | Measure of total memory capacity of buffers | Bytes | `By` | UpDownCounter | Int64 | pool | Name of pool[3] |
| process.runtime.jvm.buffer.count | Number of buffers in the pool | buffers | `{buffers}` | UpDownCounter | Int64 | pool | Name of pool[3] |
| process.runtime.jvm.up | Running status of JVM | 1 | 1 | Asynchronous Gauge | Int64 | | |
Roiocam marked this conversation as resolved.
Show resolved Hide resolved
| process.runtime.jvm.info | JVM implementation information | 1 | 1 | Asynchronous Gauge | Int64 | name | Name of JVM impl [4] |
Roiocam marked this conversation as resolved.
Show resolved Hide resolved
| | | | | | | vendor | Vendor of JVM impl [4] |
| | | | | | | version | Version of JVM impl [4] |
| process.runtime.jvm.start.time | The start time of the JVM | milliseconds | `ms` | Asynchronous Gauge | Int64 | | |
| process.runtime.jvm.up.time | The uptime of the JVM | milliseconds | `ms` | Asynchronous Gauge | Int64 | | |
Roiocam marked this conversation as resolved.
Show resolved Hide resolved
| process.runtime.jvm.available.processors | Number of processors available to the JVM | processors | `processors` | Asynchronous Gauge | Int64 | | |
Roiocam marked this conversation as resolved.
Show resolved Hide resolved
| process.runtime.jvm.open.file.descriptor.count | Number of open file descriptors | descriptor | `descriptor` | Asynchronous Gauge | Int64 | | |
| process.runtime.jvm.physical.memory.limit | Measure of max obtainable physical memory | Bytes | `By` | UpDownCounter | Int64 | | |
| process.runtime.jvm.physical.memory.free | Measure of obtainable physical memory | Bytes | `By` | UpDownCounter | Int64 | | |
| process.runtime.jvm.virtual.memory.committed | Measure of virtual memory committed | Bytes | `By` | UpDownCounter | Int64 | | |

**[1]**: Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()).
Examples include `G1 Old Gen`, `G1 Eden space`, `G1 Survivor Space`, `Metaspace`, etc.
**[2]**: These utilizations are not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`).
**[3]**: Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()).
**[4]**: JVM implementation names,vendor,version are generally obtained via [RuntimeMXBean](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/RuntimeMXBean.html).