rename class to avoid confusion

Author: zeitlinger

instrumentation/runtime-telemetry/runtime-telemetry-java17/javaagent/src/main/java/io/opentelemetry/instrumentation/javaagent/runtimemetrics/java17/Java17RuntimeMetricsInstaller.java

@@ -7,7 +7,7 @@
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics;
+import io.opentelemetry.instrumentation.runtimemetrics.java17.Java17RuntimeMetrics;
 import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
 import io.opentelemetry.javaagent.extension.AgentListener;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
@@ -18,7 +18,7 @@ public class Java17RuntimeMetricsInstaller implements AgentListener {
 
   @Override
   public void afterAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredSdk) {
-    RuntimeMetrics.builder(GlobalOpenTelemetry.get())
+    Java17RuntimeMetrics.builder(GlobalOpenTelemetry.get())
         .startFromInstrumentationConfig(AgentInstrumentationConfig.get());
   }
 }

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

@@ -21,17 +21,17 @@
 import jdk.jfr.consumer.RecordingStream;
 
 /** The entry point class for runtime metrics support using JFR and JMX. */
-public final class RuntimeMetrics implements Closeable {
+public final class Java17RuntimeMetrics implements Closeable {
 
-  private static final Logger logger = Logger.getLogger(RuntimeMetrics.class.getName());
+  private static final Logger logger = Logger.getLogger(Java17RuntimeMetrics.class.getName());
 
   private final AtomicBoolean isClosed = new AtomicBoolean();
   private final OpenTelemetry openTelemetry;
   private final List<AutoCloseable> observables;
 
   @Nullable private final JfrRuntimeMetrics jfrRuntimeMetrics;
 
-  RuntimeMetrics(
+  Java17RuntimeMetrics(
       OpenTelemetry openTelemetry,
       List<AutoCloseable> observables,
       @Nullable JfrRuntimeMetrics jfrRuntimeMetrics) {
@@ -41,24 +41,24 @@ public final class RuntimeMetrics implements Closeable {
   }
 
   /**
-   * Create and start {@link RuntimeMetrics}, configured with the default {@link JfrFeature}s.
+   * Create and start {@link Java17RuntimeMetrics}, configured with the default {@link JfrFeature}s.
    *
    * <p>Listens for select JFR events, extracts data, and records to various metrics. Recording will
    * continue until {@link #close()} is called.
    *
    * @param openTelemetry the {@link OpenTelemetry} instance used to record telemetry
    */
-  public static RuntimeMetrics create(OpenTelemetry openTelemetry) {
-    return new RuntimeMetricsBuilder(openTelemetry).build();
+  public static Java17RuntimeMetrics create(OpenTelemetry openTelemetry) {
+    return new Java17RuntimeMetricsBuilder(openTelemetry).build();
   }
 
   /**
-   * Create a builder for configuring {@link RuntimeMetrics}.
+   * Create a builder for configuring {@link Java17RuntimeMetrics}.
    *
    * @param openTelemetry the {@link OpenTelemetry} instance used to record telemetry
    */
-  public static RuntimeMetricsBuilder builder(OpenTelemetry openTelemetry) {
-    return new RuntimeMetricsBuilder(openTelemetry);
+  public static Java17RuntimeMetricsBuilder builder(OpenTelemetry openTelemetry) {
+    return new Java17RuntimeMetricsBuilder(openTelemetry);
   }
 
   // Visible for testing

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

@@ -15,8 +15,8 @@
 import java.util.function.Consumer;
 import javax.annotation.Nullable;
 
-/** Builder for {@link RuntimeMetrics}. */
-public final class RuntimeMetricsBuilder {
+/** Builder for {@link Java17RuntimeMetrics}. */
+public final class Java17RuntimeMetricsBuilder {
 
   private final OpenTelemetry openTelemetry;
   // Visible for testing
@@ -30,7 +30,7 @@ public final class RuntimeMetricsBuilder {
             .addShutdownHook(new Thread(runnable, "OpenTelemetry RuntimeMetricsShutdownHook"));
       };
 
-  RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
+  Java17RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
     this.openTelemetry = openTelemetry;
     enabledFeatureMap = new EnumMap<>(JfrFeature.class);
     for (JfrFeature feature : JfrFeature.values()) {
@@ -40,57 +40,57 @@ public final class RuntimeMetricsBuilder {
 
   /** Enable telemetry collection for all {@link JfrFeature}s. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder enableAllFeatures() {
+  public Java17RuntimeMetricsBuilder enableAllFeatures() {
     Arrays.stream(JfrFeature.values()).forEach(this::enableFeature);
     return this;
   }
 
   /** Enable telemetry collection associated with the {@link JfrFeature}. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder enableFeature(JfrFeature feature) {
+  public Java17RuntimeMetricsBuilder enableFeature(JfrFeature feature) {
     enabledFeatureMap.put(feature, true);
     return this;
   }
 
   /** Disable telemetry collection for all {@link JfrFeature}s. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder disableAllFeatures() {
+  public Java17RuntimeMetricsBuilder disableAllFeatures() {
     Arrays.stream(JfrFeature.values()).forEach(this::disableFeature);
     return this;
   }
 
   /** Disable telemetry collection for all metrics. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder disableAllMetrics() {
+  public Java17RuntimeMetricsBuilder disableAllMetrics() {
     disableAllFeatures();
     disableAllJmx();
     return this;
   }
 
   /** Disable telemetry collection associated with the {@link JfrFeature}. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder disableFeature(JfrFeature feature) {
+  public Java17RuntimeMetricsBuilder disableFeature(JfrFeature feature) {
     enabledFeatureMap.put(feature, false);
     return this;
   }
 
   /** Disable all JMX telemetry collection. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder disableAllJmx() {
+  public Java17RuntimeMetricsBuilder disableAllJmx() {
     disableJmx = true;
     return this;
   }
 
   /** Enable experimental JMX telemetry collection. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
+  public Java17RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
     enableExperimentalJmxTelemetry = true;
     return this;
   }
 
-  /** Set a custom shutdown hook for the {@link RuntimeMetrics}. */
+  /** Set a custom shutdown hook for the {@link Java17RuntimeMetrics}. */
   @CanIgnoreReturnValue
-  public RuntimeMetricsBuilder setShutdownHook(Consumer<Runnable> shutdownHook) {
+  public Java17RuntimeMetricsBuilder setShutdownHook(Consumer<Runnable> shutdownHook) {
     this.shutdownHook = shutdownHook;
     return this;
   }
@@ -119,26 +119,26 @@ public void startFromInstrumentationConfig(InstrumentationConfig config) {
       this.enableExperimentalJmxTelemetry();
     }
 
-    RuntimeMetrics runtimeMetrics = this.build();
+    Java17RuntimeMetrics runtimeMetrics = this.build();
     shutdownHook.accept(runtimeMetrics::close);
   }
 
-  /** Build and start an {@link RuntimeMetrics} with the config from this builder. */
-  public RuntimeMetrics build() {
+  /** Build and start an {@link Java17RuntimeMetrics} with the config from this builder. */
+  public Java17RuntimeMetrics build() {
     List<AutoCloseable> observables =
         disableJmx
             ? List.of()
             : JmxRuntimeMetricsFactory.buildObservables(
                 openTelemetry, enableExperimentalJmxTelemetry);
-    RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics = buildJfrMetrics();
-    return new RuntimeMetrics(openTelemetry, observables, jfrRuntimeMetrics);
+    Java17RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics = buildJfrMetrics();
+    return new Java17RuntimeMetrics(openTelemetry, observables, jfrRuntimeMetrics);
   }
 
   @Nullable
-  private RuntimeMetrics.JfrRuntimeMetrics buildJfrMetrics() {
+  private Java17RuntimeMetrics.JfrRuntimeMetrics buildJfrMetrics() {
     if (enabledFeatureMap.values().stream().noneMatch(isEnabled -> isEnabled)) {
       return null;
     }
-    return RuntimeMetrics.JfrRuntimeMetrics.build(openTelemetry, enabledFeatureMap::get);
+    return Java17RuntimeMetrics.JfrRuntimeMetrics.build(openTelemetry, enabledFeatureMap::get);
   }
 }

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

@@ -6,7 +6,8 @@
 package io.opentelemetry.instrumentation.runtimemetrics.java17;
 
 /**
- * Enumeration of JFR features, which can be toggled on or off via {@link RuntimeMetricsBuilder}.
+ * Enumeration of JFR features, which can be toggled on or off via {@link
+ * Java17RuntimeMetricsBuilder}.
  *
  * <p>Features are disabled by default if they are already available through {@code
  * io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8} JMX based

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

@@ -38,7 +38,7 @@ private GenerateDocs() {}
 
   public static void main(String[] args) throws Exception {
     // Suppress info level logs
-    Logger.getLogger(RuntimeMetrics.class.getName()).setLevel(Level.WARNING);
+    Logger.getLogger(Java17RuntimeMetrics.class.getName()).setLevel(Level.WARNING);
 
     String jfrReadmePath = System.getProperty(JFR_README_PATH_KEY);
     if (jfrReadmePath == null) {
@@ -64,7 +64,7 @@ private static String generateMarkdownTable() throws InterruptedException {
       map.put(
           feature,
           new JfrTelemetryWithFeature(
-              RuntimeMetrics.builder(sdk).disableAllFeatures().enableFeature(feature).build(),
+              Java17RuntimeMetrics.builder(sdk).disableAllFeatures().enableFeature(feature).build(),
               sdk,
               reader));
     }
@@ -107,12 +107,12 @@ private static String generateMarkdownTable() throws InterruptedException {
   }
 
   private static class JfrTelemetryWithFeature {
-    private final RuntimeMetrics jfrTelemetry;
+    private final Java17RuntimeMetrics jfrTelemetry;
     private final OpenTelemetrySdk sdk;
     private final InMemoryMetricReader reader;
 
     private JfrTelemetryWithFeature(
-        RuntimeMetrics jfrTelemetry, OpenTelemetrySdk sdk, InMemoryMetricReader reader) {
+        Java17RuntimeMetrics jfrTelemetry, OpenTelemetrySdk sdk, InMemoryMetricReader reader) {
       this.jfrTelemetry = jfrTelemetry;
       this.sdk = sdk;
       this.reader = reader;

instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/RuntimeMetricsBuilderTest.java instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/Java17RuntimeMetricsBuilderTest.java

@@ -15,7 +15,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-class RuntimeMetricsBuilderTest {
+class Java17RuntimeMetricsBuilderTest {
 
   @BeforeAll
   static void setup() {
@@ -33,27 +33,31 @@ void defaultFeatures() {
     Arrays.stream(JfrFeature.values())
         .forEach(jfrFeature -> defaultFeatures.put(jfrFeature, jfrFeature.isDefaultEnabled()));
 
-    assertThat(new RuntimeMetricsBuilder(OpenTelemetry.noop()).enabledFeatureMap)
+    assertThat(new Java17RuntimeMetricsBuilder(OpenTelemetry.noop()).enabledFeatureMap)
         .isEqualTo(defaultFeatures);
   }
 
   @Test
   void enableAllFeatures() {
     assertThat(
-            new RuntimeMetricsBuilder(OpenTelemetry.noop()).enableAllFeatures().enabledFeatureMap)
+            new Java17RuntimeMetricsBuilder(OpenTelemetry.noop())
+                .enableAllFeatures()
+                .enabledFeatureMap)
         .allSatisfy((unused, enabled) -> assertThat(enabled).isTrue());
   }
 
   @Test
   void disableAllFeatures() {
     assertThat(
-            new RuntimeMetricsBuilder(OpenTelemetry.noop()).disableAllFeatures().enabledFeatureMap)
+            new Java17RuntimeMetricsBuilder(OpenTelemetry.noop())
+                .disableAllFeatures()
+                .enabledFeatureMap)
         .allSatisfy((unused, enabled) -> assertThat(enabled).isFalse());
   }
 
   @Test
   void enableDisableFeature() {
-    var builder = new RuntimeMetricsBuilder(OpenTelemetry.noop());
+    var builder = new Java17RuntimeMetricsBuilder(OpenTelemetry.noop());
 
     assertThat(builder.enabledFeatureMap.get(JfrFeature.BUFFER_METRICS)).isFalse();
 
@@ -66,7 +70,7 @@ void enableDisableFeature() {
   @Test
   void build() {
     var openTelemetry = OpenTelemetry.noop();
-    try (var jfrTelemetry = new RuntimeMetricsBuilder(openTelemetry).build()) {
+    try (var jfrTelemetry = new Java17RuntimeMetricsBuilder(openTelemetry).build()) {
       assertThat(jfrTelemetry.getOpenTelemetry()).isSameAs(openTelemetry);
       assertThat(jfrTelemetry.getJfrRuntimeMetrics().getRecordedEventHandlers())
           .hasSizeGreaterThan(0)

instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/RuntimeMetricsTest.java instrumentation/runtime-telemetry/runtime-telemetry-java17/library/src/test/java/io/opentelemetry/instrumentation/runtimemetrics/java17/Java17RuntimeMetricsTest.java

@@ -19,9 +19,10 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
-class RuntimeMetricsTest {
+class Java17RuntimeMetricsTest {
 
-  @RegisterExtension LogCapturer logs = LogCapturer.create().captureForType(RuntimeMetrics.class);
+  @RegisterExtension
+  LogCapturer logs = LogCapturer.create().captureForType(Java17RuntimeMetrics.class);
 
   private InMemoryMetricReader reader;
   private OpenTelemetrySdk sdk;
@@ -51,7 +52,7 @@ void tearDown() {
 
   @Test
   void create_Default() {
-    try (RuntimeMetrics unused = RuntimeMetrics.create(sdk)) {
+    try (Java17RuntimeMetrics unused = Java17RuntimeMetrics.create(sdk)) {
       assertThat(reader.collectAllMetrics())
           .isNotEmpty()
           .allSatisfy(
@@ -64,14 +65,15 @@ void create_Default() {
 
   @Test
   void create_AllDisabled() {
-    try (RuntimeMetrics unused = RuntimeMetrics.builder(sdk).disableAllMetrics().build()) {
+    try (Java17RuntimeMetrics unused =
+        Java17RuntimeMetrics.builder(sdk).disableAllMetrics().build()) {
       assertThat(reader.collectAllMetrics()).isEmpty();
     }
   }
 
   @Test
   void builder() {
-    try (var jfrTelemetry = RuntimeMetrics.builder(sdk).build()) {
+    try (var jfrTelemetry = Java17RuntimeMetrics.builder(sdk).build()) {
       assertThat(jfrTelemetry.getOpenTelemetry()).isSameAs(sdk);
       assertThat(jfrTelemetry.getJfrRuntimeMetrics().getRecordedEventHandlers())
           .hasSizeGreaterThan(0)
@@ -81,7 +83,7 @@ void builder() {
 
   @Test
   void close() throws InterruptedException {
-    try (RuntimeMetrics jfrTelemetry = RuntimeMetrics.builder(sdk).build()) {
+    try (Java17RuntimeMetrics jfrTelemetry = Java17RuntimeMetrics.builder(sdk).build()) {
       // Track whether RecordingStream has been closed
       AtomicBoolean recordingStreamClosed = new AtomicBoolean(false);
       jfrTelemetry

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

@@ -24,13 +24,13 @@
 
 public class JfrExtension implements BeforeEachCallback, AfterEachCallback {
 
-  private final Consumer<RuntimeMetricsBuilder> builderConsumer;
+  private final Consumer<Java17RuntimeMetricsBuilder> builderConsumer;
 
   private SdkMeterProvider meterProvider;
   private InMemoryMetricReader metricReader;
-  private RuntimeMetrics runtimeMetrics;
+  private Java17RuntimeMetrics runtimeMetrics;
 
-  public JfrExtension(Consumer<RuntimeMetricsBuilder> builderConsumer) {
+  public JfrExtension(Consumer<Java17RuntimeMetricsBuilder> builderConsumer) {
     this.builderConsumer = builderConsumer;
   }
 
@@ -46,10 +46,11 @@ public void beforeEach(ExtensionContext context) throws InterruptedException {
     metricReader = InMemoryMetricReader.create();
     meterProvider = SdkMeterProvider.builder().registerMetricReader(metricReader).build();
     OpenTelemetrySdk sdk = OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build();
-    RuntimeMetricsBuilder builder = RuntimeMetrics.builder(sdk);
+    Java17RuntimeMetricsBuilder builder = Java17RuntimeMetrics.builder(sdk);
     builderConsumer.accept(builder);
     runtimeMetrics = builder.build();
-    RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics = runtimeMetrics.getJfrRuntimeMetrics();
+    Java17RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics =
+        runtimeMetrics.getJfrRuntimeMetrics();
     if (jfrRuntimeMetrics != null) {
       jfrRuntimeMetrics.getStartUpLatch().await(30, TimeUnit.SECONDS);
     }

instrumentation/runtime-telemetry/runtime-telemetry-java8/javaagent/src/main/java/io/opentelemetry/instrumentation/javaagent/runtimemetrics/java8/Java8RuntimeMetricsInstaller.java

@@ -7,7 +7,7 @@
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.api.GlobalOpenTelemetry;
-import io.opentelemetry.instrumentation.runtimemetrics.java8.RuntimeMetrics;
+import io.opentelemetry.instrumentation.runtimemetrics.java8.Java8RuntimeMetrics;
 import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
 import io.opentelemetry.javaagent.extension.AgentListener;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
@@ -18,7 +18,7 @@ public class Java8RuntimeMetricsInstaller implements AgentListener {
 
   @Override
   public void afterAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredSdk) {
-    RuntimeMetrics.builder(GlobalOpenTelemetry.get())
+    Java8RuntimeMetrics.builder(GlobalOpenTelemetry.get())
         .startFromInstrumentationConfig(AgentInstrumentationConfig.get());
   }
 }