re-use library to read build-info.properties

Author: zeitlinger

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

@@ -47,6 +47,7 @@ dependencies {
   compileOnly(project(":instrumentation-annotations"))
 
   compileOnly(project(":instrumentation:resources:library"))
+  compileOnly(project(":instrumentation:spring:spring-boot-resources:library"))
   annotationProcessor("com.google.auto.service:auto-service")
   compileOnly("com.google.auto.service:auto-service-annotations")
 

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

@@ -17,15 +17,14 @@
 import io.opentelemetry.instrumentation.resources.ProcessRuntimeResource;
 import io.opentelemetry.instrumentation.resources.ProcessRuntimeResourceProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
+import io.opentelemetry.instrumentation.spring.resources.SpringBootServiceNameDetector;
+import io.opentelemetry.instrumentation.spring.resources.SpringBootServiceVersionDetector;
 import io.opentelemetry.sdk.autoconfigure.internal.EnvironmentResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
-import java.util.Optional;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.boot.info.BuildProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -41,9 +40,8 @@ public ResourceProvider otelEnvironmentResourceProvider() {
   }
 
   @Bean
-  public ResourceProvider otelSpringResourceProvider(
-      @Autowired(required = false) BuildProperties buildProperties) {
-    return new SpringResourceProvider(Optional.ofNullable(buildProperties));
+  public ResourceProvider otelSpringResourceProvider() {
+    return new SpringResourceProvider();
   }
 
   @Bean
@@ -53,10 +51,22 @@ public ResourceProvider otelDistroVersionResourceProvider() {
 
   @Bean
   @ConditionalOnClass(JarServiceNameDetector.class)
-  public ResourceProvider otelJarResourceProvider() {
+  public ResourceProvider otelJarNameResourceProvider() {
     return new JarServiceNameDetector();
   }
 
+  @Bean
+  @ConditionalOnClass(SpringBootServiceNameDetector.class)
+  public ResourceProvider otelSpringBootServiceNameResourceProvider() {
+    return new SpringBootServiceNameDetector();
+  }
+
+  @Bean
+  @ConditionalOnClass(SpringBootServiceVersionDetector.class)
+  public ResourceProvider otelSpringBootServiceVersionResourceProvider() {
+    return new SpringBootServiceVersionDetector();
+  }
+
   @Bean
   @ConditionalOnClass(OsResource.class)
   public ResourceProvider otelOsResourceProvider() {

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

@@ -11,33 +11,16 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.semconv.ResourceAttributes;
-import java.util.Optional;
-import org.springframework.boot.info.BuildProperties;
 
 public class SpringResourceProvider implements ResourceProvider {
 
-  private final Optional<BuildProperties> buildProperties;
-
-  public SpringResourceProvider(Optional<BuildProperties> buildProperties) {
-    this.buildProperties = buildProperties;
-  }
-
   @Override
   public Resource createResource(ConfigProperties configProperties) {
     AttributesBuilder attributesBuilder = Attributes.builder();
-    buildProperties
-        .map(BuildProperties::getName)
-        .ifPresent(v -> attributesBuilder.put(ResourceAttributes.SERVICE_NAME, v));
-
     String springApplicationName = configProperties.getString("spring.application.name");
     if (springApplicationName != null) {
       attributesBuilder.put(ResourceAttributes.SERVICE_NAME, springApplicationName);
     }
-
-    buildProperties
-        .map(BuildProperties::getVersion)
-        .ifPresent(v -> attributesBuilder.put(ResourceAttributes.SERVICE_VERSION, v));
-
     return Resource.create(attributesBuilder.build());
   }
 }

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

@@ -6,7 +6,6 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure;
 
 import static io.opentelemetry.semconv.ResourceAttributes.SERVICE_NAME;
-import static io.opentelemetry.semconv.ResourceAttributes.SERVICE_VERSION;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.api.OpenTelemetry;
@@ -17,11 +16,9 @@
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
-import java.util.Properties;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
-import org.springframework.boot.info.BuildProperties;
 import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
@@ -120,27 +117,6 @@ void shouldDetermineServiceNameBySpringApplicationName() {
             });
   }
 
-  @Test
-  @DisplayName(
-      "when spring.application.name is set value should be passed to service name attribute")
-  void shouldDetermineServiceNameAndVersionBySpringApplicationVersion() {
-    Properties properties = new Properties();
-    properties.put("name", "demo");
-    properties.put("version", "0.3");
-    this.contextRunner
-        .withBean("buildProperties", BuildProperties.class, () -> new BuildProperties(properties))
-        .withConfiguration(
-            AutoConfigurations.of(
-                OtelResourceAutoConfiguration.class, OpenTelemetryAutoConfiguration.class))
-        .run(
-            context -> {
-              Resource otelResource = context.getBean("otelResource", Resource.class);
-
-              assertThat(otelResource.getAttribute(SERVICE_NAME)).isEqualTo("demo");
-              assertThat(otelResource.getAttribute(SERVICE_VERSION)).isEqualTo("0.3");
-            });
-  }
-
   @Test
   @DisplayName(
       "when spring application name and otel service name are not set service name should be default")

instrumentation/spring/spring-boot-resources/library/src/main/java/io/opentelemetry/instrumentation/spring/resources/SpringBootServiceVersionDetector.java

@@ -18,10 +18,6 @@
 import java.util.Properties;
 import java.util.logging.Logger;
 
-/**
- * Note: should not be used inside a spring application, where the spring.application.name is
- * already available.
- */
 @AutoService(ResourceProvider.class)
 public class SpringBootServiceVersionDetector implements ResourceProvider {
 

instrumentation/spring/starters/spring-boot-starter/build.gradle.kts

@@ -13,6 +13,7 @@ dependencies {
   api("org.springframework.boot:spring-boot-starter-aop:$springBootVersion")
   api(project(":instrumentation:spring:spring-boot-autoconfigure"))
   implementation(project(":instrumentation:resources:library"))
+  implementation(project(":instrumentation:spring:spring-boot-resources:library"))
   api("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
   api("io.opentelemetry:opentelemetry-api")
   api("io.opentelemetry:opentelemetry-exporter-logging")