use spring shutdown hook

Author: zeitlinger

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

@@ -12,6 +12,7 @@
 import java.util.Arrays;
 import java.util.EnumMap;
 import java.util.List;
+import java.util.function.Consumer;
 import javax.annotation.Nullable;
 
 /** Builder for {@link RuntimeMetrics}. */
@@ -23,6 +24,10 @@ public final class RuntimeMetricsBuilder {
 
   private boolean disableJmx = false;
   private boolean enableExperimentalJmxTelemetry = false;
+  private Consumer<Runnable> shutdownHook =
+      runnable -> {
+        Runtime.getRuntime().addShutdownHook(new Thread(runnable));
+      };
 
   RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
     this.openTelemetry = openTelemetry;
@@ -82,6 +87,13 @@ public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
     return this;
   }
 
+  /** Set a custom shutdown hook for the {@link RuntimeMetrics}. */
+  @CanIgnoreReturnValue
+  public RuntimeMetricsBuilder setShutdownHook(Consumer<Runnable> shutdownHook) {
+    this.shutdownHook = shutdownHook;
+    return this;
+  }
+
   public void startFromInstrumentationConfig(InstrumentationConfig config) {
     /*
     By default, don't use any JFR metrics. May change this once semantic conventions are updated.
@@ -106,16 +118,17 @@ public void startFromInstrumentationConfig(InstrumentationConfig config) {
       this.enableExperimentalJmxTelemetry();
     }
 
-    RuntimeMetrics finalJfrTelemetry = this.build();
-    Thread cleanupTelemetry = new Thread(finalJfrTelemetry::close);
-    Runtime.getRuntime().addShutdownHook(cleanupTelemetry);
+    RuntimeMetrics runtimeMetrics = this.build();
+    shutdownHook.accept(runtimeMetrics::close);
   }
 
   /** Build and start an {@link RuntimeMetrics} with the config from this builder. */
   public RuntimeMetrics build() {
     List<AutoCloseable> observables =
-        JmxRuntimeMetricsFactory.buildObservables(
-            openTelemetry, disableJmx, enableExperimentalJmxTelemetry);
+        disableJmx
+            ? List.of()
+            : JmxRuntimeMetricsFactory.buildObservables(
+                openTelemetry, enableExperimentalJmxTelemetry);
     RuntimeMetrics.JfrRuntimeMetrics jfrRuntimeMetrics = buildJfrMetrics();
     return new RuntimeMetrics(openTelemetry, observables, jfrRuntimeMetrics);
   }

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

@@ -10,13 +10,18 @@
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.internal.JmxRuntimeMetricsFactory;
 import java.util.List;
+import java.util.function.Consumer;
 
 /** Builder for {@link RuntimeMetrics}. */
 public final class RuntimeMetricsBuilder {
 
   private final OpenTelemetry openTelemetry;
 
   private boolean enableExperimentalJmxTelemetry = false;
+  private Consumer<Runnable> shutdownHook =
+      runnable -> {
+        Runtime.getRuntime().addShutdownHook(new Thread(runnable));
+      };
 
   RuntimeMetricsBuilder(OpenTelemetry openTelemetry) {
     this.openTelemetry = openTelemetry;
@@ -32,11 +37,17 @@ public RuntimeMetricsBuilder enableExperimentalJmxTelemetry() {
   /** Build and start an {@link RuntimeMetrics} with the config from this builder. */
   public RuntimeMetrics build() {
     List<AutoCloseable> observables =
-        JmxRuntimeMetricsFactory.buildObservables(
-            openTelemetry, false, enableExperimentalJmxTelemetry);
+        JmxRuntimeMetricsFactory.buildObservables(openTelemetry, enableExperimentalJmxTelemetry);
     return new RuntimeMetrics(observables);
   }
 
+  /** Set a custom shutdown hook for the {@link RuntimeMetrics}. */
+  @CanIgnoreReturnValue
+  public RuntimeMetricsBuilder setShutdownHook(Consumer<Runnable> shutdownHook) {
+    this.shutdownHook = shutdownHook;
+    return this;
+  }
+
   public void startFromInstrumentationConfig(InstrumentationConfig config) {
     /*
     By default, don't use any JFR metrics. May change this once semantic conventions are updated.
@@ -53,8 +64,7 @@ public void startFromInstrumentationConfig(InstrumentationConfig config) {
       this.enableExperimentalJmxTelemetry();
     }
 
-    RuntimeMetrics finalJfrTelemetry = this.build();
-    Thread cleanupTelemetry = new Thread(finalJfrTelemetry::close);
-    Runtime.getRuntime().addShutdownHook(cleanupTelemetry);
+    RuntimeMetrics runtimeMetrics = this.build();
+    shutdownHook.accept(runtimeMetrics::close);
   }
 }

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

@@ -12,7 +12,6 @@
 import io.opentelemetry.instrumentation.runtimemetrics.java8.MemoryPools;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.Threads;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 
 /**
@@ -22,10 +21,7 @@
 public class JmxRuntimeMetricsFactory {
   @SuppressWarnings("CatchingUnchecked")
   public static List<AutoCloseable> buildObservables(
-      OpenTelemetry openTelemetry, boolean disableJmx, boolean enableExperimentalJmxTelemetry) {
-    if (disableJmx) {
-      return Collections.emptyList();
-    }
+      OpenTelemetry openTelemetry, boolean enableExperimentalJmxTelemetry) {
     try {
       // Set up metrics gathered by JMX
       List<AutoCloseable> observables = new ArrayList<>();

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

@@ -9,6 +9,7 @@
 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 javax.annotation.PreDestroy;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.context.event.ApplicationReadyEvent;
@@ -29,6 +30,15 @@ public class RuntimeMetricsAutoConfiguration {
   private static final Logger logger =
       LoggerFactory.getLogger(RuntimeMetricsAutoConfiguration.class);
 
+  private Runnable shutdownHook;
+
+  @PreDestroy
+  public void stopMetrics() {
+    if (shutdownHook != null) {
+      shutdownHook.run();
+    }
+  }
+
   @EventListener
   public void handleApplicationReadyEvent(ApplicationReadyEvent event) {
     ConfigurableApplicationContext applicationContext = event.getApplicationContext();
@@ -39,10 +49,12 @@ public void handleApplicationReadyEvent(ApplicationReadyEvent event) {
     if (Double.parseDouble(System.getProperty("java.specification.version")) >= 17) {
       logger.debug("Use runtime metrics instrumentation for Java 17+");
       io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics.builder(openTelemetry)
+          .setShutdownHook(runnable -> shutdownHook = runnable)
           .startFromInstrumentationConfig(config);
     } else {
       logger.debug("Use runtime metrics instrumentation for Java 8");
       io.opentelemetry.instrumentation.runtimemetrics.java8.RuntimeMetrics.builder(openTelemetry)
+          .setShutdownHook(runnable -> shutdownHook = runnable)
           .startFromInstrumentationConfig(config);
     }
   }