add missing declarative config resource providers

Author: zeitlinger

instrumentation/resources/library/build.gradle.kts

@@ -8,12 +8,12 @@ dependencies {
   compileOnly("io.opentelemetry:opentelemetry-api-incubator")
   implementation("io.opentelemetry:opentelemetry-sdk-common")
   implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
+  implementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   implementation("io.opentelemetry.semconv:opentelemetry-semconv")
 
   annotationProcessor("com.google.auto.service:auto-service")
   compileOnly("com.google.auto.service:auto-service-annotations")
   testCompileOnly("com.google.auto.service:auto-service-annotations")
-  testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
 
   testImplementation("org.junit.jupiter:junit-jupiter-api")
 }

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/AttributeResourceProvider.java

@@ -20,6 +20,7 @@
 import java.util.Set;
 import java.util.function.Function;
 import java.util.stream.Collectors;
+import javax.annotation.Nullable;
 
 /**
  * An easier alternative to {@link io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider}, which
@@ -45,7 +46,6 @@ public <T> AttributeBuilder add(AttributeKey<T> key, Function<D, Optional<T>> ge
   }
 
   private Set<AttributeKey<?>> filteredKeys;
-
   private final Map<AttributeKey<Object>, Function<D, Optional<?>>> attributeGetters =
       new HashMap<>();
 
@@ -66,16 +66,25 @@ public final boolean shouldApply(ConfigProperties config, Resource existing) {
 
   @Override
   public final Resource createResource(ConfigProperties config) {
+    return create(filteredKeys);
+  }
+
+  @SuppressWarnings({"unchecked", "rawtypes"})
+  public final Resource createUnconditional() {
+    return create((Set) attributeGetters.keySet());
+  }
+
+  private Resource create(@Nullable Set<AttributeKey<?>> keys) {
+    if (keys == null) {
+      throw new IllegalStateException("shouldApply should be called first");
+    }
     return attributeProvider
         .readData()
         .map(
             data -> {
-              if (filteredKeys == null) {
-                throw new IllegalStateException("shouldApply should be called first");
-              }
               AttributesBuilder builder = Attributes.builder();
               attributeGetters.entrySet().stream()
-                  .filter(e -> filteredKeys.contains(e.getKey()))
+                  .filter(e -> keys.contains(e.getKey()))
                   .forEach(
                       e ->
                           e.getValue()

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/JarServiceNameDetector.java

@@ -46,6 +46,10 @@ private JarServiceNameDetector(Supplier<Optional<Path>> jarPathSupplier) {
 
   @Override
   public Resource createResource(ConfigProperties config) {
+    return create();
+  }
+
+  public Resource create() {
     return jarPathSupplier
         .get()
         .map(

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/internal/JarResourceComponentProvider.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources.internal;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.resources.JarServiceNameDetector;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+
+/**
+ * Declarative config host resource provider.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class JarResourceComponentProvider extends ResourceComponentProvider {
+  public JarResourceComponentProvider() {
+    super("jar", () -> new JarServiceNameDetector().create());
+  }
+}

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/internal/ManifestResourceComponentProvider.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources.internal;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.resources.ManifestResourceProvider;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+
+/**
+ * Declarative config host resource provider.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class ManifestResourceComponentProvider extends ResourceComponentProvider {
+  public ManifestResourceComponentProvider() {
+    super("manifest", () -> new ManifestResourceProvider().createUnconditional());
+  }
+}

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/internal/ResourceCustomizerProvider.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources.internal;
+
+import com.google.auto.service.AutoService;
+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.Arrays;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * Adds essential resource detectors to the resource model in declarative configuration, if they are
+ * not already present.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+@AutoService(DeclarativeConfigurationCustomizerProvider.class)
+public class ResourceCustomizerProvider implements DeclarativeConfigurationCustomizerProvider {
+
+  private static final List<String> NEEDED_DETECTORS = Arrays.asList("distribution", "service");
+
+  @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 : NEEDED_DETECTORS) {
+            if (!names.contains(name)) {
+              ExperimentalResourceDetectorModel detector = new ExperimentalResourceDetectorModel();
+              detector.getAdditionalProperties().put(name, null);
+              detectors.add(detector);
+            }
+          }
+          return model;
+        });
+  }
+}

instrumentation/resources/library/src/test/java/io/opentelemetry/instrumentation/resources/ManifestResourceProviderTest.java

@@ -96,6 +96,12 @@ Collection<DynamicTest> createResource() {
                       assertThat(resource.getAttribute(SERVICE_NAME)).isEqualTo(t.expectedName);
                       assertThat(resource.getAttribute(SERVICE_VERSION))
                           .isEqualTo(t.expectedVersion);
+
+                      if (t.existing.getAttributes().isEmpty()) {
+                        // component provider does not consider existing resource
+                        assertThat(provider.createUnconditional().getAttributes())
+                            .isEqualTo(resource.getAttributes());
+                      }
                     }))
         .collect(Collectors.toList());
   }

instrumentation/resources/library/src/test/java/io/opentelemetry/instrumentation/resources/internal/ResourceCustomizerProviderTest.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources.internal;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import io.opentelemetry.testing.internal.jackson.core.JsonProcessingException;
+import io.opentelemetry.testing.internal.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.Test;
+
+class ResourceCustomizerProviderTest {
+
+  private final ObjectMapper objectMapper = new ObjectMapper();
+
+  @Test
+  void customize() {
+    new ResourceCustomizerProvider()
+        .customize(
+            customizer -> {
+              OpenTelemetryConfigurationModel configurationModel =
+                  customizer.apply(new OpenTelemetryConfigurationModel());
+
+              try {
+                assertThat(objectMapper.writeValueAsString(configurationModel.getResource()))
+                    .isEqualTo(
+                        "{\"attributes\":[],\"detectionDevelopment\":{\"attributes\":null,\"detectors\":["
+                            + "{\"additionalProperties\":{\"distribution\":null}},"
+                            + "{\"additionalProperties\":{\"service\":null}}]},"
+                            + "\"schemaUrl\":null,\"attributesList\":null}");
+              } catch (JsonProcessingException e) {
+                throw new AssertionError(e);
+              }
+            });
+  }
+}

instrumentation/spring/spring-boot-resources/javaagent/src/main/java/io/opentelemetry/instrumentation/spring/resources/SpringBootServiceNameDetector.java

@@ -71,7 +71,10 @@ public SpringBootServiceNameDetector() {
 
   @Override
   public Resource createResource(ConfigProperties config) {
+    return create();
+  }
 
+  Resource create() {
     logger.log(FINER, "Performing Spring Boot service name auto-detection...");
     // Note: The order should be consistent with the order of Spring matching, but noting
     // that we have "first one wins" while Spring has "last one wins".

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

@@ -41,6 +41,10 @@ public SpringBootServiceVersionDetector() {
 
   @Override
   public Resource createResource(ConfigProperties config) {
+    return create();
+  }
+
+  Resource create() {
     return getServiceVersionFromBuildInfo()
         .map(
             version -> {