Support otel.sdk.disabled in the spring boot starter (#8602)

open-telemetry · Jun 1, 2023 · 2c06c00 · 2c06c00
1 parent ae1b0eb
commit 2c06c00
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 1 deletion.
diff --git a/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
@@ -27,6 +27,7 @@
 import java.util.List;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -48,7 +49,8 @@ public OpenTelemetryAutoConfiguration() {}
 
   @Configuration
   @ConditionalOnMissingBean(OpenTelemetry.class)
-  public static class OpenTelemetryBeanConfig {
+  @ConditionalOnProperty(name = "otel.sdk.disabled", havingValue = "false", matchIfMissing = true)
+  public static class OpenTelemetrySdkConfig {
 
     @Bean
     @ConditionalOnMissingBean
@@ -122,4 +124,15 @@ public OpenTelemetry openTelemetry(
           .build();
     }
   }
+
+  @Configuration
+  @ConditionalOnMissingBean(OpenTelemetry.class)
+  @ConditionalOnProperty(name = "otel.sdk.disabled", havingValue = "true")
+  public static class DisabledOpenTelemetrySdkConfig {
+
+    @Bean
+    public OpenTelemetry openTelemetry() {
+      return OpenTelemetry.noop();
+    }
+  }
 }
diff --git a/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java b/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java
@@ -11,6 +11,7 @@
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceAutoConfiguration;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
@@ -156,4 +157,33 @@ void shouldInitializeAttributes() {
                   .isEqualTo("id-example");
             });
   }
+
+  @Test
+  void shouldInitializeSdkWhenNotDisabled() {
+    this.contextRunner
+        .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class))
+        .withPropertyValues("otel.sdk.disabled=false")
+        .run(
+            context -> {
+              assertThat(context).getBean("openTelemetry").isInstanceOf(OpenTelemetrySdk.class);
+              assertThat(context)
+                  .hasBean("openTelemetry")
+                  .hasBean("sdkTracerProvider")
+                  .hasBean("sdkMeterProvider");
+            });
+  }
+
+  @Test
+  void shouldInitializeNoopOpenTelemetryWhenSdkIsDisabled() {
+    this.contextRunner
+        .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class))
+        .withPropertyValues("otel.sdk.disabled=true")
+        .run(
+            context -> {
+              assertThat(context).getBean("openTelemetry").isEqualTo(OpenTelemetry.noop());
+              assertThat(context)
+                  .doesNotHaveBean("sdkTracerProvider")
+                  .doesNotHaveBean("sdkMeterProvider");
+            });
+  }
 }