Add process.runtime.jvm.available_processors metric

open-telemetry · May 8, 2023 · ba2a678 · ba2a678
1 parent 97940e7
commit ba2a678
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,8 @@ release.
 - Add transition plan for upcoming breaking changes to the unstable HTTP semantic
   conventions.
   ([#3443](https://github.com/open-telemetry/opentelemetry-specification/pull/3443))
+- Add `process.runtime.jvm.available_processors` metric.
+  ([#3484](https://github.com/open-telemetry/opentelemetry-specification/pull/3484))
 
 ### Compatibility
 

diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml
@@ -149,6 +149,13 @@ groups:
     instrument: gauge
     unit: "1"
 
+  - id: metric.process.runtime.jvm.available_processors
+    type: metric
+    metric_name: process.runtime.jvm.available_processors
+    brief: "The number of processors available to the JVM."
+    instrument: updowncounter
+    unit: "{processor}"
+
   - id: attributes.process.runtime.jvm.buffer
     type: attribute_group
     brief: "Describes JVM buffer metric attributes."

diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md
@@ -341,6 +341,17 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht
 <!-- semconv metric.process.runtime.jvm.system.cpu.load_1m(full) -->
 <!-- endsemconv -->
 
+### Metric: `process.runtime.jvm.available_processors`
+
+This metric is [recommended](../metric-requirement-level.md#recommended).
+This metric is obtained from [`OperatingSystemMXBean#getAvailableProcessors()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/OperatingSystemMXBean.html#getAvailableProcessors--).
+
+<!-- semconv metric.process.runtime.jvm.available_processors(metric_table) -->
+| Name     | Instrument Type | Unit (UCUM) | Description    |
+| -------- | --------------- | ----------- | -------------- |
+| `process.runtime.jvm.available_processors` | UpDownCounter | `{processor}` | The number of processors available to the JVM. |
+<!-- endsemconv -->
+
 ### Metric: `process.runtime.jvm.buffer.usage`
 
 This metric is [recommended](../metric-requirement-level.md#recommended).