spring boot runtime metrics for java 17+

Author: zeitlinger

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

@@ -9,45 +9,19 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics;
-import io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetricsBuilder;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentInstrumentationConfig;
 import io.opentelemetry.javaagent.extension.AgentListener;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 
 /** An {@link AgentListener} that enables runtime metrics during agent startup. */
 @AutoService(AgentListener.class)
 public class Java17RuntimeMetricsInstaller implements AgentListener {
 
   @Override
   public void afterAgent(AutoConfiguredOpenTelemetrySdk autoConfiguredSdk) {
-    ConfigProperties config = AgentListener.resolveConfigProperties(autoConfiguredSdk);
-
     OpenTelemetry openTelemetry = GlobalOpenTelemetry.get();
-    RuntimeMetricsBuilder builder = null;
-    /*
-    By default don't use any JFR metrics. May change this once semantic conventions are updated.
-    If enabled, default to only the metrics not already covered by runtime-telemetry-java8
-    */
-    boolean defaultEnabled = config.getBoolean("otel.instrumentation.common.default-enabled", true);
-    if (config.getBoolean("otel.instrumentation.runtime-telemetry-java17.enable-all", false)) {
-      builder = RuntimeMetrics.builder(openTelemetry).enableAllFeatures();
-    } else if (config.getBoolean("otel.instrumentation.runtime-telemetry-java17.enabled", false)) {
-      builder = RuntimeMetrics.builder(openTelemetry);
-    } else if (config.getBoolean(
-        "otel.instrumentation.runtime-telemetry.enabled", defaultEnabled)) {
-      // This only uses metrics gathered by JMX
-      builder = RuntimeMetrics.builder(openTelemetry).disableAllFeatures();
-    }
-
-    if (builder != null) {
-      if (config.getBoolean(
-          "otel.instrumentation.runtime-telemetry.emit-experimental-telemetry", false)) {
-        builder.enableExperimentalJmxTelemetry();
-      }
 
-      RuntimeMetrics finalJfrTelemetry = builder.build();
-      Thread cleanupTelemetry = new Thread(() -> finalJfrTelemetry.close());
-      Runtime.getRuntime().addShutdownHook(cleanupTelemetry);
-    }
+    RuntimeMetrics.builder(openTelemetry)
+        .startFromInstrumentationConfig(AgentInstrumentationConfig.get());
   }
 }

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

@@ -7,6 +7,7 @@
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.Classes;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.Cpu;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.GarbageCollector;
@@ -90,6 +91,35 @@ public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
     return this;
   }
 
