Skip to content

Commit 456d34b

Browse files
committed
Mark JVM metrics stable
1 parent efd9345 commit 456d34b

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ release.
4040
([#488](https://github.com/open-telemetry/semantic-conventions/pull/488))
4141
- Remove no longer relevant Oct 1 mention from `OTEL_SEMCONV_STABILITY_OPT_IN`
4242
([#541](https://github.com/open-telemetry/semantic-conventions/pull/541))
43+
- JVM metrics marked stable
44+
([#999](https://github.com/open-telemetry/semantic-conventions/pull/999))
4345

4446
## v1.23.0 (2023-11-03)
4547

docs/runtime/jvm-metrics.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: Runtime Environment
44

55
# Semantic Conventions for JVM Metrics
66

7-
**Status**: [Experimental][DocumentStatus]
7+
**Status**: [Mixed][DocumentStatus]
88

99
This document describes semantic conventions for JVM metrics in OpenTelemetry.
1010

@@ -29,7 +29,7 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry.
2929
* [Metric: `jvm.cpu.time`](#metric-jvmcputime)
3030
* [Metric: `jvm.cpu.count`](#metric-jvmcpucount)
3131
* [Metric: `jvm.cpu.recent_utilization`](#metric-jvmcpurecent_utilization)
32-
- [Very experimental](#very-experimental)
32+
- [Experimental](#very-experimental)
3333
* [Metric: `jvm.memory.init`](#metric-jvmmemoryinit)
3434
* [Metric: `jvm.system.cpu.utilization`](#metric-jvmsystemcpuutilization)
3535
* [Metric: `jvm.system.cpu.load_1m`](#metric-jvmsystemcpuload_1m)
@@ -41,6 +41,8 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry.
4141

4242
## JVM Memory
4343

44+
**Status**: [Stable][DocumentStatus]
45+
4446
**Description:** Java Virtual Machine (JVM) metrics captured under the namespace `jvm.memory.*`
4547

4648
### Metric: `jvm.memory.used`
@@ -153,6 +155,8 @@ This metric is obtained from [`MemoryPoolMXBean#getCollectionUsage()`](https://d
153155

154156
## JVM Garbage Collection
155157

158+
**Status**: [Stable][DocumentStatus]
159+
156160
**Description:** Java Virtual Machine (JVM) metrics captured under the namespace `jvm.gc.*`
157161

158162
### Metric: `jvm.gc.duration`
@@ -270,6 +274,8 @@ This metric is obtained from [`ClassLoadingMXBean#getLoadedClassCount()`](https:
270274

271275
## JVM CPU
272276

277+
**Status**: [Stable][DocumentStatus]
278+
273279
**Description:** Java Virtual Machine (JVM) metrics captured under the namespace `jvm.cpu.*`
274280

275281
### Metric: `jvm.cpu.time`
@@ -321,7 +327,9 @@ Note that the JVM does not provide a definition of what "recent" means.
321327
<!-- semconv metric.jvm.cpu.recent_utilization(full) -->
322328
<!-- endsemconv -->
323329

324-
## Very experimental
330+
## Experimental
331+
332+
**Status**: [Experimental][DocumentStatus]
325333

326334
**Description:** Very experimental Java Virtual Machine (JVM) metrics captured under `jvm.`
327335

model/metrics/jvm-metrics.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ groups:
55
prefix: jvm.memory
66
attributes:
77
- id: type
8+
stability: stable
89
type:
910
allow_custom_values: false
1011
members:
@@ -18,6 +19,7 @@ groups:
1819
brief: The type of memory.
1920
examples: ["heap", "non_heap"]
2021
- id: pool.name
22+
stability: stable
2123
type: string
2224
requirement_level: recommended
2325
brief: Name of the memory pool.
@@ -67,6 +69,7 @@ groups:
6769
prefix: jvm.gc
6870
attributes:
6971
- id: name
72+
stability: stable
7073
type: string
7174
requirement_level: recommended
7275
brief: Name of the garbage collector.
@@ -75,6 +78,7 @@ groups:
7578
Garbage collector name is generally obtained via
7679
[GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()).
7780
- id: action
81+
stability: stable
7882
type: string
7983
requirement_level: recommended
8084
brief: Name of the garbage collector action.
@@ -91,10 +95,12 @@ groups:
9195
unit: "{thread}"
9296
attributes:
9397
- id: jvm.thread.daemon
98+
stability: stable
9499
type: boolean
95100
requirement_level: recommended
96101
brief: "Whether the thread is daemon or not."
97102
- id: jvm.thread.state
103+
stability: stable
98104
requirement_level: recommended
99105
type:
100106
allow_custom_values: false

0 commit comments

Comments
 (0)