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 semantic conventions for jvm cpu metrics #2292

Merged
merged 18 commits into from
May 27, 2022
Merged

Add semantic conventions for jvm cpu metrics #2292

Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
f1dffdd
Add semantic conventions for jvm cpu metrics
jonatan-ivanov Jan 25, 2022
7dad51a
usage -> utilization
jonatan-ivanov Jan 29, 2022
bac4a56
Merge branch 'main' into jvm-cpu
jonatan-ivanov Jan 29, 2022
23fd10d
Addressing review comments
jonatan-ivanov Mar 17, 2022
4674b89
Merge branch 'main' into jvm-cpu
jonatan-ivanov Mar 17, 2022
f15445a
Change name for cpu load avg
jonatan-ivanov Mar 19, 2022
efc6362
Gauge -> Asynchronous Gauge
jonatan-ivanov Mar 19, 2022
d276861
Merge branch 'main' into jvm-cpu
jonatan-ivanov Mar 21, 2022
87a4890
Merge branch 'main' into jvm-cpu
reyang Mar 22, 2022
a8951c9
Rewording recent cpu usage
jonatan-ivanov Mar 23, 2022
62356dd
Add side notes to utilization metrics
jonatan-ivanov Mar 31, 2022
37f220c
Add explanation to footnote [2]
jonatan-ivanov Mar 31, 2022
46effeb
Merge branch 'main' into jvm-cpu
jonatan-ivanov Mar 31, 2022
bcbc194
Merge branch 'main' into jvm-cpu
jonatan-ivanov Apr 9, 2022
589aba9
Merge branch 'main' into jvm-cpu
jonatan-ivanov May 9, 2022
9dbe7c4
Merge branch 'main' into jvm-cpu
jonatan-ivanov May 16, 2022
293b1b3
Merge branch 'main' into jvm-cpu
jonatan-ivanov May 26, 2022
4946ac4
Fixing toc
jonatan-ivanov May 26, 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
44 changes: 23 additions & 21 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 @@ -12,10 +12,10 @@ semantic conventions when instrumenting runtime environments.

<!-- toc -->

- [Metric Instruments](#metric-instruments)
- [Metric Instruments](#metric-instruments)
* [Runtime Environment Specific Metrics - `process.runtime.{environment}.`](#runtime-environment-specific-metrics---processruntimeenvironment)
- [Attributes](#attributes)
- [JVM Metrics](#jvm-metrics)
- [Attributes](#attributes)
- [JVM Metrics](#jvm-metrics)

<!-- tocstop -->

Expand Down Expand Up @@ -57,21 +57,23 @@ consider, for example pthreads vs green thread implementations.

All JVM metric attributes are required unless otherwise indicated.
bogdandrutu marked this conversation as resolved.
Show resolved Hide resolved

| 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.max | 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 currently loaded | classes | `{classes}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.classes.unloaded | Number of classes unloaded since JVM start | classes | `{classes}` | 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.
| 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.max | 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 currently loaded | classes | `{classes}` | UpDownCounter | Int64 | | |
| process.runtime.jvm.classes.unloaded | Number of classes unloaded since JVM start | classes | `{classes}` | UpDownCounter | Int64 | | |
reyang marked this conversation as resolved.
Show resolved Hide resolved
| 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 | | |
reyang marked this conversation as resolved.
Show resolved Hide resolved

**[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`).