Improve log output when detecting GCE (#214)

lbergelson · chingor13 · commit e311be7adb49 · 2018-12-19T14:13:33.000-08:00
Improving the log output when unexpected exceptions occur while determining if the client is running on Google Compute Engine. Moving the stacktrace to be FINE output since stacktraces are alarming. Making the INFO level log message occur only once instead of potentially many times. Further improvements to #199 and #198
diff --git a/oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java b/oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java
@@ -222,10 +222,11 @@ static boolean runningOnComputeEngine(
       } catch (SocketTimeoutException expected) {
         // Ignore logging timeouts which is the expected failure mode in non GCE environments.
       } catch (IOException e) {
-        LOGGER.log(
-            Level.INFO, "Failed to detect whether we are running on Google Compute Engine.", e);
+        LOGGER.log(Level.FINE, "Encountered an unexpected exception when determining" +
+            " if we are running on Google Compute Engine.", e);
       }
     }
+    LOGGER.log(Level.INFO, "Failed to detect whether we are running on Google Compute Engine.");
     return false;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -222,10 +222,11 @@ static boolean runningOnComputeEngine(`
`222`	`222`	`} catch (SocketTimeoutException expected) {`
`223`	`223`	`// Ignore logging timeouts which is the expected failure mode in non GCE environments.`
`224`	`224`	`} catch (IOException e) {`
`225`		`- LOGGER.log(`
`226`		`- Level.INFO, "Failed to detect whether we are running on Google Compute Engine.", e);`
	`225`	`+ LOGGER.log(Level.FINE, "Encountered an unexpected exception when determining" +`
	`226`	`+ " if we are running on Google Compute Engine.", e);`
`227`	`227`	`}`
`228`	`228`	`}`
	`229`	`+ LOGGER.log(Level.INFO, "Failed to detect whether we are running on Google Compute Engine.");`
`229`	`230`	`return false;`
`230`	`231`	`}`
`231`	`232`