remove

Author: zeitlinger

gcp-auth-extension/build.gradle.kts

@@ -21,8 +21,6 @@ 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
@@ -38,9 +36,7 @@ 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")
@@ -137,11 +133,3 @@ 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

@@ -9,8 +9,8 @@
 
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
-import java.util.function.BiFunction;
-import javax.annotation.Nullable;
+import java.util.Optional;
+import java.util.function.Supplier;
 
 /**
  * An enum representing configurable options for a GCP Authentication Extension. Each option has a
@@ -92,41 +92,57 @@ String getUserReadableName() {
   }
 
   /**
-   * Retrieves the configured value for this option.
+   * Retrieves the configured value for this option. This method checks the environment variable
+   * first and then the system property.
    *
    * @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.
    */
-  <T> T getRequiredConfiguredValue(
-      ConfigProperties configProperties, BiFunction<ConfigProperties, String, T> extractor) {
-    T configuredValue = getConfiguredValue(configProperties, extractor);
-    if (configuredValue == null) {
+  String getConfiguredValue(ConfigProperties configProperties) {
+    String configuredValue = configProperties.getString(this.getSystemProperty());
+    if (configuredValue != null && !configuredValue.isEmpty()) {
+      return configuredValue;
+    } else {
       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 configured value for this option.
+   * 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.
    *
-   * @return The configured value as a string, or {@code null} if not configured.
+   * @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.
    */
-  @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
-      }
+  String getConfiguredValueWithFallback(
+      ConfigProperties configProperties, Supplier<String> fallback) {
+    try {
+      return this.getConfiguredValue(configProperties);
+    } catch (ConfigurationException e) {
+      return fallback.get();
     }
+  }
 
-    return configuredValue;
+  /**
+   * 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();
+    }
   }
 }

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

@@ -12,8 +12,6 @@
 
 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;
 import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
@@ -31,7 +29,6 @@
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 import java.io.IOException;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -89,8 +86,8 @@ public class GcpAuthAutoConfigurationCustomizerProvider
    *       customizes only the signal specific exporter.
    * </ul>
    *
-   * <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
+   * 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.
@@ -101,7 +98,12 @@ public class GcpAuthAutoConfigurationCustomizerProvider
    */
   @Override
   public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
-    GoogleCredentials credentials = getCredentials();
+    GoogleCredentials credentials;
+    try {
+      credentials = GoogleCredentials.getApplicationDefault();
+    } catch (IOException e) {
+      throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+    }
     autoConfiguration
         .addSpanExporterCustomizer(
             (spanExporter, configProperties) ->
@@ -112,80 +114,51 @@ 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 (shouldCustomizeExporter(
-        SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
+    if (isSignalTargeted(SIGNAL_TYPE_TRACES, 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 (shouldCustomizeExporter(
-        SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
+    if (isSignalTargeted(SIGNAL_TYPE_METRICS, 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}",
-          new String[] {signal, fixSuggestion});
-      return false;
+          params);
     }
+    return exporter;
   }
 
   // Checks if the auth extension is configured to target the passed signal for authentication.
   private static boolean isSignalTargeted(String checkSignal, ConfigProperties configProperties) {
-    return targetSignals(configProperties).stream()
+    String userSpecifiedTargetedSignals =
+        ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getConfiguredValueWithFallback(
+            configProperties, () -> SIGNAL_TYPE_ALL);
+    return stream(userSpecifiedTargetedSignals.split(","))
+        .map(String::trim)
         .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(
@@ -222,7 +195,7 @@ private static MetricExporter addAuthorizationHeaders(
     return exporter;
   }
 
-  static Map<String, String> getRequiredHeaderMap(
+  private static Map<String, String> getRequiredHeaderMap(
       GoogleCredentials credentials, ConfigProperties configProperties) {
     Map<String, List<String>> gcpHeaders;
     try {
@@ -244,31 +217,21 @@ 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)) {
-      getQuotaProjectId(configProperties)
-          .ifPresent(
-              configuredQuotaProjectId ->
-                  flattenedHeaders.put(QUOTA_USER_PROJECT_HEADER, configuredQuotaProjectId));
+      Optional<String> maybeConfiguredQuotaProjectId =
+          ConfigurableOption.GOOGLE_CLOUD_QUOTA_PROJECT.getConfiguredValueAsOptional(
+              configProperties);
+      maybeConfiguredQuotaProjectId.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) {
-    Resource res =
-        Resource.create(
-            Attributes.of(
-                stringKey(GCP_USER_PROJECT_ID_KEY), getProjectId(configProperties)));
+    String gcpProjectId =
+        ConfigurableOption.GOOGLE_CLOUD_PROJECT.getConfiguredValue(configProperties);
+    Resource res = Resource.create(Attributes.of(stringKey(GCP_USER_PROJECT_ID_KEY), gcpProjectId));
     return resource.merge(res);
   }
-
-  static String getProjectId(ConfigProperties configProperties) {
-    return ConfigurableOption.GOOGLE_CLOUD_PROJECT.getRequiredConfiguredValue(
-        configProperties, ConfigProperties::getString);
-  }
 }