Mark nonstable JMX targets experimental (#18971)

Author: trask

instrumentation/jmx-metrics/README.md

@@ -18,7 +18,7 @@ To enable collection of the predefined metrics, specify a list of targets as the
 
 ```bash
 $ java -javaagent:path/to/opentelemetry-javaagent.jar \
-     -Dotel.jmx.target.system=jetty,kafka-broker \
+     -Dotel.jmx.target.system=jetty,experimental-kafka-broker \
      ... \
      -jar myapp.jar
 ```
@@ -28,8 +28,8 @@ No targets are enabled by default. The supported target environments are listed
 - [activemq](library/activemq.md)
 - [camel](library/camel.md)
 - [jetty](library/jetty.md)
-- [kafka-broker](javaagent/kafka-broker.md)
-- [kafka-connect](library/kafka-connect.md)
+- [experimental-kafka-broker](javaagent/kafka-broker.md)
+- [experimental-kafka-connect](library/kafka-connect.md)
 - [tomcat](library/tomcat.md)
 - [wildfly](library/wildfly.md)
 - [hadoop](library/hadoop.md)

instrumentation/jmx-metrics/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jmx/JmxMetricInsightInstaller.java

@@ -7,13 +7,15 @@
 
 import static java.util.Collections.emptyList;
 import static java.util.logging.Level.SEVERE;
+import static java.util.logging.Level.WARNING;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
 import io.opentelemetry.instrumentation.jmx.JmxTelemetry;
 import io.opentelemetry.instrumentation.jmx.JmxTelemetryBuilder;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
 import io.opentelemetry.javaagent.extension.AgentListener;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import java.io.IOException;
@@ -65,7 +67,7 @@ private static void addFileRules(Path path, JmxTelemetryBuilder builder) {
 
   private static void addClasspathRules(String target, JmxTelemetryBuilder builder) {
     ClassLoader classLoader = JmxTelemetryBuilder.class.getClassLoader();
-    String resource = String.format("jmx/rules/%s.yaml", target);
+    String resource = targetSystemResource(target, AgentCommonConfig.get().isV3Preview());
     try (InputStream input = classLoader.getResourceAsStream(resource)) {
       if (input == null) {
         logger.log(SEVERE, "JMX configuration not found on classpath " + resource);
@@ -77,4 +79,20 @@ private static void addClasspathRules(String target, JmxTelemetryBuilder builder
       logger.log(SEVERE, "Error while loading JMX configuration from classpath " + resource, e);
     }
   }
+
+  private static String targetSystemResource(String target, boolean v3Preview) {
+    if (target.equals("kafka-broker") && !v3Preview) {
+      logger.log(
+          WARNING,
+          "The kafka-broker JMX target system has been renamed to experimental-kafka-broker.");
+      return "jmx/rules/experimental-kafka-broker.yaml";
+    }
+    if (target.equals("kafka-connect") && !v3Preview) {
+      logger.log(
+          WARNING,
+          "The kafka-connect JMX target system has been renamed to experimental-kafka-connect.");
+      return "jmx/rules/experimental-kafka-connect.yaml";
+    }
+    return String.format("jmx/rules/%s.yaml", target);
+  }
 }

…in/resources/jmx/rules/kafka-broker.yaml …jmx/rules/experimental-kafka-broker.yamlinstrumentation/jmx-metrics/javaagent/src/main/resources/jmx/rules/kafka-broker.yaml renamed to instrumentation/jmx-metrics/javaagent/src/main/resources/jmx/rules/experimental-kafka-broker.yaml instrumentation/jmx-metrics/javaagent/src/main/resources/jmx/rules/kafka-broker.yaml renamed to instrumentation/jmx-metrics/javaagent/src/main/resources/jmx/rules/experimental-kafka-broker.yaml

@@ -24,7 +24,7 @@
  */
 class JmxMetricInsightInstallerTest {
   private static final String PATH_TO_ALL_EXISTING_RULES = "src/main/resources/jmx/rules";
-  private static final Set<String> FILES_TO_BE_TESTED = singleton("kafka-broker.yaml");
+  private static final Set<String> FILES_TO_BE_TESTED = singleton("experimental-kafka-broker.yaml");
 
   @Test
   void testToVerifyExistingRulesAreValid() {

instrumentation/jmx-metrics/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jmx/JmxMetricInsightInstallerTest.java

@@ -132,7 +132,7 @@ void statusStateMappingsPresent() throws Exception {
 
   @Test
   void metricsAreReportedFromKafkaConnectContainer() throws Exception {
-    List<String> yamlFiles = singletonList("kafka-connect.yaml");
+    List<String> yamlFiles = singletonList("experimental-kafka-connect.yaml");
 
     yamlFiles.forEach(this::validateYamlSyntax);
 
@@ -197,7 +197,9 @@ void metricsAreReportedFromKafkaConnectContainer() throws Exception {
 
   private JmxConfig loadKafkaConnectConfig() throws Exception {
     try (InputStream input =
-        getClass().getClassLoader().getResourceAsStream("jmx/rules/kafka-connect.yaml")) {
+        getClass()
+            .getClassLoader()
+            .getResourceAsStream("jmx/rules/experimental-kafka-connect.yaml")) {
       assertThat(input).isNotNull();
       return RuleParser.get().loadConfig(input);
     }