declarative config: gcp auth, span stacktrace

gcp-auth-extension/build.gradle.kts

@@ -21,6 +21,8 @@ dependencies {
   compileOnly("com.google.auto.service:auto-service-annotations")
   compileOnly("io.opentelemetry:opentelemetry-api")
   compileOnly("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  compileOnly("io.opentelemetry:opentelemetry-sdk-extension-incubator")
+  compileOnly("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api-incubator")
   compileOnly("io.opentelemetry:opentelemetry-exporter-otlp")
 
   // Only dependencies added to `implementation` configuration will be picked up by Shadow plugin
@@ -36,7 +38,9 @@ dependencies {
   testImplementation("io.opentelemetry:opentelemetry-exporter-otlp")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
   testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   testImplementation("io.opentelemetry.instrumentation:opentelemetry-instrumentation-annotations")
+  testImplementation("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api-incubator")
 
   testImplementation("org.awaitility:awaitility")
   testImplementation("org.mockito:mockito-inline")
@@ -130,3 +134,11 @@ tasks.register<Test>("IntegrationTestUserCreds") {
     "-Dmockserver.logLevel=trace"
   )
 }
+
+// todo remove when https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/14497 is merged
+configurations.all {
+  resolutionStrategy {
+    force("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api-incubator:2.20.0-alpha-SNAPSHOT")
+    force("io.opentelemetry.instrumentation:opentelemetry-instrumentation-api:2.19.0")
+  }
+}

gcp-auth-extension/src/main/java/io/opentelemetry/contrib/gcp/auth/ConfigurableOption.java

@@ -8,8 +8,8 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
 import java.util.Locale;
-import java.util.Optional;
-import java.util.function.Supplier;
+import java.util.function.BiFunction;
+import javax.annotation.Nullable;
 
 /**
  * An enum representing configurable options for a GCP Authentication Extension. Each option has a
@@ -92,57 +92,41 @@ String getUserReadableName() {
   }
 
   /**
-   * Retrieves the configured value for this option. This method checks the environment variable
-   * first and then the system property.
+   * Retrieves the configured value for this option.
    *
    * @return The configured value as a string, or throws an exception if not configured.
    * @throws ConfigurationException if neither the environment variable nor the system property is
    *     set.
    */
-  String getConfiguredValue(ConfigProperties configProperties) {
-    String configuredValue = configProperties.getString(this.getSystemProperty());
-    if (configuredValue != null && !configuredValue.isEmpty()) {
-      return configuredValue;
-    } else {
+  <T> T getRequiredConfiguredValue(
+      ConfigProperties configProperties, BiFunction<ConfigProperties, String, T> extractor) {
+    T configuredValue = getConfiguredValue(configProperties, extractor);
+    if (configuredValue == null) {
       throw new ConfigurationException(
           String.format(
-              "GCP Authentication Extension not configured properly: %s not configured. Configure it by exporting environment variable %s or system property %s",
+              "GCP Authentication Extension not configured properly: %s not configured. "
+                  + "Configure it by exporting environment variable %s or system property %s",
               this.userReadableName, this.getEnvironmentVariable(), this.getSystemProperty()));
     }
+    return configuredValue;
   }
 
   /**
-   * Retrieves the value for this option, prioritizing environment variables and system properties.
-   * If neither an environment variable nor a system property is set for this option, the provided
-   * fallback function is used to determine the value.
+   * Retrieves the configured value for this option.
    *
-   * @param fallback A {@link Supplier} that provides the default value for the option when it is
-   *     not explicitly configured via an environment variable or system property.
-   * @return The configured value for the option, obtained from the environment variable, system
-   *     property, or the fallback function, in that order of precedence.
+   * @return The configured value as a string, or {@code null} if not configured.
    */
-  String getConfiguredValueWithFallback(
-      ConfigProperties configProperties, Supplier<String> fallback) {
-    try {
-      return this.getConfiguredValue(configProperties);
-    } catch (ConfigurationException e) {
-      return fallback.get();
+  @Nullable
+  <T> T getConfiguredValue(
+      ConfigProperties configProperties, BiFunction<ConfigProperties, String, T> extractor) {
+    T configuredValue = extractor.apply(configProperties, this.getSystemProperty());
+    if (configuredValue instanceof String) {
+      String value = (String) configuredValue;
+      if (value.isEmpty()) {
+        configuredValue = null; // Treat empty string as not configured
+      }
     }
-  }
 
-  /**
-   * Retrieves the value for this option, prioritizing environment variables before system
-   * properties. If neither an environment variable nor a system property is set for this option,
-   * then an empty {@link Optional} is returned.
-   *
-   * @return The configured value for the option, if set, obtained from the environment variable,
-   *     system property, or empty {@link Optional}, in that order of precedence.
-   */
-  Optional<String> getConfiguredValueAsOptional(ConfigProperties configProperties) {
-    try {
-      return Optional.of(this.getConfiguredValue(configProperties));
-    } catch (ConfigurationException e) {
-      return Optional.empty();
-    }
+    return configuredValue;
   }
 }

gcp-auth-extension/src/main/java/io/opentelemetry/contrib/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java

@@ -7,6 +7,7 @@
 
 import com.google.auth.oauth2.GoogleCredentials;
 import com.google.auto.service.AutoService;
+import com.google.common.annotations.VisibleForTesting;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.contrib.gcp.auth.GoogleAuthException.Reason;
@@ -25,7 +26,7 @@
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import java.io.IOException;
-import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -84,8 +85,8 @@ public class GcpAuthAutoConfigurationCustomizerProvider
    *       customizes only the signal specific exporter.
    * </ul>
    *
-   * The 'customization' performed includes customizing the exporters by adding required headers to
-   * the export calls made and customizing the resource by adding required resource attributes to
+   * <p>The 'customization' performed includes customizing the exporters by adding required headers
+   * to the export calls made and customizing the resource by adding required resource attributes to
    * enable GCP integration.
    *
    * @param autoConfiguration the AutoConfigurationCustomizer to customize.
@@ -96,12 +97,7 @@ public class GcpAuthAutoConfigurationCustomizerProvider
    */
   @Override
   public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
-    GoogleCredentials credentials;
-    try {
-      credentials = GoogleCredentials.getApplicationDefault();
-    } catch (IOException e) {
-      throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
-    }
+    GoogleCredentials credentials = getCredentials();
     autoConfiguration
         .addSpanExporterCustomizer(
             (spanExporter, configProperties) ->
@@ -112,51 +108,80 @@ public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
         .addResourceCustomizer(GcpAuthAutoConfigurationCustomizerProvider::customizeResource);
   }
 
+  static GoogleCredentials getCredentials() {
+    GoogleCredentials credentials;
+    try {
+      credentials = GoogleCredentials.getApplicationDefault();
+    } catch (IOException e) {
+      throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+    }
+    return credentials;
+  }
+
   @Override
   public int order() {
     return Integer.MAX_VALUE - 1;
   }
 
   private static SpanExporter customizeSpanExporter(
       SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
-    if (isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)) {
+    if (shouldCustomizeExporter(
+        SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
       return addAuthorizationHeaders(exporter, credentials, configProperties);
-    } else {
-      String[] params = {SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
-      logger.log(
-          Level.WARNING,
-          "GCP Authentication Extension is not configured for signal type: {0}. {1}",
-          params);
     }
     return exporter;
   }
 
   private static MetricExporter customizeMetricExporter(
       MetricExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
-    if (isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties)) {
+    if (shouldCustomizeExporter(
+        SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
       return addAuthorizationHeaders(exporter, credentials, configProperties);
+    }
+    return exporter;
+  }
+
+  /**
+   * Utility method to check whether OTLP exporters should be customized for the given target
+   * signal.
+   *
+   * @param signal The target signal to check against. Could be one of {@value SIGNAL_TYPE_TRACES},
+   *     {@value SIGNAL_TYPE_METRICS} or {@value SIGNAL_TYPE_ALL}.
+   * @param fixSuggestion A warning to alert the user that auth extension is not configured for the
+   *     provided target signal.
+   * @param configProperties The {@link ConfigProperties} object used to configure the extension.
+   * @return A boolean indicating whether the OTLP exporters should be customized or not.
+   */
+  static boolean shouldCustomizeExporter(
+      String signal, String fixSuggestion, ConfigProperties configProperties) {
+    if (isSignalTargeted(signal, configProperties)) {
+      return true;
     } else {
-      String[] params = {SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION};
       logger.log(
           Level.WARNING,
           "GCP Authentication Extension is not configured for signal type: {0}. {1}",
-          params);
+          new String[] {signal, fixSuggestion});
+      return false;
     }
-    return exporter;
   }
 
   // Checks if the auth extension is configured to target the passed signal for authentication.
   private static boolean isSignalTargeted(String checkSignal, ConfigProperties configProperties) {
-    String userSpecifiedTargetedSignals =
-        ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getConfiguredValueWithFallback(
-            configProperties, () -> SIGNAL_TYPE_ALL);
-    return Arrays.stream(userSpecifiedTargetedSignals.split(","))
-        .map(String::trim)
+    return targetSignals(configProperties).stream()
         .anyMatch(
             targetedSignal ->
                 targetedSignal.equals(checkSignal) || targetedSignal.equals(SIGNAL_TYPE_ALL));
   }
 
+  @VisibleForTesting
+  static List<String> targetSignals(ConfigProperties configProperties) {
+    return Objects.requireNonNull(
+        ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getConfiguredValue(
+            configProperties,
+            (properties, name) ->
+                properties.getList(name, Collections.singletonList(SIGNAL_TYPE_ALL))));
+  }
+
   // Adds authorization headers to the calls made by the OtlpGrpcSpanExporter and
   // OtlpHttpSpanExporter.
   private static SpanExporter addAuthorizationHeaders(
@@ -193,7 +218,7 @@ private static MetricExporter addAuthorizationHeaders(
     return exporter;
   }
 
-  private static Map<String, String> getRequiredHeaderMap(
+  static Map<String, String> getRequiredHeaderMap(
       GoogleCredentials credentials, ConfigProperties configProperties) {
     Map<String, List<String>> gcpHeaders;
     try {
@@ -216,23 +241,31 @@ private static Map<String, String> getRequiredHeaderMap(
     // Add quota user project header if not detected by the auth library and user provided it via
     // system properties.
     if (!flattenedHeaders.containsKey(QUOTA_USER_PROJECT_HEADER)) {
-      Optional<String> maybeConfiguredQuotaProjectId =
-          ConfigurableOption.GOOGLE_CLOUD_QUOTA_PROJECT.getConfiguredValueAsOptional(
-              configProperties);
-      maybeConfiguredQuotaProjectId.ifPresent(
-          configuredQuotaProjectId ->
-              flattenedHeaders.put(QUOTA_USER_PROJECT_HEADER, configuredQuotaProjectId));
+      getQuotaProjectId(configProperties)
+          .ifPresent(
+              configuredQuotaProjectId ->
+                  flattenedHeaders.put(QUOTA_USER_PROJECT_HEADER, configuredQuotaProjectId));
     }
     return flattenedHeaders;
   }
 
+  static Optional<String> getQuotaProjectId(ConfigProperties configProperties) {
+    return Optional.ofNullable(
+        ConfigurableOption.GOOGLE_CLOUD_QUOTA_PROJECT.getConfiguredValue(
+            configProperties, ConfigProperties::getString));
+  }
+
   // Updates the current resource with the attributes required for ingesting OTLP data on GCP.
   private static Resource customizeResource(Resource resource, ConfigProperties configProperties) {
-    String gcpProjectId =
-        ConfigurableOption.GOOGLE_CLOUD_PROJECT.getConfiguredValue(configProperties);
     Resource res =
         Resource.create(
-            Attributes.of(AttributeKey.stringKey(GCP_USER_PROJECT_ID_KEY), gcpProjectId));
+            Attributes.of(
+                AttributeKey.stringKey(GCP_USER_PROJECT_ID_KEY), getProjectId(configProperties)));
     return resource.merge(res);
   }
+
+  static String getProjectId(ConfigProperties configProperties) {
+    return ConfigurableOption.GOOGLE_CLOUD_PROJECT.getRequiredConfiguredValue(
+        configProperties, ConfigProperties::getString);
+  }
 }