+  public void startFromInstrumentationConfig(InstrumentationConfig config) {
+    /*
+    By default, don't use any JFR metrics. May change this once semantic conventions are updated.
+    If enabled, default to only the metrics not already covered by runtime-telemetry-java8
+    */
+    boolean defaultEnabled = config.getBoolean("otel.instrumentation.common.default-enabled", true);
+    if (config.getBoolean("otel.instrumentation.runtime-telemetry-java17.enable-all", false)) {
+      this.enableAllFeatures();
+    } else if (config.getBoolean("otel.instrumentation.runtime-telemetry-java17.enabled", false)) {
+      // default configuration
+    } else if (config.getBoolean(
+        "otel.instrumentation.runtime-telemetry.enabled", defaultEnabled)) {
+      // This only uses metrics gathered by JMX
+      this.disableAllFeatures();
+    } else {
+      // nothing is enabled
+      return;
+    }
+
+    if (config.getBoolean(
+        "otel.instrumentation.runtime-telemetry.emit-experimental-telemetry", false)) {
+      this.enableExperimentalJmxTelemetry();
+    }
+
+    RuntimeMetrics finalJfrTelemetry = this.build();
+    Thread cleanupTelemetry = new Thread(finalJfrTelemetry::close);
+    Runtime.getRuntime().addShutdownHook(cleanupTelemetry);
+  }
+
   /** Build and start an {@link RuntimeMetrics} with the config from this builder. */
   public RuntimeMetrics build() {
     List<AutoCloseable> observables = buildObservables();

instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts

@@ -53,6 +53,7 @@ dependencies {
   implementation(project(":instrumentation:logback:logback-mdc-1.0:library"))
   compileOnly("ch.qos.logback:logback-classic:1.0.0")
   implementation(project(":instrumentation:jdbc:library"))
+  implementation(project(":instrumentation:runtime-telemetry:runtime-telemetry-java17:library"))
 
   library("org.springframework.kafka:spring-kafka:2.9.0")
   library("org.springframework.boot:spring-boot-starter-actuator:$springBootVersion")

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/runtimemetrics/Java17RuntimeMetricsAutoConfiguration.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.ConfigPropertiesBridge;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.event.EventListener;
+
+/**
+ * Configures runtime metrics collection.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+@ConditionalOnEnabledInstrumentation(module = "runtime-telemetry-java17")
+@Configuration
+public class Java17RuntimeMetricsAutoConfiguration {
+
+  private static final Logger logger =
+      LoggerFactory.getLogger(Java17RuntimeMetricsAutoConfiguration.class);
+
+  @EventListener
+  public void handleApplicationReadyEvent(ApplicationReadyEvent event) {
+    if (Double.parseDouble(System.getProperty("java.specification.version")) < 17) {
+      logger.debug(
+          "Java 17 runtime metrics instrumentation enabled but running on Java version < 17");
+      return;
+    }
+    logger.debug(
+        "Java 17 runtime metrics instrumentation enabled and running on Java version >= 17");
+    ConfigurableApplicationContext applicationContext = event.getApplicationContext();
+    OpenTelemetry openTelemetry = applicationContext.getBean(OpenTelemetry.class);
+    ConfigProperties configProperties = applicationContext.getBean(ConfigProperties.class);
+    RuntimeMetrics.builder(openTelemetry)
+        .startFromInstrumentationConfig(new ConfigPropertiesBridge(configProperties));
+  }
+}

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/ConfigPropertiesBridge.java

@@ -13,7 +13,13 @@
 import java.util.Map;
 import javax.annotation.Nullable;
 
-final class ConfigPropertiesBridge implements InstrumentationConfig {
+/**
+ * Support for {@link ConfigProperties} in {@link InstrumentationConfig}.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+public final class ConfigPropertiesBridge implements InstrumentationConfig {
 
   private final ConfigProperties configProperties;
 

instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -10,7 +10,8 @@ io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.r
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.web.SpringWebInstrumentationAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.webflux.SpringWebfluxInstrumentationAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.webmvc.SpringWebMvc5InstrumentationAutoConfiguration,\
-io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.scheduling.SpringSchedulingInstrumentationAutoConfiguration
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.scheduling.SpringSchedulingInstrumentationAutoConfiguration,\
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java17RuntimeMetricsAutoConfiguration
 
 org.springframework.context.ApplicationListener=\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.logging.LogbackAppenderApplicationListener

instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -11,3 +11,4 @@ io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.w
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.web.RestClientInstrumentationAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.webmvc.SpringWebMvc6InstrumentationAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.scheduling.SpringSchedulingInstrumentationAutoConfiguration
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java17RuntimeMetricsAutoConfiguration

smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java

@@ -209,6 +209,11 @@ void shouldSendTelemetry() {
         OtelSpringStarterSmokeTestController.METER_SCOPE_NAME,
         OtelSpringStarterSmokeTestController.TEST_HISTOGRAM,
         AbstractIterableAssert::isNotEmpty);
+    // runtime metrics
+    testing.waitAndAssertMetrics(
+        "io.opentelemetry.runtime-telemetry-java8",
+        "jvm.thread.count",
+        AbstractIterableAssert::isNotEmpty);
 
     // Log
     List<LogRecordData> exportedLogRecords = testing.getExportedLogRecords();

smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTestController.java

@@ -15,8 +15,6 @@
 public class OtelSpringStarterSmokeTestController {
 
   public static final String PING = "/ping";
-  public static final String REST_CLIENT = "/rest-client";
-  public static final String REST_TEMPLATE = "/rest-template";
   public static final String TEST_HISTOGRAM = "histogram-test-otel-spring-starter";
   public static final String METER_SCOPE_NAME = "scope";
   private final LongHistogram histogram;