pr review

Author: zeitlinger

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;
@@ -124,7 +125,7 @@ public int order() {
 
   private static SpanExporter customizeSpanExporter(
       SpanExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
-    if (shouldConfigureExporter(
+    if (shouldCustomizeExporter(
         SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
       return addAuthorizationHeaders(exporter, credentials, configProperties);
     }
@@ -133,14 +134,25 @@ private static SpanExporter customizeSpanExporter(
 
   private static MetricExporter customizeMetricExporter(
       MetricExporter exporter, GoogleCredentials credentials, ConfigProperties configProperties) {
-    if (shouldConfigureExporter(
+    if (shouldCustomizeExporter(
         SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_FIX_SUGGESTION, configProperties)) {
       return addAuthorizationHeaders(exporter, credentials, configProperties);
     }
     return exporter;
   }
 
-  static boolean shouldConfigureExporter(
+  /**
+   * 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;

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

@@ -7,7 +7,7 @@
 
 import static io.opentelemetry.contrib.gcp.auth.GcpAuthAutoConfigurationCustomizerProvider.SIGNAL_TYPE_METRICS;
 import static io.opentelemetry.contrib.gcp.auth.GcpAuthAutoConfigurationCustomizerProvider.SIGNAL_TYPE_TRACES;
-import static io.opentelemetry.contrib.gcp.auth.GcpAuthAutoConfigurationCustomizerProvider.shouldConfigureExporter;
+import static io.opentelemetry.contrib.gcp.auth.GcpAuthAutoConfigurationCustomizerProvider.shouldCustomizeExporter;
 
 import com.google.auth.oauth2.GoogleCredentials;
 import com.google.auto.service.AutoService;
@@ -86,7 +86,7 @@ private static void customizeMeter(
       return;
     }
 
-    if (shouldConfigureExporter(
+    if (shouldCustomizeExporter(
         SIGNAL_TYPE_METRICS, SIGNAL_TARGET_WARNING_YAML_FIX_SUGGESTION, configProperties)) {
       for (MetricReaderModel reader : meterProvider.getReaders()) {
         if (reader.getPeriodic() != null) {
@@ -122,7 +122,7 @@ private static void customizeTracer(
       return;
     }
 
-    if (shouldConfigureExporter(
+    if (shouldCustomizeExporter(
         SIGNAL_TYPE_TRACES, SIGNAL_TARGET_WARNING_YAML_FIX_SUGGESTION, configProperties)) {
       for (SpanProcessorModel processor : tracerProvider.getProcessors()) {
         BatchSpanProcessorModel batch = processor.getBatch();