use declarative config properties

Author: zeitlinger

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

@@ -14,8 +14,9 @@
 import io.opentelemetry.instrumentation.sdk.DeclarativeConfigPropertiesBridge;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.DeclarativeConfigDisabled;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.DeclarativeConfigEnabled;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.OtelDisabled;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.OtelEnabled;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.OtelMapConverter;
-import io.opentelemetry.instrumentation.spring.autoconfigure.internal.SdkEnabled;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.ConfigPropertiesBridge;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelSpringProperties;
@@ -45,7 +46,6 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.ConfigurationPropertiesBinding;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.info.BuildProperties;
@@ -71,7 +71,7 @@ public class OpenTelemetryAutoConfiguration {
   public OpenTelemetryAutoConfiguration() {}
 
   @Configuration
-  @Conditional(SdkEnabled.class)
+  @Conditional(OtelEnabled.class)
   @ConditionalOnMissingBean(OpenTelemetry.class)
   static class OpenTelemetrySdkConfig {
     @Bean
@@ -207,7 +207,7 @@ private static void logStart() {
 
   @Configuration
   @ConditionalOnMissingBean(OpenTelemetry.class)
-  @ConditionalOnProperty(name = "otel.sdk.disabled", havingValue = "true")
+  @Conditional(OtelDisabled.class)
   static class DisabledOpenTelemetrySdkConfig {
 
     @Bean

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

@@ -20,7 +20,7 @@
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 @ConditionalOnBean(OpenTelemetry.class)
-@Conditional({SdkEnabled.class, InstrumentationPropertyEnabled.class})
+@Conditional({OtelEnabled.class, InstrumentationPropertyEnabled.class})
 public @interface ConditionalOnEnabledInstrumentation {
   String module();
 

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

@@ -5,18 +5,17 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
-import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
-public class DeclarativeConfigDisabled extends AnyNestedCondition {
-  public DeclarativeConfigDisabled() {
-    super(ConfigurationPhase.PARSE_CONFIGURATION);
+public class DeclarativeConfigDisabled implements Condition {
+  @Override
+  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+    return !EarlyConfig.isDeclarativeConfig(context.getEnvironment());
   }
-
-  @ConditionalOnProperty(name = "otel.file_format", matchIfMissing = true, havingValue = "never")
-  static class Disabled {}
 }

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

@@ -5,18 +5,17 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
-import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
-public class DeclarativeConfigEnabled extends AnyNestedCondition {
-  public DeclarativeConfigEnabled() {
-    super(ConfigurationPhase.PARSE_CONFIGURATION);
+public class DeclarativeConfigEnabled implements Condition {
+  @Override
+  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+    return EarlyConfig.isDeclarativeConfig(context.getEnvironment());
   }
-
-  @ConditionalOnProperty(name = "otel.file_format")
-  static class Enabled {}
 }

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

@@ -0,0 +1,49 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+import org.springframework.core.env.Environment;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class EarlyConfig {
+  private EarlyConfig() {}
+
+  private static final Map<String, String> DECLARATIVE_CONFIG_PROPERTY_MAPPING = new HashMap<>();
+
+  static {
+    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);
+  }
+
+  public static Boolean isDeclarativeConfig(Environment environment) {
+    return environment.getProperty("otel.file_format", String.class) != null;
+  }
+
+  public static String translatePropertyName(Environment environment, String name) {
+    if (isDeclarativeConfig(environment)) {
+      return Objects.requireNonNull(
+          DECLARATIVE_CONFIG_PROPERTY_MAPPING.get(name),
+          "No mapping found for property name: " + name + ". Please report this bug.");
+    } else {
+      return name;
+    }
+  }
+}

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

@@ -5,9 +5,13 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
+import static io.opentelemetry.instrumentation.spring.autoconfigure.internal.EarlyConfig.translatePropertyName;
+
 import java.util.Map;
+import java.util.Objects;
 import org.springframework.context.annotation.Condition;
 import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.env.Environment;
 import org.springframework.core.type.AnnotatedTypeMetadata;
 
 /**
@@ -19,19 +23,26 @@ public class InstrumentationPropertyEnabled implements Condition {
   @Override
   public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
     Map<String, Object> attributes =
-        metadata.getAnnotationAttributes(ConditionalOnEnabledInstrumentation.class.getName());
+        Objects.requireNonNull(
+            metadata.getAnnotationAttributes(ConditionalOnEnabledInstrumentation.class.getName()));
+
+    Environment environment = context.getEnvironment();
 
-    String name = String.format("otel.instrumentation.%s.enabled", attributes.get("module"));
-    Boolean explicit = context.getEnvironment().getProperty(name, Boolean.class);
+    String name =
+        String.format(
+            translatePropertyName(environment, "otel.instrumentation.%s.enabled"),
+            attributes.get("module"));
+    Boolean explicit = environment.getProperty(name, Boolean.class);
     if (explicit != null) {
       return explicit;
     }
     boolean defaultValue = (boolean) attributes.get("enabledByDefault");
     if (!defaultValue) {
       return false;
     }
-    return context
-        .getEnvironment()
-        .getProperty("otel.instrumentation.common.default-enabled", Boolean.class, true);
+    return environment.getProperty(
+        translatePropertyName(environment, "otel.instrumentation.common.default-enabled"),
+        Boolean.class,
+        true);
   }
 }

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class OtelDisabled implements Condition {
+  @Override
+  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+    return !EarlyConfig.otelEnabled(context.getEnvironment());
+  }
+}

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
+
+import org.springframework.context.annotation.Condition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class OtelEnabled implements Condition {
+  @Override
+  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
+    return EarlyConfig.otelEnabled(context.getEnvironment());
+  }
+}

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

@@ -9,6 +9,7 @@
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.Appender;
 import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.EarlyConfig;
 import java.util.Iterator;
 import java.util.Optional;
 import org.slf4j.ILoggerFactory;
@@ -54,11 +55,11 @@ private static boolean isLogbackMdcAppenderAddable(
 
   private static boolean isAppenderAddable(
       ApplicationEnvironmentPreparedEvent applicationEnvironmentPreparedEvent, String property) {
-    boolean otelSdkDisabled =
-        evaluateBooleanProperty(applicationEnvironmentPreparedEvent, "otel.sdk.disabled", false);
+    boolean otelEnabled =
+        EarlyConfig.otelEnabled(applicationEnvironmentPreparedEvent.getEnvironment());
     boolean logbackInstrumentationEnabled =
         evaluateBooleanProperty(applicationEnvironmentPreparedEvent, property, true);
-    return !otelSdkDisabled && logbackInstrumentationEnabled;
+    return otelEnabled && logbackInstrumentationEnabled;
   }
 
   private static void reInitializeOpenTelemetryAppender(