cleanup

Author: stankiewicz

sdks/java/extensions/opentelemetry-gcp-auth-extension/build.gradle

@@ -28,9 +28,11 @@ dependencies {
   implementation enforcedPlatform(library.java.google_cloud_platform_libraries_bom)
   implementation platform(library.java.opentelemetry_bom)
   implementation library.java.google_auth_library_oauth2_http
+  implementation library.java.vendored_guava_32_1_2_jre
   compileOnly library.java.opentelemetry_api
   compileOnly library.java.opentelemetry_extension_autoconfigure
   compileOnly library.java.opentelemetry_exporter_otlp
+  implementation project(path: ":sdks:java:core", configuration: "shadow")
 
   testImplementation library.java.junit
   testImplementation library.java.mockito_core

sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/GcpAuthAutoConfigurationCustomizerProvider.java

@@ -26,13 +26,9 @@
 import com.google.auto.service.AutoService;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
-import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporterBuilder;
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
-import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder;
 import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
-import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder;
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
-import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
@@ -45,9 +41,9 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.apache.beam.sdk.annotations.Internal;
 import org.apache.beam.sdk.extensions.opentelemetry.gcp.auth.GoogleAuthException.Reason;
 
 /**
@@ -67,31 +63,24 @@
  * @see GoogleCredentials
  */
 @AutoService(AutoConfigurationCustomizerProvider.class)
+@Internal
 public class GcpAuthAutoConfigurationCustomizerProvider
     implements AutoConfigurationCustomizerProvider {
 
-  private static final Logger logger =
-      Logger.getLogger(GcpAuthAutoConfigurationCustomizerProvider.class.getName());
-  private static final String SIGNAL_TARGET_WARNING_FIX_SUGGESTION =
-      String.format(
-          "You may safely ignore this warning if it is intentional, otherwise please configure the '%s' by exporting valid values to environment variable: %s or by setting valid values in system property: %s.",
-          ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getUserReadableName(),
-          ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getEnvironmentVariable(),
-          ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getSystemProperty());
-
   static final String QUOTA_USER_PROJECT_HEADER = "x-goog-user-project";
   static final String GCP_USER_PROJECT_ID_KEY = "gcp.project_id";
 
   static final String SIGNAL_TYPE_TRACES = "traces";
   static final String SIGNAL_TYPE_METRICS = "metrics";
   static final String SIGNAL_TYPE_ALL = "all";
 
+  private @Nullable GoogleCredentials credentials;
+
   /**
    * Customizes the provided {@link AutoConfigurationCustomizer} such that authenticated exports to
    * GCP Telemetry API are possible from the configured OTLP exporter.
    *
-   * <p>This method attempts to retrieve Google Application Default Credentials (ADC) and performs
-   * the following:
+   * <p>This method performs the following:
    *
    * <ul>
    *   <li>Verifies whether the configured OTLP endpoint (base or signal specific) is a known GCP
@@ -107,60 +96,43 @@ public class GcpAuthAutoConfigurationCustomizerProvider
    * enable GCP integration.
    *
    * @param autoConfiguration the AutoConfigurationCustomizer to customize.
-   * @throws GoogleAuthException if there's an error retrieving Google Application Default
-   *     Credentials.
-   * @throws io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException if required options are
-   *     not configured through environment variables or system properties.
    */
   @Override
   public void customize(@Nonnull AutoConfigurationCustomizer autoConfiguration) {
-    GoogleCredentials credentials;
-    try {
-      credentials = GoogleCredentials.getApplicationDefault();
-    } catch (IOException e) {
-      throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
-    }
     autoConfiguration
-        .addSpanExporterCustomizer(
-            (spanExporter, configProperties) ->
-                customizeSpanExporter(spanExporter, credentials, configProperties))
-        .addMetricExporterCustomizer(
-            (metricExporter, configProperties) ->
-                customizeMetricExporter(metricExporter, credentials, configProperties))
-        .addResourceCustomizer(
-            (resource, configProperties) ->
-                customizeResource(resource, credentials, configProperties));
+        .addSpanExporterCustomizer(this::customizeSpanExporter)
+        .addMetricExporterCustomizer(this::customizeMetricExporter)
+        .addResourceCustomizer(this::customizeResource);
   }
 
   @Override
   public int order() {
     return Integer.MAX_VALUE - 1;
   }
 
-  private static SpanExporter customizeSpanExporter(
-      SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
+  private synchronized GoogleCredentials getCredentials() {
+    if (credentials == null) {
+      try {
+        credentials = GoogleCredentials.getApplicationDefault();
+      } catch (IOException e) {
+        throw new GoogleAuthException(Reason.FAILED_ADC_RETRIEVAL, e);
+      }
+    }
+    return credentials;
+  }
+
+  private SpanExporter customizeSpanExporter(
+      SpanExporter exporter, ConfigProperties 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 addAuthorizationHeaders(exporter, configProperties);
     }
     return exporter;
   }
 
-  private static MetricExporter customizeMetricExporter(
-      MetricExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
+  private MetricExporter customizeMetricExporter(
+      MetricExporter exporter, ConfigProperties configProperties) {
     if (isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties)) {
-      return addAuthorizationHeaders(exporter, credentials, configProperties);
-    } 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);
+      return addAuthorizationHeaders(exporter, configProperties);
     }
     return exporter;
   }
