Add support for resource detectors

Author: jack-berg

sdk-extensions/incubator/build.gradle.kts

@@ -62,7 +62,7 @@ dependencies {
 //  it was needed after 0.3.0 release because file_format in the examples weren't updated prior to the release tag
 // val configurationTag = "0.3.0"
 // val configurationRef = "refs/tags/v$configurationTag" // Replace with commit SHA to point to experiment with a specific commit
-val configurationRef = "8425d9b03344ff96df181b9c46ec57ebdbc185e2"
+val configurationRef = "25da6659f5f214a737ad92a28097418536334518"
 val configurationRepoZip = "https://github.com/open-telemetry/opentelemetry-configuration/archive/$configurationRef.zip"
 val buildDirectory = layout.buildDirectory.asFile.get()
 

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceDetectorFactory.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.sdk.extension.incubator.fileconfig;
+
+import static java.util.stream.Collectors.joining;
+
+import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
+import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectorModel;
+import io.opentelemetry.sdk.resources.Resource;
+import java.io.Closeable;
+import java.util.List;
+import java.util.Map;
+
+final class ResourceDetectorFactory
+    implements Factory<ExperimentalResourceDetectorModel, Resource> {
+
+  private static final ResourceDetectorFactory INSTANCE = new ResourceDetectorFactory();
+
+  private ResourceDetectorFactory() {}
+
+  static ResourceDetectorFactory getInstance() {
+    return INSTANCE;
+  }
+
+  @Override
+  public Resource create(
+      ExperimentalResourceDetectorModel model, SpiHelper spiHelper, List<Closeable> closeables) {
+    Map<String, Object> additionalProperties = model.getAdditionalProperties();
+    if (!additionalProperties.isEmpty()) {
+      if (additionalProperties.size() > 1) {
+        throw new DeclarativeConfigException(
+            "Invalid configuration - multiple resource detectors set: "
+                + additionalProperties.keySet().stream().collect(joining(",", "[", "]")));
+      }
+      Map.Entry<String, Object> detectorKeyValue =
+          additionalProperties.entrySet().stream()
+              .findFirst()
+              .orElseThrow(
+                  () ->
+                      new IllegalStateException("Missing detector. This is a programming error."));
+      Resource resource =
+          FileConfigUtil.loadComponent(
+              spiHelper, Resource.class, detectorKeyValue.getKey(), detectorKeyValue.getValue());
+      return resource;
+    } else {
+      throw new DeclarativeConfigException("resource detector must be set");
+    }
+  }
+}

sdk-extensions/incubator/src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactory.java

@@ -7,26 +7,21 @@
 
 import static io.opentelemetry.sdk.internal.GlobUtil.toGlobPatternPredicate;
 
-import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
-import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.autoconfigure.ResourceConfiguration;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
-import io.opentelemetry.sdk.autoconfigure.spi.Ordered;
-import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AttributeNameValueModel;
-import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalDetectorsModel;
+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.IncludeExcludeModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ResourceModel;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.resources.ResourceBuilder;
 import java.io.Closeable;
-import java.util.ArrayList;
 import java.util.Collections;
-import java.util.Comparator;
 import java.util.List;
 import java.util.function.Predicate;
-import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
 final class ResourceFactory implements Factory<ResourceModel, Resource> {
@@ -43,19 +38,27 @@ static ResourceFactory getInstance() {
   public Resource create(ResourceModel model, SpiHelper spiHelper, List<Closeable> closeables) {
     ResourceBuilder builder = Resource.getDefault().toBuilder();
 
-    ResourceBuilder detectedResourceBuilder = Resource.builder();
-    List<Resource> resourceDetectorResources = loadFromResourceDetectors(spiHelper);
-    for (Resource resourceProviderResource : resourceDetectorResources) {
-      detectedResourceBuilder.putAll(resourceProviderResource);
+    ExperimentalResourceDetectionModel detectionModel = model.getDetectionDevelopment();
+    if (detectionModel != null) {
+      ResourceBuilder detectedResourceBuilder = Resource.builder();
+
+      List<ExperimentalResourceDetectorModel> detectorModels = detectionModel.getDetectors();
+      if (detectorModels != null) {
+        for (ExperimentalResourceDetectorModel detectorModel : detectorModels) {
+          detectedResourceBuilder.putAll(
+              ResourceDetectorFactory.getInstance().create(detectorModel, spiHelper, closeables));
+        }
+      }
+
+      Predicate<String> detectorAttributeFilter =
+          detectorAttributeFilter(detectionModel.getAttributes());
+      Attributes filteredDetectedAttributes =
+          detectedResourceBuilder.build().getAttributes().toBuilder()
+              .removeIf(attributeKey -> !detectorAttributeFilter.test(attributeKey.getKey()))
+              .build();
+
+      builder.putAll(filteredDetectedAttributes);
     }
-    Predicate<String> detectorAttributeFilter =
-        detectorAttributeFilter(model.getDetectorsDevelopment());
-    builder
-        .putAll(
-            detectedResourceBuilder.build().getAttributes().toBuilder()
-                .removeIf(attributeKey -> !detectorAttributeFilter.test(attributeKey.getKey()))
-                .build())
-        .build();
 
     String attributeList = model.getAttributesList();
     if (attributeList != null) {
@@ -77,72 +80,12 @@ public Resource create(ResourceModel model, SpiHelper spiHelper, List<Closeable>
     return builder.build();
   }
 
-  /**
-   * Load resources from resource detectors, in order of lowest priority to highest priority.
-   *
-   * <p>In declarative configuration, a resource detector is a {@link ComponentProvider} with {@link
-   * ComponentProvider#getType()} set to {@link Resource}. Unlike other {@link ComponentProvider}s,
-   * the resource detector version does not use {@link ComponentProvider#getName()} (except for
-   * debug messages), and {@link ComponentProvider#create(DeclarativeConfigProperties)} is called
-   * with an empty instance. Additionally, the {@link Ordered#order()} value is respected for
-   * resource detectors which implement {@link Ordered}.
-   */
-  @SuppressWarnings("rawtypes")
-  private static List<Resource> loadFromResourceDetectors(SpiHelper spiHelper) {
-    List<ComponentProvider> componentProviders = spiHelper.load(ComponentProvider.class);
-    List<ResourceAndOrder> resourceAndOrders = new ArrayList<>();
-    for (ComponentProvider<?> componentProvider : componentProviders) {
-      if (componentProvider.getType() != Resource.class) {
-        continue;
-      }
-      Resource resource;
-      try {
-        resource = (Resource) componentProvider.create(DeclarativeConfigProperties.empty());
-      } catch (Throwable throwable) {
-        throw new DeclarativeConfigException(
-            "Error configuring "
-                + Resource.class.getName()
-                + " with name \""
-                + componentProvider.getName()
-                + "\"",
-            throwable);
-      }
-      int order =
-          (componentProvider instanceof Ordered) ? ((Ordered) componentProvider).order() : 0;
-      resourceAndOrders.add(new ResourceAndOrder(resource, order));
-    }
-    resourceAndOrders.sort(Comparator.comparing(ResourceAndOrder::order));
-    return resourceAndOrders.stream().map(ResourceAndOrder::resource).collect(Collectors.toList());
-  }
-
-  private static final class ResourceAndOrder {
-    private final Resource resource;
-    private final int order;
-
-    private ResourceAndOrder(Resource resource, int order) {
-      this.resource = resource;
-      this.order = order;
-    }
-
-    private Resource resource() {
-      return resource;
-    }
-
-    private int order() {
-      return order;
-    }
-  }
-
   private static boolean matchAll(String attributeKey) {
     return true;
   }
 
   private static Predicate<String> detectorAttributeFilter(
-      @Nullable ExperimentalDetectorsModel detectorsModel) {
-    if (detectorsModel == null) {
-      return ResourceFactory::matchAll;
-    }
-    IncludeExcludeModel includedExcludeModel = detectorsModel.getAttributes();
+      @Nullable IncludeExcludeModel includedExcludeModel) {
     if (includedExcludeModel == null) {
       return ResourceFactory::matchAll;
     }

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java

@@ -176,9 +176,7 @@ void create_ModelCustomizer() {
             "resource=Resource{schemaUrl=null, attributes={"
                 + "color=\"blue\", "
                 + "foo=\"bar\", "
-                + "order=\"second\", "
                 + "service.name=\"unknown_service:java\", "
-                + "shape=\"square\", "
                 + "telemetry.sdk.language=\"java\", "
                 + "telemetry.sdk.name=\"opentelemetry\", "
                 + "telemetry.sdk.version=\"");

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationParseTest.java

@@ -18,12 +18,12 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchSpanProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ClientModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ConsoleExporterModel;
-import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalDetectorsModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalGeneralInstrumentationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalHttpInstrumentationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalPeerInstrumentationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalPrometheusMetricExporterModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectionModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExplicitBucketHistogramAggregationModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.IncludeExcludeModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.InstrumentationModel;
@@ -137,8 +137,8 @@ void parse_KitchenSinkExampleFile() throws IOException {
                         .withValue(Arrays.asList(1.1, 2.2))
                         .withType(AttributeNameValueModel.AttributeType.DOUBLE_ARRAY)))
             .withAttributesList("service.namespace=my-namespace,service.version=1.0.0")
-            .withDetectorsDevelopment(
-                new ExperimentalDetectorsModel()
+            .withDetectionDevelopment(
+                new ExperimentalResourceDetectionModel()
                     .withAttributes(
                         new IncludeExcludeModel()
                             .withIncluded(Collections.singletonList("process.*"))

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java

@@ -27,6 +27,8 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AttributeNameValueModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchLogRecordProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchSpanProcessorModel;
+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.LogRecordExporterModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LogRecordLimitsModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LogRecordProcessorModel;
@@ -215,6 +217,16 @@ void create_Configured() {
                             .withCompositeList("tracecontext,baggage,ottrace,b3multi,b3,jaeger"))
                     .withResource(
                         new ResourceModel()
+                            .withDetectionDevelopment(
+                                new ExperimentalResourceDetectionModel()
+                                    .withDetectors(
+                                        Arrays.asList(
+                                            new ExperimentalResourceDetectorModel()
+                                                .withAdditionalProperty("order_first", null),
+                                            new ExperimentalResourceDetectorModel()
+                                                .withAdditionalProperty("order_second", null),
+                                            new ExperimentalResourceDetectorModel()
+                                                .withAdditionalProperty("shape_color", null))))
                             .withAttributes(
                                 Arrays.asList(
                                     new AttributeNameValueModel()

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/ResourceFactoryTest.java

@@ -10,7 +10,8 @@
 
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.AttributeNameValueModel;
-import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalDetectorsModel;
+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.IncludeExcludeModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ResourceModel;
 import io.opentelemetry.sdk.resources.Resource;
@@ -48,14 +49,9 @@ void create() {
                     Collections.emptyList()))
         .isEqualTo(
             Resource.getDefault().toBuilder()
+                .put("shape", "circle")
                 .put("service.name", "my-service")
                 .put("key", "val")
-                .put("shape", "circle")
-                // From ResourceComponentProvider
-                .put("color", "red")
-                // From ResourceOrderedSecondComponentProvider, which takes priority over
-                // ResourceOrderedFirstComponentProvider
-                .put("order", "second")
                 .build());
   }
 
@@ -65,8 +61,16 @@ void createWithDetectors(
       @Nullable List<String> included, @Nullable List<String> excluded, Resource expectedResource) {
     ResourceModel resourceModel =
         new ResourceModel()
-            .withDetectorsDevelopment(
-                new ExperimentalDetectorsModel()
+            .withDetectionDevelopment(
+                new ExperimentalResourceDetectionModel()
+                    .withDetectors(
+                        Arrays.asList(
+                            new ExperimentalResourceDetectorModel()
+                                .withAdditionalProperty("order_first", null),
+                            new ExperimentalResourceDetectorModel()
+                                .withAdditionalProperty("order_second", null),
+                            new ExperimentalResourceDetectorModel()
+                                .withAdditionalProperty("shape_color", null)))
                     .withAttributes(
                         new IncludeExcludeModel().withIncluded(included).withExcluded(excluded)));
     Resource resource =

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/TestDeclarativeConfigurationCustomizerProvider.java

@@ -29,12 +29,12 @@ public void customize(DeclarativeConfigurationCustomizer customizer) {
           attributes.add(
               new AttributeNameValueModel()
                   .withName("foo")
-                  .withType(AttributeNameValueModel.Type.STRING)
+                  .withType(AttributeNameValueModel.AttributeType.STRING)
                   .withValue("bar"));
           attributes.add(
               new AttributeNameValueModel()
                   .withName("color")
-                  .withType(AttributeNameValueModel.Type.STRING)
+                  .withType(AttributeNameValueModel.AttributeType.STRING)
                   .withValue("blue"));
           return model;
         });

sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/component/ResourceComponentProvider.java

@@ -17,7 +17,7 @@ public Class<Resource> getType() {
 
   @Override
   public String getName() {
-    return "unused";
+    return "shape_color";
   }
 
   @Override

…sourceOrderedFirstComponentProvider.java …nent/ResourceFirstComponentProvider.javasdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/component/ResourceOrderedFirstComponentProvider.java renamed to sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/component/ResourceFirstComponentProvider.java sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/component/ResourceOrderedFirstComponentProvider.java renamed to sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/component/ResourceFirstComponentProvider.java

@@ -6,28 +6,22 @@
 package io.opentelemetry.sdk.extension.incubator.fileconfig.component;
 
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
-import io.opentelemetry.sdk.autoconfigure.spi.Ordered;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
 import io.opentelemetry.sdk.resources.Resource;
 
-public class ResourceOrderedFirstComponentProvider implements ComponentProvider<Resource>, Ordered {
+public class ResourceFirstComponentProvider implements ComponentProvider<Resource> {
   @Override
   public Class<Resource> getType() {
     return Resource.class;
   }
 
   @Override
   public String getName() {
-    return "unused";
+    return "order_first";
   }
 
   @Override
   public Resource create(DeclarativeConfigProperties config) {
     return Resource.builder().put("order", "first").build();
   }
-
-  @Override
-  public int order() {
-    return 1;
-  }
 }