remove all spring starter features where a standard property can be used

open-telemetry · Feb 16, 2024 · 574a7f1 · 574a7f1
1 parent 807e0c2
commit 574a7f1
Show file tree

Hide file tree

Showing 35 changed files with 139 additions and 515 deletions.
diff --git a/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts b/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts
@@ -37,7 +37,7 @@ dependencies {
   library("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
   library("org.springframework.boot:spring-boot-starter-webflux:$springBootVersion")
 
-  compileOnly("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
+  implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
   compileOnly("io.opentelemetry:opentelemetry-extension-annotations")
   compileOnly("io.opentelemetry:opentelemetry-extension-trace-propagators")
   compileOnly("io.opentelemetry.contrib:opentelemetry-aws-xray-propagator")

diff --git a/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
@@ -15,6 +15,7 @@
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.MapConverter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.propagators.PropagationProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceAutoConfiguration;
+import io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.resources.SpringConfigProperties;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
@@ -61,6 +62,7 @@
 @EnableConfigurationProperties({
   SamplerProperties.class,
   OtlpExporterProperties.class,
+  OtelResourceProperties.class,
   PropagationProperties.class
 })
 public class OpenTelemetryAutoConfiguration {
@@ -103,9 +105,14 @@ static class Metric {}
     ConfigProperties configProperties(
         Environment env,
         OtlpExporterProperties otlpExporterProperties,
+        OtelResourceProperties resourceProperties,
         PropagationProperties propagationProperties) {
       return new SpringConfigProperties(
-          env, new SpelExpressionParser(), otlpExporterProperties, propagationProperties);
+          env,
+          new SpelExpressionParser(),
+          otlpExporterProperties,
+          resourceProperties,
+          propagationProperties);
     }
 
     @Bean(destroyMethod = "") // SDK components are shutdown from the OpenTelemetry instance

diff --git a/...etry/instrumentation/spring/autoconfigure/exporters/internal/ExporterConfigEvaluator.java b/...etry/instrumentation/spring/autoconfigure/exporters/internal/ExporterConfigEvaluator.java
@@ -6,7 +6,6 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.exporters.internal;
 
 import java.util.Arrays;
-import javax.annotation.Nullable;
 import org.springframework.core.env.Environment;
 
 /**
@@ -18,28 +17,13 @@ public final class ExporterConfigEvaluator {
   private ExporterConfigEvaluator() {}
 
   public static boolean isExporterEnabled(
-      Environment environment,
-      @Nullable String oldAllKey,
-      String oldKey,
-      String exportersKey,
-      String wantExporter,
-      boolean defaultValue) {
+      Environment environment, String exportersKey, String wantExporter, boolean defaultValue) {
 
     String exporter = environment.getProperty(exportersKey);
     if (exporter != null) {
       return Arrays.asList(exporter.split(",")).contains(wantExporter);
     }
 
-    String old = environment.getProperty(oldKey);
-    if (old != null) {
-      return "true".equals(old);
-    }
-    if (oldAllKey != null) {
-      String oldAll = environment.getProperty(oldAllKey);
-      if (oldAll != null) {
-        return "true".equals(oldAll);
-      }
-    }
     return defaultValue;
   }
 }
diff --git a/...tation/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfiguration.java b/...tation/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfiguration.java
@@ -35,12 +35,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.logging.enabled",
-          "otel.exporter.logging.metrics.enabled",
-          "otel.metrics.exporter",
-          "logging",
-          false);
+          context.getEnvironment(), "otel.metrics.exporter", "logging", false);
     }
   }
 }
diff --git a/...entation/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfiguration.java b/...entation/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfiguration.java
@@ -35,12 +35,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.logging.enabled",
-          "otel.exporter.logging.traces.enabled",
-          "otel.traces.exporter",
-          "logging",
-          false);
+          context.getEnvironment(), "otel.traces.exporter", "logging", false);
     }
   }
 }
diff --git a/...n/spring/autoconfigure/exporters/logging/SystemOutLogRecordExporterAutoConfiguration.java b/...n/spring/autoconfigure/exporters/logging/SystemOutLogRecordExporterAutoConfiguration.java
@@ -35,12 +35,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.logging.enabled",
-          "otel.exporter.logging.logs.enabled",
-          "otel.logs.exporter",
-          "logging",
-          false);
+          context.getEnvironment(), "otel.logs.exporter", "logging", false);
     }
   }
 }
diff --git a/...mentation/spring/autoconfigure/exporters/otlp/OtlpLogRecordExporterAutoConfiguration.java b/...mentation/spring/autoconfigure/exporters/otlp/OtlpLogRecordExporterAutoConfiguration.java
@@ -36,12 +36,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.otlp.enabled",
-          "otel.exporter.otlp.logs.enabled",
-          "otel.logs.exporter",
-          "otlp",
-          true);
+          context.getEnvironment(), "otel.logs.exporter", "otlp", true);
     }
   }
 }
diff --git a/...trumentation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfiguration.java b/...trumentation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfiguration.java
@@ -38,12 +38,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.otlp.enabled",
-          "otel.exporter.otlp.metrics.enabled",
-          "otel.metrics.exporter",
-          "otlp",
-          true);
+          context.getEnvironment(), "otel.metrics.exporter", "otlp", true);
     }
   }
 }
diff --git a/...nstrumentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfiguration.java b/...nstrumentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfiguration.java
@@ -43,12 +43,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          "otel.exporter.otlp.enabled",
-          "otel.exporter.otlp.traces.enabled",
-          "otel.traces.exporter",
-          "otlp",
-          true);
+          context.getEnvironment(), "otel.traces.exporter", "otlp", true);
     }
   }
 }
diff --git a/...umentation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfiguration.java b/...umentation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfiguration.java
@@ -47,12 +47,7 @@ static final class CustomCondition implements Condition {
     @Override
     public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
       return ExporterConfigEvaluator.isExporterEnabled(
-          context.getEnvironment(),
-          null,
-          "otel.exporter.zipkin.enabled",
-          "otel.traces.exporter",
-          "zipkin",
-          true);
+          context.getEnvironment(), "otel.traces.exporter", "zipkin", true);
     }
   }
 }
diff --git a/...y/instrumentation/spring/autoconfigure/propagators/CompositeTextMapPropagatorFactory.java b/...y/instrumentation/spring/autoconfigure/propagators/CompositeTextMapPropagatorFactory.java
@@ -26,7 +26,6 @@ public final class CompositeTextMapPropagatorFactory {
   private static final Logger logger =
       Logger.getLogger(CompositeTextMapPropagatorFactory.class.getName());
 
-  @SuppressWarnings("deprecation") // deprecated class to be updated once published in new location
   static TextMapPropagator getCompositeTextMapPropagator(
       BeanFactory beanFactory, List<String> types) {
 

diff --git a/...try/instrumentation/spring/autoconfigure/propagators/DeprecatedPropagationProperties.java b/...try/instrumentation/spring/autoconfigure/propagators/DeprecatedPropagationProperties.java
diff --git a/...emetry/instrumentation/spring/autoconfigure/propagators/PropagationAutoConfiguration.java b/...emetry/instrumentation/spring/autoconfigure/propagators/PropagationAutoConfiguration.java
@@ -9,6 +9,7 @@
 import io.opentelemetry.context.propagation.TextMapPropagator;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import org.springframework.beans.factory.BeanFactory;
@@ -22,12 +23,13 @@
 
 /** Configures {@link ContextPropagators} bean for propagation. */
 @Configuration
-@EnableConfigurationProperties(DeprecatedPropagationProperties.class)
+@EnableConfigurationProperties(PropagationProperties.class)
 @AutoConfigureBefore(OpenTelemetryAutoConfiguration.class)
 @ConditionalOnProperty(prefix = "otel.propagation", name = "enabled", matchIfMissing = true)
-@SuppressWarnings("deprecation")
 public class PropagationAutoConfiguration {
 
+  private static final List<String> DEFAULT_PROPAGATORS = Arrays.asList("tracecontext", "baggage");
+
   @Bean
   @ConditionalOnMissingBean
   ContextPropagators contextPropagators(ObjectProvider<List<TextMapPropagator>> propagators) {
@@ -43,11 +45,9 @@ static class PropagatorsConfiguration {
 
     @Bean
     TextMapPropagator compositeTextMapPropagator(
-        BeanFactory beanFactory,
-        DeprecatedPropagationProperties properties,
-        ConfigProperties configProperties) {
+        BeanFactory beanFactory, ConfigProperties configProperties) {
       return CompositeTextMapPropagatorFactory.getCompositeTextMapPropagator(
-          beanFactory, configProperties.getList("otel.propagators", properties.getType()));
+          beanFactory, configProperties.getList("otel.propagators", DEFAULT_PROPAGATORS));
     }
   }
 }
diff --git a/...lemetry/instrumentation/spring/autoconfigure/resources/OtelResourceAutoConfiguration.java b/...lemetry/instrumentation/spring/autoconfigure/resources/OtelResourceAutoConfiguration.java
@@ -16,6 +16,7 @@
 import io.opentelemetry.instrumentation.resources.ProcessRuntimeResource;
 import io.opentelemetry.instrumentation.resources.ProcessRuntimeResourceProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
+import io.opentelemetry.sdk.autoconfigure.internal.EnvironmentResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -25,16 +26,19 @@
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
-@EnableConfigurationProperties({OtelSpringResourceProperties.class, OtelResourceProperties.class})
+@EnableConfigurationProperties({OtelResourceProperties.class})
 @AutoConfigureBefore(OpenTelemetryAutoConfiguration.class)
 @ConditionalOnProperty(prefix = "otel.springboot.resource", name = "enabled", matchIfMissing = true)
 public class OtelResourceAutoConfiguration {
 
   @Bean
-  public ResourceProvider otelResourceProvider(
-      OtelSpringResourceProperties otelSpringResourceProperties,
-      OtelResourceProperties otelResourceProperties) {
-    return new SpringResourceProvider(otelSpringResourceProperties, otelResourceProperties);
+  public ResourceProvider otelEnvironmentResourceProvider() {
+    return new EnvironmentResourceProvider();
+  }
+
+  @Bean
+  public ResourceProvider otelSpringResourceProvider() {
+    return new SpringResourceProvider();
   }
 
   @Bean

diff --git a/...elemetry/instrumentation/spring/autoconfigure/resources/OtelSpringResourceProperties.java b/...elemetry/instrumentation/spring/autoconfigure/resources/OtelSpringResourceProperties.java
diff --git a/.../opentelemetry/instrumentation/spring/autoconfigure/resources/SpringConfigProperties.java b/.../opentelemetry/instrumentation/spring/autoconfigure/resources/SpringConfigProperties.java
@@ -23,16 +23,19 @@ public class SpringConfigProperties implements ConfigProperties {
 
   private final ExpressionParser parser;
   private final OtlpExporterProperties otlpExporterProperties;
+  private final OtelResourceProperties resourceProperties;
   private final PropagationProperties propagationProperties;
 
   public SpringConfigProperties(
       Environment environment,
       ExpressionParser parser,
       OtlpExporterProperties otlpExporterProperties,
+      OtelResourceProperties resourceProperties,
       PropagationProperties propagationProperties) {
     this.environment = environment;
     this.parser = parser;
     this.otlpExporterProperties = otlpExporterProperties;
+    this.resourceProperties = resourceProperties;
     this.propagationProperties = propagationProperties;
   }
 
@@ -78,6 +81,7 @@ public List<String> getList(String name) {
     if (name.equals("otel.propagators")) {
       return propagationProperties.getPropagators();
     }
+
     List<String> value = environment.getProperty(name, List.class);
     return value == null ? Collections.emptyList() : value;
   }
@@ -98,6 +102,8 @@ public Duration getDuration(String name) {
   public Map<String, String> getMap(String name) {
     // maps from config properties are not supported by Environment, so we have to fake it
     switch (name) {
+      case "otel.resource.attributes":
+        return resourceProperties.getAttributes();
       case "otel.exporter.otlp.headers":
         return otlpExporterProperties.getHeaders();
       case "otel.exporter.otlp.logs.headers":

diff --git a/.../opentelemetry/instrumentation/spring/autoconfigure/resources/SpringResourceProvider.java b/.../opentelemetry/instrumentation/spring/autoconfigure/resources/SpringResourceProvider.java
@@ -14,29 +14,13 @@
 
 public class SpringResourceProvider implements ResourceProvider {
 
-  private final OtelSpringResourceProperties otelSpringResourceProperties;
-  private final OtelResourceProperties otelResourceProperties;
-
-  public SpringResourceProvider(
-      OtelSpringResourceProperties otelSpringResourceProperties,
-      OtelResourceProperties otelResourceProperties) {
-    this.otelSpringResourceProperties = otelSpringResourceProperties;
-    this.otelResourceProperties = otelResourceProperties;
-  }
-
   @Override
   public Resource createResource(ConfigProperties configProperties) {
     AttributesBuilder attributesBuilder = Attributes.builder();
     String springApplicationName = configProperties.getString("spring.application.name");
     if (springApplicationName != null) {
       attributesBuilder.put(ResourceAttributes.SERVICE_NAME, springApplicationName);
     }
-    otelSpringResourceProperties.getAttributes().forEach(attributesBuilder::put);
-    otelResourceProperties.getAttributes().forEach(attributesBuilder::put);
-    String applicationName = configProperties.getString("otel.service.name");
-    if (applicationName != null) {
-      attributesBuilder.put(ResourceAttributes.SERVICE_NAME, applicationName);
-    }
     return Resource.create(attributesBuilder.build());
   }
 }
diff --git a/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java b/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java
@@ -140,7 +140,7 @@ void shouldDetermineServiceNameByOtelServiceName() {
         .withConfiguration(
             AutoConfigurations.of(
                 OtelResourceAutoConfiguration.class, OpenTelemetryAutoConfiguration.class))
-        .withPropertyValues("otel.springboot.resource.attributes.service.name=otel-name-backend")
+        .withPropertyValues("otel.resource.attributes.service.name=otel-name-backend")
         .run(
             context -> {
               Resource otelResource = context.getBean("otelResource", Resource.class);
@@ -157,9 +157,9 @@ void shouldInitializeAttributes() {
             AutoConfigurations.of(
                 OtelResourceAutoConfiguration.class, OpenTelemetryAutoConfiguration.class))
         .withPropertyValues(
-            "otel.springboot.resource.attributes.xyz=foo",
-            "otel.springboot.resource.attributes.environment=dev",
-            "otel.springboot.resource.attributes.service.instance.id=id-example")
+            "otel.resource.attributes.xyz=foo",
+            "otel.resource.attributes.environment=dev",
+            "otel.resource.attributes.service.instance.id=id-example")
         .run(
             context -> {
               Resource otelResource = context.getBean("otelResource", Resource.class);