Refactor Spring starter's instrumentation auto configuration classes (#…

…8950) Co-authored-by: Trask Stalnaker <[email protected]>
open-telemetry · Jul 21, 2023 · fd8e361 · fd8e361
1 parent d17876e
commit fd8e361
Show file tree

Hide file tree

Showing 47 changed files with 544 additions and 835 deletions.
diff --git a/...javaagent/instrumentation/instrumentationannotations/AnnotationInstrumentationModule.java b/...javaagent/instrumentation/instrumentationannotations/AnnotationInstrumentationModule.java
@@ -24,7 +24,7 @@
 public class AnnotationInstrumentationModule extends InstrumentationModule {
 
   public AnnotationInstrumentationModule() {
-    super("opentelemetry-instrumentation-annotations");
+    super("opentelemetry-instrumentation-annotations", "annotations");
   }
 
   @Override

diff --git a/instrumentation/spring/spring-boot-autoconfigure/README.md b/instrumentation/spring/spring-boot-autoconfigure/README.md
@@ -398,16 +398,16 @@ If an exporter is present in the classpath during runtime and a spring bean of t
 
 ##### Enabling/Disabling Features
 
-| Feature          | Property                            | Default Value | ConditionalOnClass     |
-| ---------------- | ----------------------------------- | ------------- | ---------------------- |
-| spring-web       | otel.springboot.httpclients.enabled | `true`        | RestTemplate           |
-| spring-webmvc    | otel.springboot.httpclients.enabled | `true`        | OncePerRequestFilter   |
-| spring-webflux   | otel.springboot.httpclients.enabled | `true`        | WebClient              |
-| @WithSpan        | otel.springboot.aspects.enabled     | `true`        | WithSpan, Aspect       |
-| Otlp Exporter    | otel.exporter.otlp.enabled          | `true`        | OtlpGrpcSpanExporter   |
-| Jaeger Exporter  | otel.exporter.jaeger.enabled        | `true`        | JaegerGrpcSpanExporter |
-| Zipkin Exporter  | otel.exporter.zipkin.enabled        | `true`        | ZipkinSpanExporter     |
-| Logging Exporter | otel.exporter.logging.enabled       | `true`        | LoggingSpanExporter    |
+| Feature          | Property                                    | Default Value | ConditionalOnClass     |
+|------------------|---------------------------------------------|---------------|------------------------|
+| spring-web       | otel.instrumentation.spring-webmvc.enabled  | `true`        | RestTemplate           |
+| spring-webmvc    | otel.instrumentation.spring-web.enabled     | `true`        | OncePerRequestFilter   |
+| spring-webflux   | otel.instrumentation.spring-webflux.enabled | `true`        | WebClient              |
+| @WithSpan        | otel.instrumentation.annotations.enabled    | `true`        | WithSpan, Aspect       |
+| Otlp Exporter    | otel.exporter.otlp.enabled                  | `true`        | OtlpGrpcSpanExporter   |
+| Jaeger Exporter  | otel.exporter.jaeger.enabled                | `true`        | JaegerGrpcSpanExporter |
+| Zipkin Exporter  | otel.exporter.zipkin.enabled                | `true`        | ZipkinSpanExporter     |
+| Logging Exporter | otel.exporter.logging.enabled               | `true`        | LoggingSpanExporter    |
 
 <!-- Slf4j Log Correlation  otel.springboot.loggers.slf4j.enabled		true   		org.slf4j.MDC -->
 

diff --git a/.../io/opentelemetry/instrumentation/spring/autoconfigure/aspects/TraceAspectProperties.java b/.../io/opentelemetry/instrumentation/spring/autoconfigure/aspects/TraceAspectProperties.java
diff --git a/...opentelemetry/instrumentation/spring/autoconfigure/httpclients/HttpClientsProperties.java b/...opentelemetry/instrumentation/spring/autoconfigure/httpclients/HttpClientsProperties.java
diff --git a/...entation/spring/autoconfigure/httpclients/resttemplate/RestTemplateAutoConfiguration.java b/...entation/spring/autoconfigure/httpclients/resttemplate/RestTemplateAutoConfiguration.java
diff --git a/...nstrumentation/spring/autoconfigure/httpclients/webclient/WebClientAutoConfiguration.java b/...nstrumentation/spring/autoconfigure/httpclients/webclient/WebClientAutoConfiguration.java
diff --git a/...aspects/TraceAspectAutoConfiguration.java → ...entationAnnotationsAutoConfiguration.java b/...aspects/TraceAspectAutoConfiguration.java → ...entationAnnotationsAutoConfiguration.java
@@ -3,44 +3,44 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.annotations.WithSpan;
 import org.aspectj.lang.annotation.Aspect;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 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;
 import org.springframework.core.DefaultParameterNameDiscoverer;
 import org.springframework.core.ParameterNameDiscoverer;
 
 /** Configures {@link WithSpanAspect} to trace bean methods annotated with {@link WithSpan}. */
-@Configuration
-@EnableConfigurationProperties(TraceAspectProperties.class)
-@ConditionalOnProperty(prefix = "otel.springboot.aspects", name = "enabled", matchIfMissing = true)
+@ConditionalOnBean(OpenTelemetry.class)
 @ConditionalOnClass(Aspect.class)
-public class TraceAspectAutoConfiguration {
+@ConditionalOnProperty(name = "otel.instrumentation.annotations.enabled", matchIfMissing = true)
+@Configuration
+public class InstrumentationAnnotationsAutoConfiguration {
 
   @Bean
   @ConditionalOnMissingBean
-  public ParameterNameDiscoverer parameterNameDiscoverer() {
+  ParameterNameDiscoverer parameterNameDiscoverer() {
     return new DefaultParameterNameDiscoverer();
   }
 
   @Bean
   @ConditionalOnClass(WithSpan.class)
-  public InstrumentationWithSpanAspect instrumentationWithSpanAspect(
+  InstrumentationWithSpanAspect otelInstrumentationWithSpanAspect(
       OpenTelemetry openTelemetry, ParameterNameDiscoverer parameterNameDiscoverer) {
     return new InstrumentationWithSpanAspect(openTelemetry, parameterNameDiscoverer);
   }
 
   @Bean
   @SuppressWarnings("deprecation") // instrumenting deprecated class for backwards compatibility
   @ConditionalOnClass(io.opentelemetry.extension.annotations.WithSpan.class)
-  public SdkExtensionWithSpanAspect sdkExtensionWithSpanAspect(
+  SdkExtensionWithSpanAspect otelSdkExtensionWithSpanAspect(
       OpenTelemetry openTelemetry, ParameterNameDiscoverer parameterNameDiscoverer) {
     return new SdkExtensionWithSpanAspect(openTelemetry, parameterNameDiscoverer);
   }

diff --git a/...spects/InstrumentationWithSpanAspect.java → ...ations/InstrumentationWithSpanAspect.java b/...spects/InstrumentationWithSpanAspect.java → ...ations/InstrumentationWithSpanAspect.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import org.aspectj.lang.ProceedingJoinPoint;

diff --git a/...toconfigure/aspects/JoinPointRequest.java → ...ntation/annotations/JoinPointRequest.java b/...toconfigure/aspects/JoinPointRequest.java → ...ntation/annotations/JoinPointRequest.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.api.trace.SpanKind;
 import io.opentelemetry.instrumentation.annotations.WithSpan;

diff --git a/...ts/JointPointCodeAttributesExtractor.java → ...ns/JointPointCodeAttributesExtractor.java b/...ts/JointPointCodeAttributesExtractor.java → ...ns/JointPointCodeAttributesExtractor.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.instrumentation.api.instrumenter.code.CodeAttributesGetter;
 

diff --git a/...e/aspects/SdkExtensionWithSpanAspect.java → ...notations/SdkExtensionWithSpanAspect.java b/...e/aspects/SdkExtensionWithSpanAspect.java → ...notations/SdkExtensionWithSpanAspect.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import org.aspectj.lang.ProceedingJoinPoint;

diff --git a/...autoconfigure/aspects/WithSpanAspect.java → ...mentation/annotations/WithSpanAspect.java b/...autoconfigure/aspects/WithSpanAspect.java → ...mentation/annotations/WithSpanAspect.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Span;

diff --git a/...pectParameterAttributeNamesExtractor.java → ...pectParameterAttributeNamesExtractor.java b/...pectParameterAttributeNamesExtractor.java → ...pectParameterAttributeNamesExtractor.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.aspects;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.annotations;
 
 import io.opentelemetry.instrumentation.annotations.SpanAttribute;
 import io.opentelemetry.instrumentation.api.annotation.support.ParameterAttributeNamesExtractor;

diff --git a/...istenerContainerFactoryPostProcessor.java → ...istenerContainerFactoryPostProcessor.java b/...istenerContainerFactoryPostProcessor.java → ...istenerContainerFactoryPostProcessor.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.kafka;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.kafka;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.spring.kafka.v2_7.SpringKafkaTelemetry;

diff --git a/...afkaInstrumentationAutoConfiguration.java → ...afkaInstrumentationAutoConfiguration.java b/...afkaInstrumentationAutoConfiguration.java → ...afkaInstrumentationAutoConfiguration.java
@@ -3,35 +3,35 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.kafka;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.kafka;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.kafkaclients.v2_6.KafkaTelemetry;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.kafka.DefaultKafkaProducerFactoryCustomizer;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.kafka.config.ConcurrentKafkaListenerContainerFactory;
 import org.springframework.kafka.core.KafkaTemplate;
 
-@Configuration
-@EnableConfigurationProperties(KafkaInstrumentationProperties.class)
-@ConditionalOnProperty(name = "otel.springboot.kafka.enabled", matchIfMissing = true)
+@ConditionalOnBean(OpenTelemetry.class)
 @ConditionalOnClass({KafkaTemplate.class, ConcurrentKafkaListenerContainerFactory.class})
+@ConditionalOnProperty(name = "otel.instrumentation.kafka.enabled", matchIfMissing = true)
+@Configuration
 public class KafkaInstrumentationAutoConfiguration {
 
   @Bean
-  public DefaultKafkaProducerFactoryCustomizer producerInstrumentation(
+  DefaultKafkaProducerFactoryCustomizer otelKafkaProducerFactoryCustomizer(
       OpenTelemetry openTelemetry) {
     KafkaTelemetry kafkaTelemetry = KafkaTelemetry.create(openTelemetry);
     return producerFactory -> producerFactory.addPostProcessor(kafkaTelemetry::wrap);
   }
 
   @Bean
-  public ConcurrentKafkaListenerContainerFactoryPostProcessor
-      concurrentKafkaListenerContainerFactoryPostProcessor(OpenTelemetry openTelemetry) {
+  ConcurrentKafkaListenerContainerFactoryPostProcessor
+      otelKafkaListenerContainerFactoryBeanPostProcessor(OpenTelemetry openTelemetry) {
     return new ConcurrentKafkaListenerContainerFactoryPostProcessor(openTelemetry);
   }
 }
diff --git a/...enTelemetryAppenderAutoConfiguration.java → ...enTelemetryAppenderAutoConfiguration.java b/...enTelemetryAppenderAutoConfiguration.java → ...enTelemetryAppenderAutoConfiguration.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.logging;
+package io.opentelemetry.instrumentation.spring.autoconfigure.instrumentation.logging;
 
 import io.opentelemetry.api.OpenTelemetry;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -14,19 +14,16 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
+@ConditionalOnBean(OpenTelemetry.class)
 @Configuration
 @SuppressWarnings("OtelPrivateConstructorForUtilityClass")
-@ConditionalOnBean(OpenTelemetry.class)
 public class OpenTelemetryAppenderAutoConfiguration {
 
-  @Configuration
+  @ConditionalOnClass(org.apache.logging.log4j.core.LoggerContext.class)
   @ConditionalOnProperty(
-      prefix = "otel.springboot.log4j-appender",
-      name = "enabled",
+      name = "otel.instrumentation.log4j-appender.enabled",
       matchIfMissing = true)
-  @ConditionalOnClass({
-    io.opentelemetry.instrumentation.log4j.appender.v2_17.OpenTelemetryAppender.class
-  })
+  @Configuration
   static class Log4jAppenderConfig {
 
     @Bean
@@ -39,14 +36,11 @@ ApplicationListener<ApplicationReadyEvent> log4jOtelAppenderInitializer(
     }
   }
 
-  @Configuration
+  @ConditionalOnClass(ch.qos.logback.classic.LoggerContext.class)
   @ConditionalOnProperty(
-      prefix = "otel.springboot.logback-appender",
-      name = "enabled",
+      name = "otel.instrumentation.logback-appender.enabled",
       matchIfMissing = true)
-  @ConditionalOnClass({
-    io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender.class
-  })
+  @Configuration
   static class LogbackAppenderConfig {
 
     @Bean