Restructure to have a single spring-boot-autoconfigure artifact (#11826)

open-telemetry · Jul 16, 2024 · 428aa28 · 428aa28
1 parent 09ad619
commit 428aa28
Show file tree

Hide file tree

Showing 84 changed files with 205 additions and 188 deletions.
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-spring-boot-autoconfigure-3.txt b/docs/apidiffs/current_vs_latest/opentelemetry-spring-boot-autoconfigure-3.txt
diff --git a/...telemetry-spring-boot-autoconfigure-2.txt → ...entelemetry-spring-boot-autoconfigure.txt b/...telemetry-spring-boot-autoconfigure-2.txt → ...entelemetry-spring-boot-autoconfigure.txt
@@ -1,8 +1,8 @@
-Comparing source compatibility of opentelemetry-spring-boot-autoconfigure-2-2.6.0-SNAPSHOT.jar against 
-+++  NEW CLASS: PUBLIC(+) io.opentelemetry.instrumentation.spring.autoconfigure.v2.OpenTelemetryAutoConfiguration  (not serializable)
+Comparing source compatibility of opentelemetry-spring-boot-autoconfigure-2.6.0-SNAPSHOT.jar against 
++++  NEW CLASS: PUBLIC(+) io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
 	+++  NEW CONSTRUCTOR: PUBLIC(+) OpenTelemetryAutoConfiguration()
 	+++  NEW ANNOTATION: org.springframework.context.annotation.Configuration
 	+++  NEW ANNOTATION: org.springframework.boot.context.properties.EnableConfigurationProperties
-		+++  NEW ELEMENT: value=io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.OtlpExporterProperties,io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.OtelResourceProperties,io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.PropagationProperties (+)
+		+++  NEW ELEMENT: value=io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties,io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties (+)
diff --git a/docs/contributing/intellij-setup-and-troubleshooting.md b/docs/contributing/intellij-setup-and-troubleshooting.md
@@ -35,7 +35,7 @@ If you are working on a specific instrumentation, you can load only the modules
 For example, to load the modules for the Spring Boot autoconfigure instrumentation, run:
 
 ```shell
-./docs/contributing/selectModules.kts instrumentation/spring/spring-boot-autoconfigure-2/
+./docs/contributing/selectModules.kts instrumentation/spring/spring-boot-autoconfigure/
 ```
 
 Install the [Kotlin executable](https://kotlinlang.org/docs/tutorials/command-line.html)

diff --git a/docs/contributing/selectModules.kts b/docs/contributing/selectModules.kts
@@ -12,7 +12,7 @@ main(args)
 
 fun main(args: Array<String>) {
   if (args.isEmpty()) {
-    println("Usage: ./docs/contributing/selectModules.kts instrumentation/spring/spring-boot-autoconfigure-2/ <module to include2> ...")
+    println("Usage: ./docs/contributing/selectModules.kts instrumentation/spring/spring-boot-autoconfigure/ <module to include2> ...")
     return
   }
 

diff --git a/...mentation/spring/spring-boot-autoconfigure-2/src/main/resources/META-INF/spring.factories b/...mentation/spring/spring-boot-autoconfigure-2/src/main/resources/META-INF/spring.factories
diff --git a/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
diff --git a/instrumentation/spring/spring-boot-autoconfigure-3/README.md b/instrumentation/spring/spring-boot-autoconfigure-3/README.md
diff --git a/instrumentation/spring/spring-boot-autoconfigure-3/build.gradle.kts b/instrumentation/spring/spring-boot-autoconfigure-3/build.gradle.kts
diff --git a/instrumentation/spring/spring-boot-autoconfigure-3/gradle.properties b/instrumentation/spring/spring-boot-autoconfigure-3/gradle.properties
diff --git a/...ation/spring/spring-boot-autoconfigure-3/src/main/resources/META-INF/spring/aot.factories b/...ation/spring/spring-boot-autoconfigure-3/src/main/resources/META-INF/spring/aot.factories
diff --git a/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
diff --git a/...ing/spring-boot-autoconfigure-2/README.md → ...pring/spring-boot-autoconfigure/README.md b/...ing/spring-boot-autoconfigure-2/README.md → ...pring/spring-boot-autoconfigure/README.md
diff --git a/...ing-boot-autoconfigure-2/build.gradle.kts → ...pring-boot-autoconfigure/build.gradle.kts b/...ing-boot-autoconfigure-2/build.gradle.kts → ...pring-boot-autoconfigure/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
   id("otel.japicmp-conventions")
 }
 
-base.archivesName.set("opentelemetry-spring-boot-autoconfigure-2")
+base.archivesName.set("opentelemetry-spring-boot-autoconfigure")
 group = "io.opentelemetry.instrumentation"
 
 val springBootVersion = "2.7.18" // AutoConfiguration is added in 2.7.0, but can be used with older versions
@@ -18,6 +18,17 @@ sourceSets {
       "builtBy" to ":instrumentation:r2dbc-1.0:library-instrumentation-shaded:extractShadowJarSpring",
     )
   }
+  create("javaSpring3") {
+    java {
+      setSrcDirs(listOf("src/main/javaSpring3"))
+    }
+  }
+}
+
+configurations {
+  named("javaSpring3CompileOnly") {
+    extendsFrom(configurations["compileOnly"])
+  }
 }
 
 dependencies {
@@ -82,6 +93,16 @@ dependencies {
   testImplementation("io.opentelemetry:opentelemetry-exporter-otlp")
   testImplementation("io.opentelemetry:opentelemetry-exporter-zipkin")
   testImplementation(project(":instrumentation-annotations"))
+
+  // needed for the Spring Boot 3 support
+  implementation(project(":instrumentation:spring:spring-webmvc:spring-webmvc-6.0:library"))
+
+  // give access to common classes, e.g. InstrumentationConfigUtil
+  add("javaSpring3CompileOnly", files(sourceSets.main.get().output.classesDirs))
+  add("javaSpring3CompileOnly", "org.springframework.boot:spring-boot-starter-web:3.2.4")
+  add("javaSpring3CompileOnly", "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  add("javaSpring3CompileOnly", project(":instrumentation:spring:spring-web:spring-web-3.1:library"))
+  add("javaSpring3CompileOnly", project(":instrumentation:spring:spring-webmvc:spring-webmvc-6.0:library"))
 }
 
 val latestDepTest = findProperty("testLatestDeps") as Boolean
@@ -93,6 +114,9 @@ if (latestDepTest) {
   }
 }
 
+val testJavaVersion = gradle.startParameter.projectProperties["testJavaVersion"]?.let(JavaVersion::toVersion)
+val testSpring3 = (testJavaVersion == null || testJavaVersion.compareTo(JavaVersion.VERSION_17) >= 0)
+
 testing {
   suites {
     val testLogbackAppender by registering(JvmTestSuite::class) {
@@ -118,9 +142,7 @@ testing {
         }
       }
     }
-  }
 
-  suites {
     val testLogbackMissing by registering(JvmTestSuite::class) {
       dependencies {
         implementation(project())
@@ -133,6 +155,20 @@ testing {
         }
       }
     }
+
+    val testSpring3 by registering(JvmTestSuite::class) {
+      dependencies {
+        implementation(project())
+        implementation("org.springframework.boot:spring-boot-starter-web:3.2.4")
+        implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+        implementation(project(":instrumentation:spring:spring-web:spring-web-3.1:library"))
+        implementation(project(":instrumentation:spring:spring-webmvc:spring-webmvc-6.0:library"))
+        implementation("jakarta.servlet:jakarta.servlet-api:5.0.0")
+        implementation("org.springframework.boot:spring-boot-starter-test:3.2.4") {
+          exclude("org.junit.vintage", "junit-vintage-engine")
+        }
+      }
+    }
   }
 }
 
