add missing declarative config resource providers (#14222)

Co-authored-by: otelbot <[email protected]>

Author: zeitlinger

instrumentation/resources/library/build.gradle.kts

@@ -8,6 +8,7 @@ dependencies {
   compileOnly("io.opentelemetry:opentelemetry-api-incubator")
   implementation("io.opentelemetry:opentelemetry-sdk-common")
   implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
+  compileOnly("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   implementation("io.opentelemetry.semconv:opentelemetry-semconv")
 
   annotationProcessor("com.google.auto.service:auto-service")

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

@@ -45,7 +45,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<>();
 

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

@@ -5,57 +5,25 @@
 
 package io.opentelemetry.instrumentation.resources;
 
-import static java.util.logging.Level.FINE;
-
 import com.google.auto.service.AutoService;
-import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.instrumentation.resources.internal.JarServiceNameResourceExtractor;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.ConditionalResourceProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.semconv.ServiceAttributes;
-import java.nio.file.Path;
 import java.util.Map;
-import java.util.Optional;
-import java.util.function.Supplier;
-import java.util.logging.Logger;
 
 /**
- * A {@link ResourceProvider} that will attempt to detect the application name from the jar name.
+ * A {@link ResourceProvider} that will attempt to detect the <code>service.name</code> from the
+ * main jar file name.
  */
 @AutoService(ResourceProvider.class)
 public final class JarServiceNameDetector implements ConditionalResourceProvider {
 
-  private static final Logger logger = Logger.getLogger(JarServiceNameDetector.class.getName());
-
-  private final Supplier<Optional<Path>> jarPathSupplier;
-
-  @SuppressWarnings("unused") // SPI
-  public JarServiceNameDetector() {
-    this(MainJarPathHolder::getJarPath);
-  }
-
-  private JarServiceNameDetector(Supplier<Optional<Path>> jarPathSupplier) {
-    this.jarPathSupplier = jarPathSupplier;
-  }
-
-  // visible for tests
-  JarServiceNameDetector(MainJarPathFinder jarPathFinder) {
-    this(() -> Optional.ofNullable(jarPathFinder.detectJarPath()));
-  }
-
   @Override
   public Resource createResource(ConfigProperties config) {
-    return jarPathSupplier
-        .get()
-        .map(
-            jarPath -> {
-              String serviceName = getServiceName(jarPath);
-              logger.log(
-                  FINE, "Auto-detected service name from the jar file name: {0}", serviceName);
-              return Resource.create(Attributes.of(ServiceAttributes.SERVICE_NAME, serviceName));
-            })
-        .orElseGet(Resource::empty);
+    return new JarServiceNameResourceExtractor().extract();
   }
 
   @Override
@@ -67,12 +35,6 @@ public boolean shouldApply(ConfigProperties config, Resource existing) {
         && "unknown_service:java".equals(existing.getAttribute(ServiceAttributes.SERVICE_NAME));
   }
 
-  private static String getServiceName(Path jarPath) {
-    String jarName = jarPath.getFileName().toString();
-    int dotIndex = jarName.lastIndexOf(".");
-    return dotIndex == -1 ? jarName : jarName.substring(0, dotIndex);
-  }
-
   @Override
   public int order() {
     // make it run later than the SpringBootServiceNameDetector

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

@@ -5,79 +5,48 @@
 
 package io.opentelemetry.instrumentation.resources;
 
-import static java.util.logging.Level.FINE;
-
 import com.google.auto.service.AutoService;
+import io.opentelemetry.instrumentation.resources.internal.ManifestResourceExtractor;
 import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
+import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.semconv.ServiceAttributes;
-import java.io.IOException;
-import java.nio.file.Path;
 import java.util.Optional;
-import java.util.function.Function;
 import java.util.function.Supplier;
-import java.util.jar.JarFile;
-import java.util.jar.Manifest;
-import java.util.logging.Logger;
 
 /**
  * A {@link ResourceProvider} that will attempt to detect the <code>service.name</code> and <code>
  * service.version</code> from META-INF/MANIFEST.MF.
  */
 @AutoService(ResourceProvider.class)
-public final class ManifestResourceProvider extends AttributeResourceProvider<Manifest> {
-
-  private static final Logger logger = Logger.getLogger(ManifestResourceProvider.class.getName());
+public final class ManifestResourceProvider extends AttributeResourceProvider<Resource> {
 
   @SuppressWarnings("unused") // SPI
   public ManifestResourceProvider() {
-    this(MainJarPathHolder::getJarPath, ManifestResourceProvider::readManifest);
+    this(() -> new ManifestResourceExtractor().extract());
   }
 
-  private ManifestResourceProvider(
-      Supplier<Optional<Path>> jarPathSupplier, Function<Path, Optional<Manifest>> manifestReader) {
+  // Visible for testing
+  ManifestResourceProvider(Supplier<Resource> resourceSupplier) {
     super(
-        new AttributeProvider<Manifest>() {
+        new AttributeProvider<Resource>() {
           @Override
-          public Optional<Manifest> readData() {
-            return jarPathSupplier.get().flatMap(manifestReader);
+          public Optional<Resource> readData() {
+            return Optional.of(resourceSupplier.get());
           }
 
           @Override
-          public void registerAttributes(Builder<Manifest> builder) {
+          public void registerAttributes(Builder<Resource> builder) {
             builder
                 .add(
                     ServiceAttributes.SERVICE_NAME,
-                    manifest -> {
-                      String serviceName =
-                          manifest.getMainAttributes().getValue("Implementation-Title");
-                      return Optional.ofNullable(serviceName);
-                    })
+                    r -> Optional.ofNullable(r.getAttribute(ServiceAttributes.SERVICE_NAME)))
                 .add(
                     ServiceAttributes.SERVICE_VERSION,
-                    manifest -> {
-                      String serviceVersion =
-                          manifest.getMainAttributes().getValue("Implementation-Version");
-                      return Optional.ofNullable(serviceVersion);
-                    });
+                    r -> Optional.ofNullable(r.getAttribute(ServiceAttributes.SERVICE_VERSION)));
           }
         });
   }
 
-  // Visible for testing
-  ManifestResourceProvider(
-      MainJarPathFinder jarPathFinder, Function<Path, Optional<Manifest>> manifestReader) {
-    this(() -> Optional.ofNullable(jarPathFinder.detectJarPath()), manifestReader);
-  }
-
-  private static Optional<Manifest> readManifest(Path jarPath) {
-    try (JarFile jarFile = new JarFile(jarPath.toFile(), false)) {
-      return Optional.of(jarFile.getManifest());
-    } catch (IOException exception) {
-      logger.log(FINE, "Error reading manifest", exception);
-      return Optional.empty();
-    }
-  }
-
   @Override
   public int order() {
     // make it run later than SpringBootServiceNameDetector

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

@@ -8,6 +8,7 @@
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.instrumentation.resources.internal.ProcessArguments;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.semconv.SchemaUrls;
 import java.io.File;

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

@@ -19,6 +19,6 @@
 @AutoService(ComponentProvider.class)
 public class ContainerResourceComponentProvider extends ResourceComponentProvider {
   public ContainerResourceComponentProvider() {
-    super("container", ContainerResource::get);
+    super("container", p -> ContainerResource.get());
   }
 }

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

@@ -21,6 +21,6 @@
 @AutoService(ComponentProvider.class)
 public class HostResourceComponentProvider extends ResourceComponentProvider {
   public HostResourceComponentProvider() {
-    super("host", () -> HostResource.get().merge(HostIdResource.get()).merge(OsResource.get()));
+    super("host", p -> HostResource.get().merge(HostIdResource.get()).merge(OsResource.get()));
   }
 }

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

@@ -0,0 +1,23 @@
+/*
+ * 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.autoconfigure.spi.internal.ComponentProvider;
+
+/**
+ * Declarative config jar 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", p -> new JarServiceNameResourceExtractor().extract());
+  }
+}

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

@@ -0,0 +1,63 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources.internal;
+
+import static java.util.logging.Level.FINE;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.semconv.ServiceAttributes;
+import java.nio.file.Path;
+import java.util.Optional;
+import java.util.function.Supplier;
+import java.util.logging.Logger;
+
+/**
+ * A resource extractor that will attempt to detect the <code>service.name</code> from the main jar
+ * file name.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
+ */
+public final class JarServiceNameResourceExtractor {
+
+  private static final Logger logger =
+      Logger.getLogger(JarServiceNameResourceExtractor.class.getName());
+
+  private final Supplier<Optional<Path>> jarPathSupplier;
+
+  public JarServiceNameResourceExtractor() {
+    this(MainJarPathHolder::getJarPath);
+  }
+
+  // visible for tests
+  JarServiceNameResourceExtractor(MainJarPathFinder jarPathFinder) {
+    this(() -> Optional.ofNullable(jarPathFinder.detectJarPath()));
+  }
+
+  private JarServiceNameResourceExtractor(Supplier<Optional<Path>> jarPathSupplier) {
+    this.jarPathSupplier = jarPathSupplier;
+  }
+
+  public Resource extract() {
+    return jarPathSupplier
+        .get()
+        .map(
+            jarPath -> {
+              String serviceName = getServiceName(jarPath);
+              logger.log(
+                  FINE, "Auto-detected service name from the jar file name: {0}", serviceName);
+              return Resource.create(Attributes.of(ServiceAttributes.SERVICE_NAME, serviceName));
+            })
+        .orElseGet(Resource::empty);
+  }
+
+  private static String getServiceName(Path jarPath) {
+    String jarName = jarPath.getFileName().toString();
+    int dotIndex = jarName.lastIndexOf(".");
+    return dotIndex == -1 ? jarName : jarName.substring(0, dotIndex);
+  }
+}