Skip to content

Commit

Permalink
Mark process.runtime.jvm.system.cpu.load_1m and `process.runtime.jv…
Browse files Browse the repository at this point in the history
…m.system.cpu.utilization` metris as opt-in
  • Loading branch information
zeitlinger committed Jun 7, 2023
1 parent d6d2952 commit 12867d1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 2 additions & 0 deletions semantic_conventions/metrics/process-runtime-jvm-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ groups:
- id: metric.process.runtime.jvm.system.cpu.utilization
type: metric
metric_name: process.runtime.jvm.system.cpu.utilization
requirement_level: opt_in
brief: "Recent CPU utilization for the whole system."
note: >
The value range is [0.0,1.0].
Expand All @@ -149,6 +150,7 @@ groups:
- id: metric.process.runtime.jvm.system.cpu.load_1m
type: metric
metric_name: process.runtime.jvm.system.cpu.load_1m
requirement_level: opt_in
brief: "Average CPU load of the whole system for the last minute."
note: >
The value range is [0,n], where n is the number of CPU cores - or a negative number of the value is not available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuLoad()`](https:

### Metric: `process.runtime.jvm.system.cpu.utilization`

This metric is [recommended][MetricRecommended].
This metric is [Opt-In][MetricOptIn].
This metric is obtained from [`com.sun.management.OperatingSystemMXBean#getSystemCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getSystemCpuLoad()) on Java version 8..13, [`com.sun.management.OperatingSystemMXBean#getCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()) on Java version 14+,
and [`com.ibm.lang.management.OperatingSystemMXBean#getSystemCpuLoad()`](https://www.ibm.com/docs/api/v1/content/SSYKE2_8.0.0/com.ibm.java.api.80.doc/com.ibm.lang.management/com/ibm/lang/management/OperatingSystemMXBean.html#getSystemCpuLoad--) on J9.

Expand All @@ -330,7 +330,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getSystemCpuLoad()`](https:/

### Metric: `process.runtime.jvm.system.cpu.load_1m`

This metric is [recommended][MetricRecommended].
This metric is [Opt-In][MetricOptIn].
This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/OperatingSystemMXBean.html#getSystemLoadAverage--).

<!-- semconv metric.process.runtime.jvm.system.cpu.load_1m(metric_table) -->
Expand Down Expand Up @@ -400,4 +400,5 @@ This metric is obtained from [`BufferPoolMXBean#getCount()`](https://docs.oracle
<!-- endsemconv -->

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
[MetricOptIn]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/metrics/metric-requirement-level.md#opt-in
[MetricRecommended]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/metrics/metric-requirement-level.md#recommended

0 comments on commit 12867d1

Please sign in to comment.