Fix some logging issues (#1917)

* Fix some logging issues

* Update agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/common/NetworkFriendlyExceptions.java

Co-authored-by: kryalama <[email protected]>

* Update agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/common/NetworkFriendlyExceptions.java

Co-authored-by: kryalama <[email protected]>

Co-authored-by: kryalama <[email protected]>

Author: trask

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/common/ExceptionUtils.java

@@ -21,35 +21,42 @@
 
 package com.microsoft.applicationinsights.agent.internal.common;
 
-public class FriendlyException extends RuntimeException {
-  // TODO (trask) this seems like default for failing to send telemetry, but not necessarily default
-  //  for all friendly exceptions
-  private static final String DEFAULT_BANNER =
-      "ApplicationInsights Java Agent failed to send telemetry data";
-
-  public FriendlyException() {
-    super();
-  }
+import org.checkerframework.checker.nullness.qual.Nullable;
 
-  public FriendlyException(String message, String action) {
-    // TODO (trask) can these constructors cascade?
-    super(populateFriendlyMessage(message, action, DEFAULT_BANNER, ""));
-  }
+public class FriendlyException extends RuntimeException {
 
-  public FriendlyException(String banner, String action, String message, String note) {
-    super(populateFriendlyMessage(message, action, banner, note));
+  public FriendlyException(String description, String action) {
+    this(description, action, null);
   }
 
-  public FriendlyException(String banner, String action, Throwable cause) {
-    super(populateFriendlyMessage("", action, banner, ""), cause);
+  public FriendlyException(String description, String action, @Nullable Throwable cause) {
+    super(buildMessage(description, action), cause);
   }
 
   public String getMessageWithBanner(String banner) {
-    return populateFriendlyMessage(getMessage(), "", banner, "");
+    return System.lineSeparator()
+        + "*************************"
+        + System.lineSeparator()
+        + banner
+        + System.lineSeparator()
+        + "*************************"
+        + System.lineSeparator()
+        + getMessage();
   }
 
-  public static String getMessageWithDefaultBanner(String message) {
-    return populateFriendlyMessage(message, "", DEFAULT_BANNER, "");
+  private static String buildMessage(String description, String action) {
+    StringBuilder messageBuilder = new StringBuilder();
+    if (!Strings.isNullOrEmpty(description)) {
+      messageBuilder.append(System.lineSeparator());
+      messageBuilder.append("Description:").append(System.lineSeparator());
+      messageBuilder.append(description).append(System.lineSeparator());
+    }
+    if (!Strings.isNullOrEmpty(action)) {
+      messageBuilder.append(System.lineSeparator());
+      messageBuilder.append("Action:").append(System.lineSeparator());
+      messageBuilder.append(action).append(System.lineSeparator());
+    }
+    return messageBuilder.toString();
   }
 
   public static String populateFriendlyMessage(

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/common/FriendlyException.java

@@ -19,35 +19,57 @@
  * DEALINGS IN THE SOFTWARE.
  */
 
-package com.microsoft.applicationinsights.agent.internal.httpclient;
+package com.microsoft.applicationinsights.agent.internal.common;
 
-import com.microsoft.applicationinsights.agent.internal.common.FriendlyException;
 import com.microsoft.applicationinsights.agent.internal.configuration.DefaultEndpoints;
 import java.io.File;
+import java.net.UnknownHostException;
+import java.util.concurrent.atomic.AtomicBoolean;
+import javax.net.ssl.SSLHandshakeException;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.slf4j.Logger;
 
-public class SslUtil {
+public class NetworkFriendlyExceptions {
 
-  public static String friendlyMessage(String url) {
-    return FriendlyException.populateFriendlyMessage(
-        getSslFriendlyExceptionBanner(url),
-        getSslFriendlyExceptionAction(url),
-        getSslFriendlyExceptionMessage(),
-        getSslFriendlyExceptionNote());
+  public static void logSpecialOneTimeFriendlyException(
+      Throwable error, String url, AtomicBoolean alreadySeen, Logger logger) {
+    if (alreadySeen.get()) {
+      return;
+    }
+    // Handle SSL cert exceptions
+    SSLHandshakeException sslException = getCausedByOfType(error, SSLHandshakeException.class);
+    if (sslException != null && !alreadySeen.getAndSet(true)) {
+      logger.error(getSslFriendlyMessage(url));
+      return;
+    }
+    UnknownHostException unknownHostException =
+        getCausedByOfType(error, UnknownHostException.class);
+    if (unknownHostException != null && !alreadySeen.getAndSet(true)) {
+      // TODO log friendly message with instructions how to troubleshoot
+      //  e.g. wrong host address or cannot reach address due to network issues...
+      return;
+    }
   }
 
-  private static String getJavaCacertsPath() {
-    String javaHome = System.getProperty("java.home");
-    return new File(javaHome, "lib/security/cacerts").getPath();
+  private static <T extends Exception> T getCausedByOfType(Throwable throwable, Class<T> type) {
+    if (type.isInstance(throwable)) {
+      @SuppressWarnings("unchecked")
+      T ofType = (T) throwable;
+      return ofType;
+    }
+    Throwable cause = throwable.getCause();
+    if (cause == null) {
+      return null;
+    }
+    return getCausedByOfType(cause, type);
   }
 
-  @Nullable
-  private static String getCustomJavaKeystorePath() {
-    String cacertsPath = System.getProperty("javax.net.ssl.trustStore");
-    if (cacertsPath != null) {
-      return new File(cacertsPath).getPath();
-    }
-    return null;
+  private static String getSslFriendlyMessage(String url) {
+    return FriendlyException.populateFriendlyMessage(
+        getSslFriendlyExceptionBanner(url),
+        getSslFriendlyExceptionAction(url),
+        "Unable to find valid certification path to requested target.",
+        "This message is only logged the first time it occurs after startup.");
   }
 
   private static String getSslFriendlyExceptionBanner(String url) {
@@ -57,10 +79,6 @@ private static String getSslFriendlyExceptionBanner(String url) {
     return "ApplicationInsights Java Agent failed to send telemetry data.";
   }
 
-  private static String getSslFriendlyExceptionMessage() {
-    return "Unable to find valid certification path to requested target.";
-  }
-
   private static String getSslFriendlyExceptionAction(String url) {
     String customJavaKeyStorePath = getCustomJavaKeystorePath();
     if (customJavaKeyStorePath != null) {
@@ -79,9 +97,19 @@ private static String getSslFriendlyExceptionAction(String url) {
         + "Learn more about importing the certificate here: https://go.microsoft.com/fwlink/?linkid=2151450";
   }
 
-  private static String getSslFriendlyExceptionNote() {
-    return "This message is only logged the first time it occurs after startup.";
+  private static String getJavaCacertsPath() {
+    String javaHome = System.getProperty("java.home");
+    return new File(javaHome, "lib/security/cacerts").getPath();
+  }
+
+  @Nullable
+  private static String getCustomJavaKeystorePath() {
+    String cacertsPath = System.getProperty("javax.net.ssl.trustStore");
+    if (cacertsPath != null) {
+      return new File(cacertsPath).getPath();
+    }
+    return null;
   }
 
-  private SslUtil() {}
+  private NetworkFriendlyExceptions() {}
 }

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/httpclient/SslUtil.java renamed to agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/common/NetworkFriendlyExceptions.java

@@ -553,10 +553,9 @@ static Configuration getConfigurationFromConfigFile(Path configPath, boolean str
       }
     } catch (JsonMappingException | JsonParseException ex) {
       throw new FriendlyException(
-          "Application Insights Java agent failed to start",
+          "Error parsing configuration from file: " + configPath.toAbsolutePath(),
           "Learn more about configuration options here: https://go.microsoft.com/fwlink/?linkid=2153358",
-          ex.getMessage(),
-          "Error parsing configuration from file: " + configPath.toAbsolutePath());
+          ex);
     } catch (Exception e) {
       throw new ConfigurationException(
           "Error parsing configuration from file: " + configPath.toAbsolutePath(), e);

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/configuration/ConfigurationBuilder.java

@@ -26,7 +26,7 @@
 import com.azure.core.http.HttpMethod;
 import com.azure.core.http.HttpRequest;
 import com.azure.core.http.HttpResponse;
-import com.microsoft.applicationinsights.agent.internal.common.ExceptionUtils;
+import com.microsoft.applicationinsights.agent.internal.common.NetworkFriendlyExceptions;
 import com.microsoft.applicationinsights.agent.internal.common.ThreadPoolUtils;
 import com.microsoft.applicationinsights.agent.internal.common.WarningLogger;
 import com.microsoft.applicationinsights.agent.internal.httpclient.LazyHttpClient;
@@ -125,7 +125,8 @@ public void run() {
       try {
         response = LazyHttpClient.getInstance().send(request).block();
       } catch (RuntimeException ex) {
-        ExceptionUtils.parseError(ex, url.toString(), friendlyExceptionThrown, logger);
+        NetworkFriendlyExceptions.logSpecialOneTimeFriendlyException(
+            ex, url.toString(), friendlyExceptionThrown, logger);
         warningLogger.recordWarning("exception sending request to " + url, ex);
         backOff();
         return;

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/init/AppIdSupplier.java

@@ -27,7 +27,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
-import com.microsoft.applicationinsights.agent.internal.common.ExceptionUtils;
+import com.microsoft.applicationinsights.agent.internal.common.NetworkFriendlyExceptions;
 import com.microsoft.applicationinsights.agent.internal.common.OperationLogger;
 import com.microsoft.applicationinsights.agent.internal.common.Strings;
 import com.microsoft.applicationinsights.agent.internal.httpclient.LazyHttpClient;
@@ -135,8 +135,9 @@ public QuickPulseHeaderInfo ping(String redirectedEndpoint) {
         }
       }
     } catch (Throwable t) {
+      NetworkFriendlyExceptions.logSpecialOneTimeFriendlyException(
+          t, getQuickPulseEndpoint(), friendlyExceptionThrown, logger);
       operationLogger.recordFailure(t.getMessage(), t);
-      ExceptionUtils.parseError(t, getQuickPulseEndpoint(), friendlyExceptionThrown, logger);
     } finally {
       if (response != null) {
         response.close();