add distro

Author: zeitlinger

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

@@ -22,18 +22,23 @@
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtelSpringProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.OtlpExporterProperties;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.properties.SpringConfigProperties;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.DistroComponentProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.DistroVersionResourceProvider;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.ResourceCustomizerProvider;
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources.SpringResourceProvider;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import io.opentelemetry.sdk.resources.Resource;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
@@ -72,16 +77,8 @@ public OpenTelemetryAutoConfiguration() {}
   @Configuration
   @Conditional(OtelEnabled.class)
   @ConditionalOnMissingBean(OpenTelemetry.class)
+  @SuppressWarnings("OtelPrivateConstructorForUtilityClass")
   static class OpenTelemetrySdkConfig {
-    @Bean
-    public ResourceProvider otelSpringResourceProvider(Optional<BuildProperties> buildProperties) {
-      return new SpringResourceProvider(buildProperties);
-    }
-
-    @Bean
-    public ResourceProvider otelDistroVersionResourceProvider() {
-      return new DistroVersionResourceProvider();
-    }
 
     @Configuration
     @EnableConfigurationProperties({
@@ -92,6 +89,17 @@ public ResourceProvider otelDistroVersionResourceProvider() {
     @Conditional(DeclarativeConfigDisabled.class)
     static class PropertiesConfig {
 
+      @Bean
+      public ResourceProvider otelSpringResourceProvider(
+          Optional<BuildProperties> buildProperties) {
+        return new SpringResourceProvider(buildProperties);
+      }
+
+      @Bean
+      public ResourceProvider otelDistroVersionResourceProvider() {
+        return new DistroVersionResourceProvider();
+      }
+
       @Bean
       @ConfigurationPropertiesBinding
       OtelMapConverter otelMapConverter() {
@@ -185,6 +193,16 @@ public ConfigProperties otelProperties(ConfigProvider configProvider) {
         return new DeclarativeConfigPropertiesBridgeBuilder()
             .buildFromInstrumentationConfig(configProvider.getInstrumentationConfig());
       }
+
+      @Bean
+      public DeclarativeConfigurationCustomizerProvider distroConfigurationCustomizerProvider() {
+        return new ResourceCustomizerProvider();
+      }
+
+      @Bean
+      public ComponentProvider<Resource> distroComponentProvider() {
+        return new DistroComponentProvider();
+      }
     }
   }
 

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

@@ -0,0 +1,33 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources;
+
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.resources.Resource;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+@SuppressWarnings("rawtypes")
+public class DistroComponentProvider implements ComponentProvider<Resource> {
+
+  @Override
+  public Class<Resource> getType() {
+    return Resource.class;
+  }
+
+  @Override
+  public String getName() {
+    return "opentelemetry-spring-boot-starter";
+  }
+
+  @Override
+  public Resource create(DeclarativeConfigProperties config) {
+    return DistroVersionResourceProvider.get();
+  }
+}

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

@@ -28,6 +28,10 @@ public class DistroVersionResourceProvider implements ResourceProvider {
 
   @Override
   public Resource createResource(ConfigProperties config) {
+    return get();
+  }
+
+  static Resource get() {
     return Resource.create(
         Attributes.of(
             TELEMETRY_DISTRO_NAME,

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

@@ -0,0 +1,63 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.resources;
+
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizer;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectionModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectorModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ResourceModel;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class ResourceCustomizerProvider implements DeclarativeConfigurationCustomizerProvider {
+
+  // opentelemetry-javaagent-distribution: adds "distro.name" and "distro.version" attributes
+  // (DistroComponentProvider in this package)
+  private static final List<String> REQUIRED_DETECTORS =
+      Collections.singletonList("opentelemetry-spring-boot-starter");
+
+  @Override
+  public void customize(DeclarativeConfigurationCustomizer customizer) {
+    customizer.addModelCustomizer(
+        model -> {
+          ResourceModel resource = model.getResource();
+          if (resource == null) {
+            resource = new ResourceModel();
+            model.withResource(resource);
+          }
+          ExperimentalResourceDetectionModel detectionModel = resource.getDetectionDevelopment();
+          if (detectionModel == null) {
+            detectionModel = new ExperimentalResourceDetectionModel();
+            resource.withDetectionDevelopment(detectionModel);
+          }
+          List<ExperimentalResourceDetectorModel> detectors =
+              Objects.requireNonNull(detectionModel.getDetectors());
+          Set<String> names =
+              detectors.stream()
+                  .flatMap(detector -> detector.getAdditionalProperties().keySet().stream())
+                  .collect(Collectors.toSet());
+
+          for (String name : REQUIRED_DETECTORS) {
+            if (!names.contains(name)) {
+              ExperimentalResourceDetectorModel detector = new ExperimentalResourceDetectorModel();
+              detector.getAdditionalProperties().put(name, null);
+              // add first (the least precedence)
+              // so that the user can add a differently named detector that takes precedence
+              detectors.add(0, detector);
+            }
+          }
+          return model;
+        });
+  }
+}

smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java

@@ -5,9 +5,14 @@
 
 package io.opentelemetry.spring.smoketest;
 
+import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
+
 import io.opentelemetry.api.trace.SpanKind;
 import io.opentelemetry.semconv.HttpAttributes;
 import io.opentelemetry.semconv.ServiceAttributes;
+import io.opentelemetry.semconv.incubating.ServiceIncubatingAttributes;
+import io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes;
+import org.assertj.core.api.AbstractCharSequenceAssert;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -54,7 +59,21 @@ void restTemplate() {
                                     ServiceAttributes.SERVICE_NAME,
                                     "declarative-config-spring-boot-2")),
                 span ->
-                    span.hasKind(SpanKind.SERVER).hasAttribute(HttpAttributes.HTTP_ROUTE, "/ping"),
+                    span.hasKind(SpanKind.SERVER)
+                        .hasResourceSatisfying(
+                            r ->
+                                r.hasAttribute(
+                                        TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME,
+                                        "opentelemetry-spring-boot-starter")
+                                    .hasAttribute(
+                                        satisfies(
+                                            TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION,
+                                            AbstractCharSequenceAssert::isNotBlank))
+                                    .hasAttribute(
+                                        satisfies(
+                                            ServiceIncubatingAttributes.SERVICE_INSTANCE_ID,
+                                            AbstractCharSequenceAssert::isNotBlank)))
+                        .hasAttribute(HttpAttributes.HTTP_ROUTE, "/ping"),
                 AbstractSpringStarterSmokeTest::withSpanAssert));
   }
 }

smoke-tests-otel-starter/spring-boot-2/src/testDeclarativeConfig/resources/application.yaml

@@ -2,6 +2,9 @@ otel:
   # "file_format" serves as opt-in to the new file format
   file_format: "1.0-rc.1"
   resource:
+    detection/development:
+      detectors:
+        - service:
     attributes:
       - name: service.name
         value: declarative-config-spring-boot-2