map default enabled

Author: zeitlinger

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

@@ -86,6 +86,7 @@ dependencies {
   testLibrary("org.springframework.boot:spring-boot-starter-test:$springBootVersion") {
     exclude("org.junit.vintage", "junit-vintage-engine")
   }
+
   testImplementation("javax.servlet:javax.servlet-api:3.1.0")
   testImplementation("jakarta.servlet:jakarta.servlet-api:5.0.0")
   testRuntimeOnly("com.h2database:h2:1.4.197")
@@ -187,6 +188,7 @@ testing {
         implementation("org.springframework.boot:spring-boot-starter-test:$springBootVersion") {
           exclude("org.junit.vintage", "junit-vintage-engine")
         }
+        implementation("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
       }
     }
   }

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

@@ -5,8 +5,10 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
 import java.util.HashMap;
 import java.util.Map;
+import javax.annotation.Nullable;
 import org.springframework.core.env.Environment;
 
 /**
@@ -22,55 +24,83 @@ private EarlyConfig() {}
     DECLARATIVE_CONFIG_PROPERTY_MAPPING.put("otel.sdk.disabled", "otel.disabled");
     DECLARATIVE_CONFIG_PROPERTY_MAPPING.put(
         "otel.instrumentation.%s.enabled", "otel.instrumentation/development.java.%s.enabled");
-    DECLARATIVE_CONFIG_PROPERTY_MAPPING.put(
-        "otel.instrumentation.common.default-enabled",
-        "otel.instrumentation/development.java.common.default.enabled");
   }
 
   public static boolean otelEnabled(Environment environment) {
     return !environment.getProperty(
-        translatePropertyName(environment, "otel.sdk.disabled"), Boolean.class, false);
+        translatePropertyName(environment, "otel.sdk.disabled", null), Boolean.class, false);
   }
 
-  public static Boolean isDeclarativeConfig(Environment environment) {
+  public static boolean isDeclarativeConfig(Environment environment) {
     return environment.getProperty("otel.file_format", String.class) != null;
   }
 
-  public static String translatePropertyName(Environment environment, String name) {
+  public static boolean isDefaultEnabled(Environment environment) {
     if (isDeclarativeConfig(environment)) {
-      String value = DECLARATIVE_CONFIG_PROPERTY_MAPPING.get(name);
-      if (value != null) {
-        return value;
-      }
-      if (name.startsWith("otel.instrumentation.")) {
-        return String.format(
-            "otel.instrumentation/development.java.%s",
-            name.substring("otel.instrumentation.".length()));
+      String mode =
+          environment.getProperty(
+              "otel.instrumentation/development.java.spring_starter.instrumentation_mode",
+              String.class,
+              "default");
+
+      switch (mode) {
+        case "none":
+          return false;
+        case "default":
+          return true;
+        default:
+          throw new ConfigurationException("Unknown instrumentation mode: " + mode);
       }
+    } else {
+      return environment.getProperty(
+          "otel.instrumentation.common.default-enabled", Boolean.class, true);
+    }
+  }
 
-      throw new IllegalStateException(
-          "No mapping found for property name: " + name + ". Please report this bug.");
+  public static String translatePropertyName(
+      Environment environment, String name, @Nullable String arg) {
+    if (isDeclarativeConfig(environment)) {
+      String key = declarativeConfigKey(name);
+      if (arg != null) {
+        key = String.format(key, arg);
+      }
+      return key.replace('-', '_');
     } else {
-      return name;
+      String key = name;
+      if (arg != null) {
+        key = String.format(key, arg);
+      }
+      return key;
     }
   }
 
+  private static String declarativeConfigKey(String name) {
+    String value = DECLARATIVE_CONFIG_PROPERTY_MAPPING.get(name);
+    if (value != null) {
+      return value;
+    }
+    if (name.startsWith("otel.instrumentation.")) {
+      return String.format(
+          "otel.instrumentation/development.java.%s",
+          name.substring("otel.instrumentation.".length()));
+    }
+
+    throw new IllegalStateException(
+        "No mapping found for property name: " + name + ". Please report this bug.");
+  }
+
   public static boolean isInstrumentationEnabled(
       Environment environment, String name, boolean defaultValue) {
     Boolean explicit =
         environment.getProperty(
-            String.format(
-                translatePropertyName(environment, "otel.instrumentation.%s.enabled"), name),
+            translatePropertyName(environment, "otel.instrumentation.%s.enabled", name),
             Boolean.class);
     if (explicit != null) {
       return explicit;
     }
     if (!defaultValue) {
       return false;
     }
-    return environment.getProperty(
-        translatePropertyName(environment, "otel.instrumentation.common.default-enabled"),
-        Boolean.class,
-        true);
+    return isDefaultEnabled(environment);
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/logging/LogbackAppenderInstaller.java

@@ -221,7 +221,7 @@ private static Boolean evaluateBooleanProperty(
       ApplicationEnvironmentPreparedEvent applicationEnvironmentPreparedEvent, String property) {
     ConfigurableEnvironment environment = applicationEnvironmentPreparedEvent.getEnvironment();
     return environment.getProperty(
-        EarlyConfig.translatePropertyName(environment, property), Boolean.class);
+        EarlyConfig.translatePropertyName(environment, property, null), Boolean.class);
   }
 
   private static <T> Optional<T> findAppender(Class<T> appenderClass) {

instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java

@@ -26,7 +26,7 @@
 /** Spring Boot auto configuration test for {@link OpenTelemetryAutoConfiguration}. */
 class OpenTelemetryAutoConfigurationTest {
   @TestConfiguration
-  static class CustomTracerConfiguration {
+  static class CustomOtelConfiguration {
     @Bean
     public OpenTelemetry customOpenTelemetry() {
       return OpenTelemetry.noop();
@@ -48,7 +48,7 @@ public OpenTelemetry customOpenTelemetry() {
       "when Application Context contains OpenTelemetry bean should NOT initialize openTelemetry")
   void customOpenTelemetry() {
     this.contextRunner
-        .withUserConfiguration(CustomTracerConfiguration.class)
+        .withUserConfiguration(CustomOtelConfiguration.class)
         .withConfiguration(AutoConfigurations.of(OpenTelemetryAutoConfiguration.class))
         .run(
             context ->

instrumentation/spring/spring-boot-autoconfigure/src/testDeclarativeConfig/java/io/opentelemetry/instrumentation/spring/autoconfigure/DeclarativeConfigTest.java

@@ -9,6 +9,7 @@
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.web.SpringWebInstrumentationAutoConfiguration;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
@@ -40,6 +41,7 @@ public OpenTelemetry customOpenTelemetry() {
   void customOpenTelemetry() {
     this.contextRunner
         .withUserConfiguration(CustomTracerConfiguration.class)
+        .withPropertyValues("otel.file_format=1.0-rc.1")
         .run(
             context ->
                 assertThat(context)
@@ -72,7 +74,7 @@ void initializeProvidersAndOpenTelemetry() {
   @Test
   void shouldInitializeSdkWhenNotDisabled() {
     this.contextRunner
-        .withPropertyValues("otel.disabled=false")
+        .withPropertyValues("otel.file_format=1.0-rc.1", "otel.disabled=false")
         .run(
             context ->
                 assertThat(context).getBean("openTelemetry").isInstanceOf(OpenTelemetrySdk.class));
@@ -82,10 +84,40 @@ void shouldInitializeSdkWhenNotDisabled() {
   void shouldInitializeNoopOpenTelemetryWhenSdkIsDisabled() {
     this.contextRunner
         .withPropertyValues(
+            "otel.file_format=1.0-rc.1",
             "otel.disabled=true",
             "otel.resource.attributes=service.name=workflow-backend-dev,service.version=3c8f9ce9")
         .run(
             context ->
                 assertThat(context).getBean("openTelemetry").isEqualTo(OpenTelemetry.noop()));
   }
+
+  @Test
+  void shouldLoadInstrumentation() {
+    this.contextRunner
+        .withConfiguration(AutoConfigurations.of(SpringWebInstrumentationAutoConfiguration.class))
+        .withPropertyValues("otel.file_format=1.0-rc.1")
+        .run(context -> assertThat(context).hasBean("otelRestTemplateBeanPostProcessor"));
+  }
+
+  @Test
+  void shouldNotLoadInstrumentationWhenDefaultIsDisabled() {
+    this.contextRunner
+        .withConfiguration(AutoConfigurations.of(SpringWebInstrumentationAutoConfiguration.class))
+        .withPropertyValues(
+            "otel.file_format=1.0-rc.1",
+            "otel.instrumentation/development.java.spring_starter.instrumentation_mode=none")
+        .run(context -> assertThat(context).doesNotHaveBean("otelRestTemplateBeanPostProcessor"));
+  }
+
+  @Test
+  void shouldLoadInstrumentationWhenExplicitlyEnabled() {
+    this.contextRunner
+        .withConfiguration(AutoConfigurations.of(SpringWebInstrumentationAutoConfiguration.class))
+        .withPropertyValues(
+            "otel.file_format=1.0-rc.1",
+            "otel.instrumentation/development.java.spring_starter.instrumentation_mode=none",
+            "otel.instrumentation/development.java.spring_web.enabled=true")
+        .run(context -> assertThat(context).hasBean("otelRestTemplateBeanPostProcessor"));
+  }
 }