From 29c9b6bc6297f203416aad011ebd985fd478f5bf Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Fri, 23 Jun 2023 07:58:22 -0700 Subject: [PATCH] Add 'as reported by the JVM' qualifier to JVM cpu metrics (#115) Co-authored-by: Armin Ruech --- .../metrics/process-runtime-jvm-metrics-experimental.yaml | 4 ++-- .../metrics/process-runtime-jvm-metrics.yaml | 4 ++-- .../semantic_conventions/runtime-environment-metrics.md | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics-experimental.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics-experimental.yaml index e0a3721d4..6b5d5b60d 100644 --- a/semantic_conventions/metrics/process-runtime-jvm-metrics-experimental.yaml +++ b/semantic_conventions/metrics/process-runtime-jvm-metrics-experimental.yaml @@ -10,7 +10,7 @@ groups: - id: metric.process.runtime.jvm.system.cpu.utilization type: metric metric_name: process.runtime.jvm.system.cpu.utilization - brief: "Recent CPU utilization for the whole system." + brief: "Recent CPU utilization for the whole system as reported by the JVM." note: > The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement @@ -22,7 +22,7 @@ groups: - id: metric.process.runtime.jvm.system.cpu.load_1m type: metric metric_name: process.runtime.jvm.system.cpu.load_1m - brief: "Average CPU load of the whole system for the last minute." + brief: "Average CPU load of the whole system for the last minute as reported by the JVM." note: > The value range is [0,n], where n is the number of CPU cores - or a negative number if the value is not available. This utilization is not defined as being for the specific interval since last measurement diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml index 5cf552519..1721b8e95 100644 --- a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml +++ b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml @@ -117,14 +117,14 @@ groups: - id: metric.process.runtime.jvm.cpu.time type: metric metric_name: process.runtime.jvm.cpu.time - brief: "CPU time used by the process." + brief: "CPU time used by the process as reported by the JVM." instrument: counter unit: "s" - id: metric.process.runtime.jvm.cpu.recent_utilization type: metric metric_name: process.runtime.jvm.cpu.recent_utilization - brief: "Recent CPU utilization for the process." + brief: "Recent CPU utilization for the process as reported by the JVM." note: > The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md index 9791f6365..faf21944c 100644 --- a/specification/metrics/semantic_conventions/runtime-environment-metrics.md +++ b/specification/metrics/semantic_conventions/runtime-environment-metrics.md @@ -283,7 +283,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuTime()`](https: | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `process.runtime.jvm.cpu.time` | Counter | `s` | CPU time used by the process. | +| `process.runtime.jvm.cpu.time` | Counter | `s` | CPU time used by the process as reported by the JVM. | @@ -299,7 +299,7 @@ Note that the JVM does not provide a definition of what "recent" means. | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `process.runtime.jvm.cpu.recent_utilization` | Gauge | `1` | Recent CPU utilization for the process. | +| `process.runtime.jvm.cpu.recent_utilization` | Gauge | `1` | Recent CPU utilization for the process as reported by the JVM. | @@ -345,7 +345,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getSystemCpuLoad()`](https:/ | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `process.runtime.jvm.system.cpu.utilization` | Gauge | `1` | Recent CPU utilization for the whole system. | +| `process.runtime.jvm.system.cpu.utilization` | Gauge | `1` | Recent CPU utilization for the whole system as reported by the JVM. | @@ -359,7 +359,7 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `process.runtime.jvm.system.cpu.load_1m` | Gauge | `1` | Average CPU load of the whole system for the last minute. | +| `process.runtime.jvm.system.cpu.load_1m` | Gauge | `1` | Average CPU load of the whole system for the last minute as reported by the JVM. |