fix: Decrease log level for directpath warnings outside GCE (#4139)

nimf · web-flow · commit 5151f345591b · 2026-03-17T12:54:33.000-04:00
Directpath is not available outside of GCE. When a Cloud service client
has Directpath enabled, the users with clients outside of GCE receive
this warning and it's not actionable.
diff --git a/sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java b/sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java
@@ -441,43 +441,47 @@ public boolean isDirectPathXdsEnabled() {
   // builder or createSingleChannel, only in getTransportChannel which creates the first channel
   // for a client.
   private void logDirectPathMisconfig() {
-    if (isDirectPathXdsEnabled()) {
-      if (!isDirectPathEnabled()) {
-        // This misconfiguration occurs when Direct Path xDS is enabled, but Direct Path is not
-        // Direct Path xDS can be enabled two ways: via environment variable or via builder.
-        // Case 1: Direct Path is only enabled via xDS env var. We will _warn_ the user that this is
-        // a misconfiguration if they intended to set the env var.
-        if (isDirectPathXdsEnabledViaEnv()) {
-          LOG.log(
-              Level.WARNING,
-              "Env var "
-                  + DIRECT_PATH_ENV_ENABLE_XDS
-                  + " was found and set to TRUE, but DirectPath was not enabled for this client. If this is intended for "
-                  + "this client, please note that this is a misconfiguration and set the attemptDirectPath option as well.");
-        }
-        // Case 2: Direct Path xDS was enabled via Builder. Direct Path Traffic Director must be set
-        // (enabled with `setAttemptDirectPath(true)`) along with xDS.
-        // Here we warn the user about this.
-        else if (isDirectPathXdsEnabledViaBuilderOption()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. The DirectPath XDS option was set, but the attemptDirectPath option was not. Please set both the attemptDirectPath and attemptDirectPathXds options.");
-        }
-      } else {
-        // Case 3: credential is not correctly set
-        if (!isCredentialDirectPathCompatible()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. Please make sure the credential is an instance of "
-                  + ComputeEngineCredentials.class.getName()
-                  + " .");
-        }
-        // Case 4: not running on GCE
-        if (!isOnComputeEngine()) {
-          LOG.log(
-              Level.WARNING,
-              "DirectPath is misconfigured. DirectPath is only available in a GCE environment.");
-        }
+    if (!isDirectPathXdsEnabled()) {
+      return;
+    }
+
+    Level level = isOnComputeEngine() ? Level.WARNING : Level.FINE;
+
+    if (!isDirectPathEnabled()) {
+      // This misconfiguration occurs when Direct Path xDS is enabled, but Direct Path is not
+      // Direct Path xDS can be enabled two ways: via environment variable or via builder.
+      // Case 1: Direct Path is only enabled via xDS env var. We will _warn_ the user that this is
+      // a misconfiguration if they intended to set the env var.
+      if (isDirectPathXdsEnabledViaEnv()) {
+        LOG.log(
+            level,
+            "Env var "
+                + DIRECT_PATH_ENV_ENABLE_XDS
+                + " was found and set to TRUE, but DirectPath was not enabled for this client. If this is intended for "
+                + "this client, please note that this is a misconfiguration and set the attemptDirectPath option as well.");
+      }
+      // Case 2: Direct Path xDS was enabled via Builder. Direct Path Traffic Director must be set
+      // (enabled with `setAttemptDirectPath(true)`) along with xDS.
+      // Here we warn the user about this.
+      else if (isDirectPathXdsEnabledViaBuilderOption()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. The DirectPath XDS option was set, but the attemptDirectPath option was not. Please set both the attemptDirectPath and attemptDirectPathXds options.");
+      }
+    } else {
+      // Case 3: credential is not correctly set
+      if (!isCredentialDirectPathCompatible()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. Please make sure the credential is an instance of "
+                + ComputeEngineCredentials.class.getName()
+                + " .");
+      }
+      // Case 4: not running on GCE
+      if (!isOnComputeEngine()) {
+        LOG.log(
+            level,
+            "DirectPath is misconfigured. DirectPath is only available in a GCE environment.");
       }
     }
   }
diff --git a/sdk-platform-java/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java b/sdk-platform-java/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java
@@ -77,6 +77,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 import java.util.logging.Handler;
+import java.util.logging.Level;
 import java.util.logging.LogRecord;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
@@ -645,6 +646,7 @@ private void createAndCloseTransportChannel(InstantiatingGrpcChannelProvider pro
       testLogDirectPathMisconfig_AttemptDirectPathNotSetAndAttemptDirectPathXdsSetViaBuilder_warns()
           throws Exception {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
     InstantiatingGrpcChannelProvider provider =
         createChannelProviderBuilderForDirectPathLogTests()
@@ -662,6 +664,7 @@ private void createAndCloseTransportChannel(InstantiatingGrpcChannelProvider pro
   void testLogDirectPathMisconfig_AttemptDirectPathNotSetAndAttemptDirectPathXdsSetViaEnv_warns()
       throws Exception {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
 
     InstantiatingGrpcChannelProvider provider =
@@ -679,6 +682,7 @@ void testLogDirectPathMisconfig_AttemptDirectPathNotSetAndAttemptDirectPathXdsSe
   @Test
   void testLogDirectPathMisconfig_shouldNotLogInTheBuilder() {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
     InstantiatingGrpcChannelProvider.newBuilder()
         .setAttemptDirectPathXds()
@@ -693,6 +697,7 @@ void testLogDirectPathMisconfig_shouldNotLogInTheBuilder() {
   @Test
   void testLogDirectPathMisconfigWrongCredential() throws Exception {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
     InstantiatingGrpcChannelProvider provider =
         InstantiatingGrpcChannelProvider.newBuilder()
@@ -719,6 +724,7 @@ void testLogDirectPathMisconfigWrongCredential() throws Exception {
   @Test
   void testLogDirectPathMisconfigNotOnGCE() throws Exception {
     FakeLogHandler logHandler = new FakeLogHandler();
+    InstantiatingGrpcChannelProvider.LOG.setLevel(Level.FINE);
     InstantiatingGrpcChannelProvider.LOG.addHandler(logHandler);
     InstantiatingGrpcChannelProvider provider =
         InstantiatingGrpcChannelProvider.newBuilder()
