From 62513fbc50f8ba368c78a90d4ac4020a592014ca Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 31 May 2023 07:12:03 -0700 Subject: [PATCH] Clarify `process.runtime.jvm.threads.count` refers to platform threads (#54) --- CHANGELOG.md | 2 ++ semantic_conventions/metrics/process-runtime-jvm-metrics.yaml | 2 +- .../semantic_conventions/runtime-environment-metrics.md | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca6606f86..298f090d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,3 +66,5 @@ release. ([#3458](https://github.com/open-telemetry/opentelemetry-specification/pull/3458)) - Specify the value range for JVM CPU metrics. ([#13](https://github.com/open-telemetry/semantic-conventions/pull/13)) +- Clarify `process.runtime.jvm.threads.count` refers to platform threads. + ([#54](https://github.com/open-telemetry/semantic-conventions/pull/54)) diff --git a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml index fd2aa5d35..946d0f6e6 100644 --- a/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml +++ b/semantic_conventions/metrics/process-runtime-jvm-metrics.yaml @@ -92,7 +92,7 @@ groups: - id: metric.process.runtime.jvm.threads.count type: metric metric_name: process.runtime.jvm.threads.count - brief: "Number of executing threads." + brief: "Number of executing platform threads." instrument: updowncounter unit: "{thread}" attributes: diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md index bd5e2dc97..04de405dd 100644 --- a/specification/metrics/semantic_conventions/runtime-environment-metrics.md +++ b/specification/metrics/semantic_conventions/runtime-environment-metrics.md @@ -242,11 +242,12 @@ of `[]` (single bucket histogram capturing count, sum, min, max). This metric is [recommended][MetricRecommended]. This metric is obtained from [`ThreadMXBean#getDaemonThreadCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getDaemonThreadCount--) and [`ThreadMXBean#getThreadCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getThreadCount--). +Note that this is the number of platform threads (as opposed to virtual threads). | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `process.runtime.jvm.threads.count` | UpDownCounter | `{thread}` | Number of executing threads. | +| `process.runtime.jvm.threads.count` | UpDownCounter | `{thread}` | Number of executing platform threads. |