@@ -158,4 +194,24 @@ tasks {
     jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
     jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
   }
+
+  named<JavaCompile>("compileJavaSpring3Java") {
+    sourceCompatibility = "17"
+    targetCompatibility = "17"
+    options.release.set(17)
+  }
+
+  named<JavaCompile>("compileTestSpring3Java") {
+    sourceCompatibility = "17"
+    targetCompatibility = "17"
+    options.release.set(17)
+  }
+
+  named<Test>("testSpring3") {
+    isEnabled = testSpring3
+  }
+
+  withType(Jar::class) {
+    from(sourceSets["javaSpring3"].output)
+  }
 }
diff --git a/...ng-boot-autoconfigure-2/gradle.properties → ...ring-boot-autoconfigure/gradle.properties b/...ng-boot-autoconfigure-2/gradle.properties → ...ring-boot-autoconfigure/gradle.properties
diff --git a/...re/v2/OpenTelemetryAutoConfiguration.java → ...igure/OpenTelemetryAutoConfiguration.java b/...re/v2/OpenTelemetryAutoConfiguration.java → ...igure/OpenTelemetryAutoConfiguration.java
@@ -3,18 +3,18 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2;
+package io.opentelemetry.instrumentation.spring.autoconfigure;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.TracerProvider;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.MapConverter;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.SdkEnabled;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.OtelResourceProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.OtlpExporterProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.PropagationProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.SpringConfigProperties;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.resources.DistroVersionResourceProvider;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.resources.SpringResourceProvider;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.MapConverter;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.SdkEnabled;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelResourceProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.PropagationProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.DistroVersionResourceProvider;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.SpringResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.internal.ComponentLoader;

