Declarative config: Cloud component providers (open-telemetry#2014)

Author: zeitlinger

aws-resources/build.gradle.kts

@@ -9,6 +9,7 @@ otelJava.moduleName.set("io.opentelemetry.contrib.aws.resource")
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")
+  compileOnly("io.opentelemetry:opentelemetry-api-incubator")
   api("io.opentelemetry:opentelemetry-sdk")
 
   implementation("io.opentelemetry.semconv:opentelemetry-semconv")
@@ -20,6 +21,7 @@ dependencies {
   implementation("com.squareup.okhttp3:okhttp")
 
   testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  testImplementation("io.opentelemetry:opentelemetry-api-incubator")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
 
   testImplementation("com.linecorp.armeria:armeria-junit5")

aws-resources/src/main/java/io/opentelemetry/contrib/aws/resource/internal/AwsResourceDetector.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.aws.resource.internal;
+
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.contrib.aws.resource.BeanstalkResource;
+import io.opentelemetry.contrib.aws.resource.Ec2Resource;
+import io.opentelemetry.contrib.aws.resource.EcsResource;
+import io.opentelemetry.contrib.aws.resource.EksResource;
+import io.opentelemetry.contrib.aws.resource.LambdaResource;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.resources.ResourceBuilder;
+
+public class AwsResourceDetector implements ComponentProvider<Resource> {
+
+  @Override
+  public Class<Resource> getType() {
+    return Resource.class;
+  }
+
+  @Override
+  public String getName() {
+    return "aws";
+  }
+
+  @Override
+  public Resource create(DeclarativeConfigProperties config) {
+    ResourceBuilder builder = Resource.builder();
+    builder.putAll(BeanstalkResource.get());
+    builder.putAll(Ec2Resource.get());
+    builder.putAll(EcsResource.get());
+    builder.putAll(EksResource.get());
+    builder.putAll(LambdaResource.get());
+    return builder.build();
+  }
+}

aws-resources/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider

@@ -0,0 +1 @@
+io.opentelemetry.contrib.aws.resource.internal.AwsResourceDetector

aws-resources/src/test/java/io/opentelemetry/contrib/aws/resource/ResourceComponentProviderTest.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.aws.resource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.common.ComponentLoader;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import org.junit.jupiter.api.Test;
+
+class ResourceComponentProviderTest {
+
+  @Test
+  @SuppressWarnings("rawtypes")
+  void providerIsLoaded() {
+    Iterable<ComponentProvider> providers =
+        ComponentLoader.forClassLoader(ResourceComponentProviderTest.class.getClassLoader())
+            .load(ComponentProvider.class);
+    assertThat(providers).extracting(ComponentProvider::getName).containsExactly("aws");
+  }
+}

azure-resources/build.gradle.kts

@@ -15,6 +15,7 @@ java {
 
 dependencies {
   api("io.opentelemetry:opentelemetry-api")
+  compileOnly("io.opentelemetry:opentelemetry-api-incubator")
   api("io.opentelemetry:opentelemetry-sdk")
 
   implementation("io.opentelemetry.semconv:opentelemetry-semconv")
@@ -26,6 +27,7 @@ dependencies {
 
   testImplementation("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
   testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  testImplementation("io.opentelemetry:opentelemetry-api-incubator")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
 
 //  testImplementation("org.mockito:mockito-core")

azure-resources/src/main/java/io/opentelemetry/contrib/azure/resource/AzureAksResourceProvider.java

@@ -8,7 +8,6 @@
 import static io.opentelemetry.contrib.azure.resource.IncubatingAttributes.CloudPlatformIncubatingValues.AZURE_AKS;
 import static io.opentelemetry.contrib.azure.resource.IncubatingAttributes.K8S_CLUSTER_NAME;
 
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.HashMap;
 import java.util.Map;
@@ -56,12 +55,12 @@ public AzureAksResourceProvider() {
   @Override
   public int order() {
     // run after the fast cloud resource providers that only check environment variables
-    // and before the AKS provider
+    // and before the VM provider
     return 100;
   }
 
   @Override
-  public Resource createResource(ConfigProperties configProperties) {
+  public Resource createResource() {
     if (environment.get(KUBERNETES_SERVICE_HOST) == null) {
       return Resource.empty();
     }

azure-resources/src/main/java/io/opentelemetry/contrib/azure/resource/AzureAppServiceResourceProvider.java

@@ -17,7 +17,6 @@
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.api.internal.StringUtils;
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.HashMap;
 import java.util.Map;
@@ -60,7 +59,7 @@ public AzureAppServiceResourceProvider() {
   }
 
   @Override
-  public Resource createResource(ConfigProperties config) {
+  public Resource createResource() {
     return Resource.create(getAttributes());
   }
 

azure-resources/src/main/java/io/opentelemetry/contrib/azure/resource/AzureContainersResourceProvider.java

@@ -12,7 +12,6 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.HashMap;
 import java.util.Map;
@@ -45,7 +44,7 @@ public AzureContainersResourceProvider() {
   }
 
   @Override
-  public Resource createResource(ConfigProperties config) {
+  public Resource createResource() {
     return Resource.create(getAttributes());
   }
 

azure-resources/src/main/java/io/opentelemetry/contrib/azure/resource/AzureFunctionsResourceProvider.java

@@ -15,7 +15,6 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
-import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.resources.Resource;
 import java.util.HashMap;
 import java.util.Map;
@@ -47,7 +46,7 @@ public AzureFunctionsResourceProvider() {
   }
 
   @Override
-  public Resource createResource(ConfigProperties config) {
+  public Resource createResource() {
     return Resource.create(getAttributes());
   }
 

azure-resources/src/main/java/io/opentelemetry/contrib/azure/resource/AzureResourceDetector.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.azure.resource;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.resources.ResourceBuilder;
+
+public class AzureResourceDetector implements ComponentProvider<Resource> {
+
+  @Override
+  public Class<Resource> getType() {
+    return Resource.class;
+  }
+
+  @Override
+  public String getName() {
+    return "azure";
+  }
+
+  @Override
+  public Resource create(DeclarativeConfigProperties config) {
+    Builder builder = new Builder();
+    builder.add(new AzureFunctionsResourceProvider());
+    builder.add(new AzureAppServiceResourceProvider());
+    builder.add(new AzureContainersResourceProvider());
+    builder.addIfEmpty(new AzureAksResourceProvider());
+    builder.addIfEmpty(new AzureVmResourceProvider());
+    return builder.builder.build();
+  }
+
+  private static class Builder {
+    final ResourceBuilder builder = Resource.builder();
+    int attributesCount = 0;
+
+    private void add(CloudResourceProvider provider) {
+      Attributes attributes = provider.createResource().getAttributes();
+      builder.putAll(attributes);
+      attributesCount += attributes.size();
+    }
+
+    private void addIfEmpty(CloudResourceProvider provider) {
+      if (attributesCount == 0) {
+        add(provider);
+      }
+    }
+  }
+}