Skip to content

Commit 6492f77

Browse files
robsundayrobsunday
committed
Metric names updated for Java17 to match with the most recent semantic convention
1 parent da20d8b commit 6492f77

File tree

15 files changed

+44
-37
lines changed

15 files changed

+44
-37
lines changed

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/internal/Constants.java

+6-7
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,21 @@ private Constants() {}
3939
public static final String METRIC_DESCRIPTION_NETWORK_BYTES = "Network read/write bytes";
4040
public static final String METRIC_NAME_NETWORK_DURATION = "process.runtime.jvm.network.time";
4141
public static final String METRIC_DESCRIPTION_NETWORK_DURATION = "Network read/write duration";
42-
public static final String METRIC_NAME_COMMITTED = "process.runtime.jvm.memory.committed";
42+
public static final String METRIC_NAME_COMMITTED = "jvm.memory.committed";
4343
public static final String METRIC_DESCRIPTION_COMMITTED = "Measure of memory committed";
44-
public static final String METRIC_NAME_MEMORY = "process.runtime.jvm.memory.usage";
44+
public static final String METRIC_NAME_MEMORY = "jvm.memory.used";
4545
public static final String METRIC_DESCRIPTION_MEMORY = "Measure of memory used";
46-
public static final String METRIC_NAME_MEMORY_AFTER =
47-
"process.runtime.jvm.memory.usage_after_last_gc";
46+
public static final String METRIC_NAME_MEMORY_AFTER = "jvm.memory.used_after_last_gc";
4847
public static final String METRIC_DESCRIPTION_MEMORY_AFTER =
4948
"Measure of memory used, as measured after the most recent garbage collection event on this pool";
5049
public static final String METRIC_NAME_MEMORY_ALLOCATION =
5150
"process.runtime.jvm.memory.allocation";
5251
public static final String METRIC_DESCRIPTION_MEMORY_ALLOCATION = "Allocation";
53-
public static final String METRIC_NAME_MEMORY_INIT = "process.runtime.jvm.memory.init";
52+
public static final String METRIC_NAME_MEMORY_INIT = "jvm.memory.init";
5453
public static final String METRIC_DESCRIPTION_MEMORY_INIT = "Measure of initial memory requested";
55-
public static final String METRIC_NAME_MEMORY_LIMIT = "process.runtime.jvm.memory.limit";
54+
public static final String METRIC_NAME_MEMORY_LIMIT = "jvm.memory.limit";
5655
public static final String METRIC_DESCRIPTION_MEMORY_LIMIT = "Measure of max obtainable memory";
57-
public static final String METRIC_NAME_GC_DURATION = "process.runtime.jvm.gc.duration";
56+
public static final String METRIC_NAME_GC_DURATION = "jvm.gc.duration";
5857
public static final String METRIC_DESCRIPTION_GC_DURATION =
5958
"Duration of JVM garbage collection actions";
6059

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/internal/buffer/DirectBufferStatisticsHandler.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
* any time.
2222
*/
2323
public final class DirectBufferStatisticsHandler implements RecordedEventHandler {
24-
private static final String METRIC_NAME_USAGE = "process.runtime.jvm.buffer.usage";
25-
private static final String METRIC_NAME_LIMIT = "process.runtime.jvm.buffer.limit";
26-
private static final String METRIC_NAME_COUNT = "process.runtime.jvm.buffer.count";
24+
private static final String METRIC_NAME_USAGE = "jvm.buffer.memory.usage";
25+
private static final String METRIC_NAME_LIMIT = "jvm.buffer.memory.limit";
26+
private static final String METRIC_NAME_COUNT = "jvm.buffer.count";
2727
private static final String METRIC_DESCRIPTION_USAGE = "Measure of memory used by buffers";
2828
private static final String METRIC_DESCRIPTION_LIMIT =
2929
"Measure of total memory capacity of buffers";

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/internal/classes/ClassesLoadedHandler.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@
2121
*/
2222
public final class ClassesLoadedHandler implements RecordedEventHandler {
2323
/**
24-
* process.runtime.jvm.classes.loaded is the total number of classes loaded since JVM start. See:
24+
* jvm.class.loaded is the total number of classes loaded since JVM start. See:
2525
* https://github.com/open-telemetry/semantic-conventions/blob/main/docs/runtime/jvm-metrics.md
2626
*/
27-
private static final String METRIC_NAME_LOADED = "process.runtime.jvm.classes.loaded";
27+
private static final String METRIC_NAME_LOADED = "jvm.class.loaded";
2828

29-
private static final String METRIC_NAME_UNLOADED = "process.runtime.jvm.classes.unloaded";
29+
private static final String METRIC_NAME_UNLOADED = "jvm.class.unloaded";
3030

3131
/**
32-
* process.runtime.jvm.classes.current_loaded is the number of classes loaded at the time of
32+
* jvm.class.count is the number of classes loaded at the time of
3333
* jdk.ClassLoadingStatistics event emission.
3434
*/
35-
private static final String METRIC_NAME_CURRENT = "process.runtime.jvm.classes.current_loaded";
35+
private static final String METRIC_NAME_CURRENT = "jvm.class.count";
3636

3737
private static final String EVENT_NAME = "jdk.ClassLoadingStatistics";
3838
private static final String METRIC_DESCRIPTION_CURRENT = "Number of classes currently loaded";

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/internal/cpu/OverallCpuLoadHandler.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
* any time.
2121
*/
2222
public final class OverallCpuLoadHandler implements RecordedEventHandler {
23-
private static final String METRIC_NAME_PROCESS = "process.runtime.jvm.cpu.utilization";
24-
private static final String METRIC_NAME_MACHINE = "process.runtime.jvm.system.cpu.utilization";
23+
private static final String METRIC_NAME_PROCESS = "jvm.cpu.recent_utilization";
24+
private static final String METRIC_NAME_MACHINE = "jvm.system.cpu.utilization";
2525
private static final String METRIC_DESCRIPTION_PROCESS = "Recent CPU utilization for the process";
2626
private static final String METRIC_DESCRIPTION_MACHINE =
2727
"Recent CPU utilization for the whole system";

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/internal/threads/ThreadCountHandler.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* any time.
2222
*/
2323
public final class ThreadCountHandler implements RecordedEventHandler {
24-
private static final String METRIC_NAME = "process.runtime.jvm.threads.count";
24+
private static final String METRIC_NAME = "jvm.thread.count";
2525
private static final String EVENT_NAME = "jdk.JavaThreadStatistics";
2626
private static final String METRIC_DESCRIPTION = "Number of executing threads";
2727
private static final Attributes ATTR_DAEMON_TRUE = Attributes.of(Constants.ATTR_DAEMON, true);

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/BufferMetricTest.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ void shouldHaveJfrLoadedClassesCountEvents() {
4343
jfrExtension.waitAndAssertMetrics(
4444
metric ->
4545
metric
46-
.hasName("process.runtime.jvm.buffer.count")
46+
.hasName("jvm.buffer.count")
4747
.hasDescription("Number of buffers in the pool")
4848
.hasUnit(UNIT_BUFFERS)
4949
.hasLongSumSatisfying(
@@ -57,7 +57,7 @@ void shouldHaveJfrLoadedClassesCountEvents() {
5757
}))),
5858
metric ->
5959
metric
60-
.hasName("process.runtime.jvm.buffer.limit")
60+
.hasName("jvm.buffer.memory.limit")
6161
.hasDescription("Measure of total memory capacity of buffers")
6262
.hasUnit(BYTES)
6363
.hasLongSumSatisfying(
@@ -71,7 +71,7 @@ void shouldHaveJfrLoadedClassesCountEvents() {
7171
}))),
7272
metric ->
7373
metric
74-
.hasName("process.runtime.jvm.buffer.usage")
74+
.hasName("jvm.buffer.memory.usage")
7575
.hasDescription("Measure of memory used by buffers")
7676
.hasUnit(BYTES)
7777
.hasLongSumSatisfying(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/G1GcMemoryMetricTest.java

+5-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_GC_DURATION;
1717
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY;
1818
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY_AFTER;
19+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_COMMITTED;
20+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_GC_DURATION;
1921
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY;
2022
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY_AFTER;
2123
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.MILLISECONDS;
@@ -42,7 +44,7 @@ void shouldHaveMemoryMetrics() {
4244
System.gc();
4345
// Test to make sure there's metric data for both eden and survivor spaces.
4446
// TODO: once G1 old gen usage added to jdk.G1HeapSummary (in JDK 21), test for it here too.
45-
// TODO: needs JFR support for process.runtime.jvm.memory.limit.
47+
// TODO: needs JFR support for jvm.memory.limit.
4648
jfrExtension.waitAndAssertMetrics(
4749
metric ->
4850
metric
@@ -52,7 +54,7 @@ void shouldHaveMemoryMetrics() {
5254
.satisfies(G1GcMemoryMetricTest::hasGcAttributes),
5355
metric ->
5456
metric
55-
.hasName("process.runtime.jvm.memory.committed")
57+
.hasName(METRIC_NAME_COMMITTED)
5658
.hasUnit(BYTES)
5759
.hasDescription(METRIC_DESCRIPTION_COMMITTED)
5860
// TODO: need JFR support for the other G1 pools
@@ -85,7 +87,7 @@ void shouldHaveGcDurationMetrics() {
8587
jfrExtension.waitAndAssertMetrics(
8688
metric ->
8789
metric
88-
.hasName("process.runtime.jvm.gc.duration")
90+
.hasName(METRIC_NAME_GC_DURATION)
8991
.hasUnit(MILLISECONDS)
9092
.hasDescription(METRIC_DESCRIPTION_GC_DURATION)
9193
.satisfies(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/JfrClassesLoadedCountTest.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ void shouldHaveJfrLoadedClassesCountEvents() throws Exception {
2525
jfrExtension.waitAndAssertMetrics(
2626
metric ->
2727
metric
28-
.hasName("process.runtime.jvm.classes.loaded")
28+
.hasName("jvm.class.loaded")
2929
.hasDescription("Number of classes loaded since JVM start")
3030
.hasUnit(UNIT_CLASSES)
3131
.hasLongSumSatisfying(
@@ -38,7 +38,7 @@ void shouldHaveJfrLoadedClassesCountEvents() throws Exception {
3838
.isGreaterThanOrEqualTo(0)))),
3939
metric ->
4040
metric
41-
.hasName("process.runtime.jvm.classes.current_loaded")
41+
.hasName("jvm.class.count")
4242
.hasDescription("Number of classes currently loaded")
4343
.hasUnit(UNIT_CLASSES)
4444
.hasLongSumSatisfying(
@@ -51,7 +51,7 @@ void shouldHaveJfrLoadedClassesCountEvents() throws Exception {
5151
.isGreaterThanOrEqualTo(0)))),
5252
metric ->
5353
metric
54-
.hasName("process.runtime.jvm.classes.unloaded")
54+
.hasName("jvm.class.unloaded")
5555
.hasDescription("Number of classes unloaded since JVM start")
5656
.hasUnit(UNIT_CLASSES)
5757
.hasLongSumSatisfying(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/JfrOverallCpuLoadHandlerTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ void shouldHaveCpuLoadEvents() {
2323
jfrExtension.waitAndAssertMetrics(
2424
metric ->
2525
metric
26-
.hasName("process.runtime.jvm.cpu.utilization")
26+
.hasName("jvm.cpu.recent_utilization")
2727
.hasUnit(UNIT_UTILIZATION)
2828
.hasDescription("Recent CPU utilization for the process")
2929
.hasDoubleGaugeSatisfying(gauge -> {}),
3030
metric ->
3131
metric
32-
.hasName("process.runtime.jvm.system.cpu.utilization")
32+
.hasName("jvm.system.cpu.utilization")
3333
.hasUnit(UNIT_UTILIZATION)
3434
.hasDescription("Recent CPU utilization for the whole system")
3535
.hasDoubleGaugeSatisfying(gauge -> {}));

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/JfrThreadCountTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ void shouldHaveJfrThreadCountEvents() throws Exception {
4747
jfrExtension.waitAndAssertMetrics(
4848
metric ->
4949
metric
50-
.hasName("process.runtime.jvm.threads.count")
50+
.hasName("jvm.thread.count")
5151
.hasUnit(UNIT_THREADS)
5252
.satisfies(
5353
data ->

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/MetaspaceMemoryCommittedMetricTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.ATTR_METASPACE;
1010
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.BYTES;
1111
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_COMMITTED;
12+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_COMMITTED;
1213
import static org.assertj.core.api.Assertions.assertThat;
1314

1415
import org.junit.jupiter.api.Test;
@@ -27,7 +28,7 @@ void shouldHaveMemoryCommittedMetrics() {
2728
jfrExtension.waitAndAssertMetrics(
2829
metric ->
2930
metric
30-
.hasName("process.runtime.jvm.memory.committed")
31+
.hasName(METRIC_NAME_COMMITTED)
3132
.hasUnit(BYTES)
3233
.hasDescription(METRIC_DESCRIPTION_COMMITTED)
3334
.satisfies(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/MetaspaceMemoryLimitMetricTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.ATTR_COMPRESSED_CLASS_SPACE;
99
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.BYTES;
1010
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY_LIMIT;
11+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY_LIMIT;
1112
import static org.assertj.core.api.Assertions.assertThat;
1213

1314
import org.junit.jupiter.api.Test;
@@ -26,7 +27,7 @@ void shouldHaveMemoryLimitMetrics() {
2627
jfrExtension.waitAndAssertMetrics(
2728
metric ->
2829
metric
29-
.hasName("process.runtime.jvm.memory.limit")
30+
.hasName(METRIC_NAME_MEMORY_LIMIT)
3031
.hasUnit(BYTES)
3132
.hasDescription(METRIC_DESCRIPTION_MEMORY_LIMIT)
3233
.satisfies(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/MetaspaceMemoryUsageMetricTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class MetaspaceMemoryUsageMetricTest {
2222
new JfrExtension(
2323
builder -> builder.disableAllFeatures().enableFeature(JfrFeature.MEMORY_POOL_METRICS));
2424

25-
/** This is a basic test for process.runtime.jvm.memory.usage. */
25+
/** This is a basic test for jvm.memory.used. */
2626
@Test
2727
void shouldHaveMemoryUsageMetrics() {
2828
System.gc();

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/PsGcMemoryMetricTest.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@
1818
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY;
1919
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY_AFTER;
2020
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_MEMORY_LIMIT;
21+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_COMMITTED;
22+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_GC_DURATION;
2123
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY;
2224
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY_AFTER;
25+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_MEMORY_LIMIT;
2326
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.MILLISECONDS;
2427
import static org.assertj.core.api.Assertions.assertThat;
2528

@@ -51,13 +54,13 @@ void shouldHaveMemoryMetrics() {
5154
.satisfies(PsGcMemoryMetricTest::hasGcAttributes),
5255
metric ->
5356
metric
54-
.hasName("process.runtime.jvm.memory.committed")
57+
.hasName(METRIC_NAME_COMMITTED)
5558
.hasUnit(BYTES)
5659
.hasDescription(METRIC_DESCRIPTION_COMMITTED)
5760
.satisfies(PsGcMemoryMetricTest::hasGcAttributes),
5861
metric ->
5962
metric
60-
.hasName("process.runtime.jvm.memory.limit")
63+
.hasName(METRIC_NAME_MEMORY_LIMIT)
6164
.hasUnit(BYTES)
6265
.hasDescription(METRIC_DESCRIPTION_MEMORY_LIMIT)
6366
.satisfies(PsGcMemoryMetricTest::hasGcAttributes),
@@ -89,7 +92,7 @@ void shouldHaveGcDurationMetrics() {
8992
jfrExtension.waitAndAssertMetrics(
9093
metric ->
9194
metric
92-
.hasName("process.runtime.jvm.gc.duration")
95+
.hasName(METRIC_NAME_GC_DURATION)
9396
.hasUnit(MILLISECONDS)
9497
.hasDescription(METRIC_DESCRIPTION_GC_DURATION)
9598
.satisfies(

‎instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/SerialGcMemoryMetricTest.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.END_OF_MAJOR_GC;
1111
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.END_OF_MINOR_GC;
1212
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_DESCRIPTION_GC_DURATION;
13+
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.METRIC_NAME_GC_DURATION;
1314
import static io.opentelemetry.instrumentation.runtimemetrics.java17.internal.Constants.MILLISECONDS;
1415
import static org.assertj.core.api.Assertions.assertThat;
1516

@@ -40,7 +41,7 @@ void shouldHaveGcDurationMetrics() {
4041
jfrExtension.waitAndAssertMetrics(
4142
metric ->
4243
metric
43-
.hasName("process.runtime.jvm.gc.duration")
44+
.hasName(METRIC_NAME_GC_DURATION)
4445
.hasUnit(MILLISECONDS)
4546
.hasDescription(METRIC_DESCRIPTION_GC_DURATION)
4647
.satisfies(

0 commit comments

Comments
 (0)