Skip to content

Commit 60a9a45

Browse files
authored
Polish variable naming from enableExperimentalJmxTelemetry to emitExperimentalTelemetry (#13791)
1 parent 95014b2 commit 60a9a45

File tree

5 files changed

+34
-10
lines changed

5 files changed

+34
-10
lines changed

instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java17/RuntimeMetricsBuilder.java

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public final class RuntimeMetricsBuilder {
2121
final EnumMap<JfrFeature, Boolean> enabledFeatureMap;
2222

2323
private boolean disableJmx = false;
24-
private boolean enableExperimentalJmxTelemetry = false;
24+
private boolean emitExperimentalTelemetry = false;
2525
private boolean captureGcCause = false;
2626

2727
RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
@@ -77,8 +77,20 @@ public RuntimeMetricsBuilder disableAllJmx() {
7777

7878
/** Enable experimental JMX telemetry collection. */
7979
@CanIgnoreReturnValue
80+
public RuntimeMetricsBuilder emitExperimentalTelemetry() {
81+
emitExperimentalTelemetry = true;
82+
return this;
83+
}
84+
85+
/**
86+
* Enable experimental JMX telemetry collection.
87+
*
88+
* @deprecated Use {@link #emitExperimentalTelemetry()} instead.
89+
*/
90+
@Deprecated
91+
@CanIgnoreReturnValue
8092
public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
81-
enableExperimentalJmxTelemetry = true;
93+
emitExperimentalTelemetry = true;
8294
return this;
8395
}
8496

@@ -95,7 +107,7 @@ public RuntimeMetrics build() {
95107
disableJmx
96108
? List.of()
97109
: JmxRuntimeMetricsFactory.buildObservables(
98-
openTelemetry, enableExperimentalJmxTelemetry, captureGcCause);
110+
openTelemetry, emitExperimentalTelemetry, captureGcCause);
99111
RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics = buildJfrMetrics();
100112
return new RuntimeMetrics(openTelemetry, observables, jfrRuntimeMetrics);
101113
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public static RuntimeMetrics configure(
4040

4141
if (config.getBoolean(
4242
"otel.instrumentation.runtime-telemetry.emit-experimental-telemetry", false)) {
43-
builder.enableExperimentalJmxTelemetry();
43+
builder.emitExperimentalTelemetry();
4444
}
4545

4646
if (config.getBoolean("otel.instrumentation.runtime-telemetry.capture-gc-cause", false)) {

instrumentation/runtime-telemetry/runtime-telemetry-java8/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java8/RuntimeMetricsBuilder.java

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public final class RuntimeMetricsBuilder {
1515

1616
private final OpenTelemetry openTelemetry;
1717

18-
private boolean enableExperimentalJmxTelemetry = false;
18+
private boolean emitExperimentalTelemetry = false;
1919
private boolean captureGcCause = false;
2020

2121
RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
@@ -24,8 +24,20 @@ public final class RuntimeMetricsBuilder {
2424

2525
/** Enable all JMX telemetry collection. */
2626
@CanIgnoreReturnValue
27+
public RuntimeMetricsBuilder emitExperimentalTelemetry() {
28+
emitExperimentalTelemetry = true;
29+
return this;
30+
}
31+
32+
/**
33+
* Enable experimental JMX telemetry collection.
34+
*
35+
* @deprecated Use {@link #emitExperimentalTelemetry()} instead.
36+
*/
37+
@Deprecated
38+
@CanIgnoreReturnValue
2739
public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
28-
enableExperimentalJmxTelemetry = true;
40+
emitExperimentalTelemetry = true;
2941
return this;
3042
}
3143

@@ -40,7 +52,7 @@ public RuntimeMetricsBuilder captureGcCause() {
4052
public RuntimeMetrics build() {
4153
List<AutoCloseable> observables =
4254
JmxRuntimeMetricsFactory.buildObservables(
43-
openTelemetry, enableExperimentalJmxTelemetry, captureGcCause);
55+
openTelemetry, emitExperimentalTelemetry, captureGcCause);
4456
return new RuntimeMetrics(observables);
4557
}
4658
}

instrumentation/runtime-telemetry/runtime-telemetry-java8/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java8/internal/JmxRuntimeMetricsFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
public class JmxRuntimeMetricsFactory {
2222
@SuppressWarnings("CatchingUnchecked")
2323
public static List<AutoCloseable> buildObservables(
24-
OpenTelemetry openTelemetry, boolean enableExperimentalJmxTelemetry, boolean captureGcCause) {
24+
OpenTelemetry openTelemetry, boolean emitExperimentalTelemetry, boolean captureGcCause) {
2525
// Set up metrics gathered by JMX
2626
List<AutoCloseable> observables = new ArrayList<>();
2727
observables.addAll(Classes.registerObservers(openTelemetry));
2828
observables.addAll(Cpu.registerObservers(openTelemetry));
2929
observables.addAll(GarbageCollector.registerObservers(openTelemetry, captureGcCause));
3030
observables.addAll(MemoryPools.registerObservers(openTelemetry));
3131
observables.addAll(Threads.registerObservers(openTelemetry));
32-
if (enableExperimentalJmxTelemetry) {
32+
if (emitExperimentalTelemetry) {
3333
observables.addAll(ExperimentalBufferPools.registerObservers(openTelemetry));
3434
observables.addAll(ExperimentalCpu.registerObservers(openTelemetry));
3535
observables.addAll(ExperimentalMemoryPools.registerObservers(openTelemetry));

instrumentation/runtime-telemetry/runtime-telemetry-java8/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/java8/internal/RuntimeMetricsConfigUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public static RuntimeMetrics configure(
2828

2929
if (config.getBoolean(
3030
"otel.instrumentation.runtime-telemetry.emit-experimental-telemetry", false)) {
31-
builder.enableExperimentalJmxTelemetry();
31+
builder.emitExperimentalTelemetry();
3232
}
3333

3434
if (config.getBoolean("otel.instrumentation.runtime-telemetry.capture-gc-cause", false)) {

0 commit comments

Comments
 (0)