Add process.runtime.jvm.cpu.time metric (#55)

open-telemetry · Jun 14, 2023 · 8f9fbdf · 8f9fbdf
1 parent f07495d
commit 8f9fbdf
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,3 +80,5 @@ release.
   ([#70](https://github.com/open-telemetry/semantic-conventions/pull/70))
 - Clarify that OTEL_SEMCONV_STABILITY_OPT_IN is a comma-separated list of values
   ([#104](https://github.com/open-telemetry/semantic-conventions/pull/104))
+- Add `process.runtime.jvm.cpu.time` metric.
+  ([#55](https://github.com/open-telemetry/semantic-conventions/pull/55))
diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml
@@ -122,6 +122,13 @@ groups:
     instrument: updowncounter
     unit: "{class}"
 
+  - id: metric.process.runtime.jvm.cpu.time
+    type: metric
+    metric_name: process.runtime.jvm.cpu.time
+    brief: "CPU time used by the process."
+    instrument: counter
+    unit: "s"
+
   - id: metric.process.runtime.jvm.cpu.recent_utilization
     type: metric
     metric_name: process.runtime.jvm.cpu.recent_utilization

diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md
@@ -30,6 +30,7 @@ semantic conventions when instrumenting runtime environments.
   * [Metric: `process.runtime.jvm.classes.loaded`](#metric-processruntimejvmclassesloaded)
   * [Metric: `process.runtime.jvm.classes.unloaded`](#metric-processruntimejvmclassesunloaded)
   * [Metric: `process.runtime.jvm.classes.current_loaded`](#metric-processruntimejvmclassescurrent_loaded)
+  * [Metric: `process.runtime.jvm.cpu.time`](#metric-processruntimejvmcputime)
   * [Metric: `process.runtime.jvm.cpu.recent_utilization`](#metric-processruntimejvmcpurecent_utilization)
   * [Metric: `process.runtime.jvm.system.cpu.utilization`](#metric-processruntimejvmsystemcpuutilization)
   * [Metric: `process.runtime.jvm.system.cpu.load_1m`](#metric-processruntimejvmsystemcpuload_1m)
@@ -298,6 +299,22 @@ This metric is obtained from [`ClassLoadingMXBean#getLoadedClassCount()`](https:
 <!-- semconv metric.process.runtime.jvm.classes.current_loaded(full) -->
 <!-- endsemconv -->
 
+### Metric: `process.runtime.jvm.cpu.time`
+
+This metric is [recommended][MetricRecommended].
+
+This metric is obtained from [`com.sun.management.OperatingSystemMXBean#getProcessCpuTime()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuTime()) on HotSpot
+and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuTime()`](https://www.ibm.com/docs/api/v1/content/SSYKE2_8.0.0/openj9/api/jdk8/jre/management/extension/com/ibm/lang/management/OperatingSystemMXBean.html#getProcessCpuTime--) on J9.
+
+<!-- semconv metric.process.runtime.jvm.cpu.time(metric_table) -->
+| Name     | Instrument Type | Unit (UCUM) | Description    |
+| -------- | --------------- | ----------- | -------------- |
+| `process.runtime.jvm.cpu.time` | Counter | `s` | CPU time used by the process. |
+<!-- endsemconv -->
+
+<!-- semconv metric.process.runtime.jvm.cpu.time(full) -->
+<!-- endsemconv -->
+
 ### Metric: `process.runtime.jvm.cpu.recent_utilization`
 
 This metric is [recommended][MetricRecommended].