Fix Calling shutdown() multiple times warning in spring starter (#10222)

open-telemetry · Jan 18, 2024 · 61e2987 · 61e2987
1 parent 9e208c8
commit 61e2987
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 13 deletions.
diff --git a/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
@@ -76,7 +76,7 @@ public MapConverter mapConverter() {
       return new MapConverter();
     }
 
-    @Bean
+    @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
     @ConditionalOnMissingBean
     public SdkTracerProvider sdkTracerProvider(
         SamplerProperties samplerProperties,
@@ -94,7 +94,7 @@ public SdkTracerProvider sdkTracerProvider(
           .build();
     }
 
-    @Bean
+    @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
     @ConditionalOnMissingBean
     public SdkLoggerProvider sdkLoggerProvider(
         ObjectProvider<List<LogRecordExporter>> loggerExportersProvider, Resource otelResource) {
@@ -112,7 +112,7 @@ public SdkLoggerProvider sdkLoggerProvider(
       return loggerProviderBuilder.build();
     }
 
-    @Bean
+    @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
     @ConditionalOnMissingBean
     public SdkMeterProvider sdkMeterProvider(
         MetricExportProperties properties,

diff --git a/...tation/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfiguration.java b/...tation/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfiguration.java
@@ -25,7 +25,7 @@
 @ConditionalOnClass(LoggingMetricExporter.class)
 public class LoggingMetricExporterAutoConfiguration {
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   public LoggingMetricExporter otelLoggingMetricExporter() {
     return LoggingMetricExporter.create();
   }

diff --git a/...entation/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfiguration.java b/...entation/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfiguration.java
@@ -25,7 +25,7 @@
 @ConditionalOnClass(LoggingSpanExporter.class)
 public class LoggingSpanExporterAutoConfiguration {
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   @ConditionalOnMissingBean
   public LoggingSpanExporter otelLoggingSpanExporter() {
     return LoggingSpanExporter.create();

diff --git a/...trumentation/spring/autoconfigure/exporters/otlp/OtlpLoggerExporterAutoConfiguration.java b/...trumentation/spring/autoconfigure/exporters/otlp/OtlpLoggerExporterAutoConfiguration.java
@@ -27,7 +27,7 @@
 @ConditionalOnClass(OtlpGrpcLogRecordExporter.class)
 public class OtlpLoggerExporterAutoConfiguration {
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   @ConditionalOnMissingBean({OtlpGrpcLogRecordExporter.class, OtlpHttpLogRecordExporter.class})
   public LogRecordExporter otelOtlpLogRecordExporter(OtlpExporterProperties properties) {
 

diff --git a/...trumentation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfiguration.java b/...trumentation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfiguration.java
@@ -29,7 +29,7 @@
 @ConditionalOnClass(OtlpGrpcMetricExporter.class)
 public class OtlpMetricExporterAutoConfiguration {
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   @ConditionalOnMissingBean({OtlpGrpcMetricExporter.class, OtlpHttpMetricExporter.class})
   public MetricExporter otelOtlpMetricExporter(OtlpExporterProperties properties) {
     return OtlpExporterUtil.applySignalProperties(

diff --git a/...nstrumentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfiguration.java b/...nstrumentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfiguration.java
@@ -41,7 +41,7 @@ public OtlpHttpSpanExporterBuilder otelOtlpHttpSpanExporterBuilder() {
     return OtlpHttpSpanExporter.builder();
   }
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   @ConditionalOnMissingBean({OtlpGrpcSpanExporter.class, OtlpHttpSpanExporter.class})
   public SpanExporter otelOtlpSpanExporter(
       OtlpExporterProperties properties, OtlpHttpSpanExporterBuilder otlpHttpSpanExporterBuilder) {

diff --git a/...umentation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfiguration.java b/...umentation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfiguration.java
@@ -30,7 +30,7 @@
 @ConditionalOnClass(ZipkinSpanExporter.class)
 public class ZipkinSpanExporterAutoConfiguration {
 
-  @Bean
+  @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance
   @ConditionalOnMissingBean
   public ZipkinSpanExporter otelZipkinSpanExporter(ZipkinSpanExporterProperties properties) {
 

diff --git a/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java b/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java
@@ -75,13 +75,18 @@ void initializeOpenTelemetryWithCustomProviders() {
         .withBean(
             "customTracerProvider",
             SdkTracerProvider.class,
-            () -> SdkTracerProvider.builder().build())
+            () -> SdkTracerProvider.builder().build(),
+            bd -> bd.setDestroyMethodName(""))
         .withBean(
-            "customMeterProvider", SdkMeterProvider.class, () -> SdkMeterProvider.builder().build())
+            "customMeterProvider",
+            SdkMeterProvider.class,
+            () -> SdkMeterProvider.builder().build(),
+            bd -> bd.setDestroyMethodName(""))
         .withBean(
             "customLoggerProvider",
             SdkLoggerProvider.class,
-            () -> SdkLoggerProvider.builder().build())
+            () -> SdkLoggerProvider.builder().build(),
+            bd -> bd.setDestroyMethodName(""))
         .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class))
         .run(
             context ->

diff --git a/...umentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfigurationTest.java b/...umentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfigurationTest.java
@@ -155,7 +155,10 @@ void useHttpWhenAnUnknownProtocolIsSet() {
   @DisplayName("logging exporter can still be configured")
   void loggingExporter() {
     this.contextRunner
-        .withBean(LoggingSpanExporter.class, LoggingSpanExporter::create)
+        .withBean(
+            LoggingSpanExporter.class,
+            LoggingSpanExporter::create,
+            bd -> bd.setDestroyMethodName(""))
         .run(
             context ->
                 assertThat(