diff --git a/.../ConditionalOnEnabledInstrumentation.java → .../ConditionalOnEnabledInstrumentation.java b/.../ConditionalOnEnabledInstrumentation.java → .../ConditionalOnEnabledInstrumentation.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
 import io.opentelemetry.api.OpenTelemetry;
 import java.lang.annotation.ElementType;

diff --git a/...ernal/InstrumentationPropertyEnabled.java → ...ernal/InstrumentationPropertyEnabled.java b/...ernal/InstrumentationPropertyEnabled.java → ...ernal/InstrumentationPropertyEnabled.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
 import java.util.Map;
 import org.springframework.context.annotation.Condition;

diff --git a/...toconfigure/v2/internal/MapConverter.java → .../autoconfigure/internal/MapConverter.java b/...toconfigure/v2/internal/MapConverter.java → .../autoconfigure/internal/MapConverter.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import java.util.Collections;

diff --git a/...autoconfigure/v2/internal/SdkEnabled.java → ...ng/autoconfigure/internal/SdkEnabled.java b/...autoconfigure/v2/internal/SdkEnabled.java → ...ng/autoconfigure/internal/SdkEnabled.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
 import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

diff --git a/...entationAnnotationsAutoConfiguration.java → ...entationAnnotationsAutoConfiguration.java b/...entationAnnotationsAutoConfiguration.java → ...entationAnnotationsAutoConfiguration.java
@@ -3,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.instrumentation.annotations;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.annotations.WithSpan;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
 import org.aspectj.lang.annotation.Aspect;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.context.annotation.Bean;

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

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

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

diff --git a/...mentation/annotations/WithSpanAspect.java → ...mentation/annotations/WithSpanAspect.java b/...mentation/annotations/WithSpanAspect.java → ...mentation/annotations/WithSpanAspect.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.instrumentation.annotations;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Span;
@@ -28,7 +28,7 @@
  * can not be applied to constructors.
  */
 abstract class WithSpanAspect {
-  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.spring-boot-autoconfigure-2";
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.spring-boot-autoconfigure";
 
   private final Instrumenter<JoinPointRequest, Object> instrumenter;
   private final JoinPointRequest.Factory requestFactory;

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.v2.internal.instrumentation.annotations;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.annotations;
 
 import io.opentelemetry.instrumentation.annotations.SpanAttribute;
 import io.opentelemetry.instrumentation.api.annotation.support.ParameterAttributeNamesExtractor;

diff --git a/...ntation/jdbc/DataSourcePostProcessor.java → ...ntation/jdbc/DataSourcePostProcessor.java b/...ntation/jdbc/DataSourcePostProcessor.java → ...ntation/jdbc/DataSourcePostProcessor.java
@@ -3,12 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.instrumentation.jdbc;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.jdbc;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.jdbc.datasource.JdbcTelemetry;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.properties.InstrumentationConfigUtil;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.InstrumentationConfigUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import javax.sql.DataSource;
 import org.springframework.aop.scope.ScopedProxyUtils;

diff --git a/...JdbcInstrumentationAutoConfiguration.java → ...JdbcInstrumentationAutoConfiguration.java b/...JdbcInstrumentationAutoConfiguration.java → ...JdbcInstrumentationAutoConfiguration.java
@@ -3,10 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.instrumentation.jdbc;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.jdbc;
 
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import javax.sql.DataSource;
 import org.springframework.beans.factory.ObjectProvider;

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.v2.internal.instrumentation.kafka;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.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,11 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.instrumentation.kafka;
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.kafka;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.kafkaclients.v2_6.KafkaTelemetry;
-import io.opentelemetry.instrumentation.spring.autoconfigure.v2.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;