@@ -171,11 +143,25 @@ private static boolean isSignalTargeted(String checkSignal, ConfigProperties con
     if (endpoint == null) {
       endpoint = configProperties.getString("otel.exporter.otlp.endpoint");
     }
-    if (endpoint == null
-        || (!endpoint.startsWith("https://telemetry.googleapis.com")
-            && !endpoint.startsWith("https://telemetry.mtls.googleapis.com"))) {
+    if (endpoint == null) {
       return false;
     }
+
+    try {
+      java.net.URI uri = new java.net.URI(endpoint);
+      String host = uri.getHost();
+      String scheme = uri.getScheme();
+      if (host == null
+          || scheme == null
+          || !scheme.equalsIgnoreCase("https")
+          || (!host.equalsIgnoreCase("telemetry.googleapis.com")
+              && !host.equalsIgnoreCase("telemetry.mtls.googleapis.com"))) {
+        return false;
+      }
+    } catch (java.net.URISyntaxException e) {
+      return false;
+    }
+
     String userSpecifiedTargetedSignals =
         ConfigurableOption.GOOGLE_OTEL_AUTH_TARGET_SIGNALS.getConfiguredValueWithFallback(
             configProperties, () -> SIGNAL_TYPE_ALL);
@@ -186,57 +172,74 @@ private static boolean isSignalTargeted(String checkSignal, ConfigProperties con
                 targetedSignal.equals(checkSignal) || targetedSignal.equals(SIGNAL_TYPE_ALL));
   }
 
+  private boolean isAnySignalTargeted(ConfigProperties configProperties) {
+    return isSignalTargeted(SIGNAL_TYPE_TRACES, configProperties)
+        || isSignalTargeted(SIGNAL_TYPE_METRICS, configProperties);
+  }
+
   // Adds authorization headers to the calls made by the OtlpGrpcSpanExporter and
   // OtlpHttpSpanExporter.
-  private static SpanExporter addAuthorizationHeaders(
-      SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
+  private SpanExporter addAuthorizationHeaders(
+      SpanExporter exporter, ConfigProperties configProperties) {
     if (exporter instanceof OtlpHttpSpanExporter) {
-      OtlpHttpSpanExporterBuilder builder =
+      SpanExporter result =
           ((OtlpHttpSpanExporter) exporter)
               .toBuilder()
-              .setHeaders(() -> getRequiredHeaderMap(credentials, configProperties));
-      return builder.build();
+              .setHeaders(() -> getRequiredHeaderMap(configProperties))
+              .build();
+      exporter.shutdown();
+      return result;
     } else if (exporter instanceof OtlpGrpcSpanExporter) {
-      OtlpGrpcSpanExporterBuilder builder =
+      SpanExporter result =
           ((OtlpGrpcSpanExporter) exporter)
               .toBuilder()
-              .setHeaders(() -> getRequiredHeaderMap(credentials, configProperties));
-      return builder.build();
+              .setHeaders(() -> getRequiredHeaderMap(configProperties))
+              .build();
+      exporter.shutdown();
+      return result;
     }
     return exporter;
   }
 
   // Adds authorization headers to the calls made by the OtlpGrpcMetricExporter and
   // OtlpHttpMetricExporter.
-  private static MetricExporter addAuthorizationHeaders(
-      MetricExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
+  private MetricExporter addAuthorizationHeaders(
+      MetricExporter exporter, ConfigProperties configProperties) {
     if (exporter instanceof OtlpHttpMetricExporter) {
-      OtlpHttpMetricExporterBuilder builder =
+      MetricExporter result =
           ((OtlpHttpMetricExporter) exporter)
               .toBuilder()
-              .setHeaders(() -> getRequiredHeaderMap(credentials, configProperties));
-      return builder.build();
+              .setHeaders(() -> getRequiredHeaderMap(configProperties))
+              .build();
+      exporter.shutdown();
+      return result;
     } else if (exporter instanceof OtlpGrpcMetricExporter) {
-      OtlpGrpcMetricExporterBuilder builder =
+      MetricExporter result =
           ((OtlpGrpcMetricExporter) exporter)
               .toBuilder()
-              .setHeaders(() -> getRequiredHeaderMap(credentials, configProperties));
-      return builder.build();
+              .setHeaders(() -> getRequiredHeaderMap(configProperties))
+              .build();
+      exporter.shutdown();
+      return result;
     }
     return exporter;
   }
 
-  private static Map<String, String> getRequiredHeaderMap(
-      GoogleCredentials credentials, ConfigProperties configProperties) {
+  private Map<String, String> getRequiredHeaderMap(ConfigProperties configProperties) {
+    GoogleCredentials creds = getCredentials();
     Map<String, List<String>> gcpHeaders;
     try {
       // this also refreshes the credentials, if required
-      gcpHeaders = credentials.getRequestMetadata();
+      gcpHeaders = creds.getRequestMetadata();
     } catch (IOException e) {
       throw new GoogleAuthException(Reason.FAILED_ADC_REFRESH, e);
     }
+    if (gcpHeaders == null) {
+      return Map.of();
+    }
     Map<String, String> flattenedHeaders =
         gcpHeaders.entrySet().stream()
+            .filter(entry -> entry.getKey() != null && entry.getValue() != null)
             .collect(
                 toMap(
                     Map.Entry::getKey,
@@ -259,13 +262,16 @@ private static Map<String, String> getRequiredHeaderMap(
   }
 
   // Updates the current resource with the attributes required for ingesting OTLP data on GCP.
-  private static Resource customizeResource(
-      Resource resource, GoogleCredentials credentials, ConfigProperties configProperties) {
+  private Resource customizeResource(Resource resource, ConfigProperties configProperties) {
+    if (!isAnySignalTargeted(configProperties)) {
+      return resource;
+    }
+
     String gcpProjectId;
     try {
       gcpProjectId = ConfigurableOption.GOOGLE_CLOUD_PROJECT.getConfiguredValue(configProperties);
     } catch (ConfigurationException e) {
-      gcpProjectId = credentials.getProjectId();
+      gcpProjectId = getCredentials().getProjectId();
       if (gcpProjectId == null || gcpProjectId.isEmpty()) {
         throw e;
       }

sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/java/org/apache/beam/sdk/extensions/opentelemetry/gcp/auth/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Google Cloud Platform (GCP) OpenTelemetry (OTLP) authentication extension. */
+package org.apache.beam.sdk.extensions.opentelemetry.gcp.auth;

sdks/java/extensions/opentelemetry-gcp-auth-extension/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider

@@ -1 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 org.apache.beam.sdk.extensions.opentelemetry.gcp.auth.GcpAuthAutoConfigurationCustomizerProvider