Rename two JVM runtime metrics

open-telemetry · May 5, 2023 · 3e9f890 · 3e9f890
1 parent 88e0e7e
commit 3e9f890
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -50,6 +50,11 @@ release.
   ([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
 - BREAKING: Remove `messaging.consumer.id`, make `messaging.client_id` generic
   ([#3336](https://github.com/open-telemetry/opentelemetry-specification/pull/3336))
+- BREAKING: Rename metric `process.runtime.jvm.cpu.utilization` to
+  `process.runtime.jvm.cpu.recent_utilization`, and rename metric
+  `process.runtime.jvm.system.cpu.utilization` to
+  `process.runtime.jvm.system.cpu.recent_utilization`
+  ([#3472](https://github.com/open-telemetry/opentelemetry-specification/pull/3472))
 
 ### Compatibility
 

diff --git a/schemas/1.21.0 b/schemas/1.21.0
@@ -9,6 +9,12 @@ versions:
             attribute_map:
               messaging.kafka.client_id: messaging.client_id
               messaging.rocketmq.client_id: messaging.client_id
+    metrics:
+      changes:
+        # https://github.com/open-telemetry/opentelemetry-specification/pull/3472
+        - rename_metrics:
+            process.runtime.jvm.cpu.utilization: process.runtime.jvm.cpu.recent_utilization
+            process.runtime.jvm.system.cpu.utilization: process.runtime.jvm.system.cpu.recent_utilization
   1.20.0:
     spans:
       changes:

diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml
@@ -122,19 +122,19 @@ groups:
     instrument: updowncounter
     unit: "{class}"
 
-  - id: metric.process.runtime.jvm.cpu.utilization
+  - id: metric.process.runtime.jvm.cpu.recent_utilization
     type: metric
-    metric_name: process.runtime.jvm.cpu.utilization
+    metric_name: process.runtime.jvm.cpu.recent_utilization
     brief: "Recent CPU utilization for the process."
     note: >
       This utilization is not defined as being for the specific interval since last measurement
       (unlike `system.cpu.utilization`).
     instrument: gauge
     unit: "1"
 
-  - id: metric.process.runtime.jvm.system.cpu.utilization
+  - id: metric.process.runtime.jvm.system.cpu.recent_utilization
     type: metric
-    metric_name: process.runtime.jvm.system.cpu.utilization
+    metric_name: process.runtime.jvm.system.cpu.recent_utilization
     brief: "Recent CPU utilization for the whole system."
     note: >
       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
@@ -285,30 +285,30 @@ This metric is [recommended](../metric-requirement-level.md#recommended).
 <!-- semconv metric.process.runtime.jvm.classes.current_loaded(full) -->
 <!-- endsemconv -->
 
-### Metric: `process.runtime.jvm.cpu.utilization`
+### Metric: `process.runtime.jvm.cpu.recent_utilization`
 
 This metric is [recommended](../metric-requirement-level.md#recommended).
 
-<!-- semconv metric.process.runtime.jvm.cpu.utilization(metric_table) -->
+<!-- semconv metric.process.runtime.jvm.cpu.recent_utilization(metric_table) -->
 | Name     | Instrument Type | Unit (UCUM) | Description    |
 | -------- | --------------- | ----------- | -------------- |
-| `process.runtime.jvm.cpu.utilization` | Gauge | `1` | Recent CPU utilization for the process. |
+| `process.runtime.jvm.cpu.recent_utilization` | Gauge | `1` | Recent CPU utilization for the process. |
 <!-- endsemconv -->
 
-<!-- semconv metric.process.runtime.jvm.cpu.utilization(full) -->
+<!-- semconv metric.process.runtime.jvm.cpu.recent_utilization(full) -->
 <!-- endsemconv -->
 
-### Metric: `process.runtime.jvm.system.cpu.utilization`
+### Metric: `process.runtime.jvm.system.cpu.recent_utilization`
 
 This metric is [recommended](../metric-requirement-level.md#recommended).
 
-<!-- semconv metric.process.runtime.jvm.system.cpu.utilization(metric_table) -->
+<!-- semconv metric.process.runtime.jvm.system.cpu.recent_utilization(metric_table) -->
 | 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.recent_utilization` | Gauge | `1` | Recent CPU utilization for the whole system. |
 <!-- endsemconv -->
 
-<!-- semconv metric.process.runtime.jvm.system.cpu.utilization(full) -->
+<!-- semconv metric.process.runtime.jvm.system.cpu.recent_utilization(full) -->
 <!-- endsemconv -->
 
 ### Metric: `process.runtime.jvm.system.cpu.load_1m`