Include unhandled exceptions in request log (#11)

Author: itssimon

src/main/java/io/apitally/common/RequestLogger.java

@@ -24,6 +24,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
+import io.apitally.common.dto.ExceptionDto;
 import io.apitally.common.dto.Header;
 import io.apitally.common.dto.Request;
 import io.apitally.common.dto.Response;
@@ -123,7 +124,7 @@ public void setSuspendUntil(long timestamp) {
         this.suspendUntil = timestamp;
     }
 
-    public void logRequest(Request request, Response response) {
+    public void logRequest(Request request, Response response, Exception exception) {
         if (!enabled || suspendUntil != null && suspendUntil > System.currentTimeMillis()) {
             return;
         }
@@ -197,6 +198,10 @@ public void logRequest(Request request, Response response) {
             item.put("uuid", UUID.randomUUID().toString());
             item.set("request", skipEmptyValues(objectMapper.valueToTree(request)));
             item.set("response", skipEmptyValues(objectMapper.valueToTree(response)));
+            if (exception != null && config.isExceptionIncluded()) {
+                ExceptionDto exceptionDto = new ExceptionDto(exception);
+                item.set("exception", objectMapper.valueToTree(exceptionDto));
+            }
 
             String serializedItem = objectMapper.writeValueAsString(item);
             pendingWrites.add(serializedItem);

src/main/java/io/apitally/common/RequestLoggingConfig.java

@@ -10,6 +10,7 @@ public class RequestLoggingConfig {
     private boolean requestBodyIncluded = false;
     private boolean responseHeadersIncluded = true;
     private boolean responseBodyIncluded = false;
+    private boolean exceptionIncluded = true;
     private List<String> queryParamMaskPatterns = new ArrayList<>();
     private List<String> headerMaskPatterns = new ArrayList<>();
     private List<String> pathExcludePatterns = new ArrayList<>();
@@ -63,6 +64,14 @@ public void setResponseBodyIncluded(boolean responseBodyIncluded) {
         this.responseBodyIncluded = responseBodyIncluded;
     }
 
+    public boolean isExceptionIncluded() {
+        return exceptionIncluded;
+    }
+
+    public void setExceptionIncluded(boolean exceptionIncluded) {
+        this.exceptionIncluded = exceptionIncluded;
+    }
+
     public List<String> getQueryParamMaskPatterns() {
         return queryParamMaskPatterns;
     }

src/main/java/io/apitally/common/dto/ExceptionDto.java

@@ -0,0 +1,25 @@
+package io.apitally.common.dto;
+
+public class ExceptionDto {
+    private String type;
+    private String message;
+    private String stackTrace;
+
+    public ExceptionDto(Exception exception) {
+        this.type = exception.getClass().getSimpleName();
+        this.message = ServerError.truncateMessage(exception.getMessage());
+        this.stackTrace = ServerError.truncateStackTrace(exception.getStackTrace());
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public String getStackTrace() {
+        return stackTrace;
+    }
+}

src/main/java/io/apitally/common/dto/ServerError.java

@@ -64,7 +64,7 @@ public String getStackTraceString() {
         return stackTraceString;
     }
 
-    private String truncateMessage(String msg) {
+    public static String truncateMessage(String msg) {
         msg = msg.trim();
         if (msg.length() <= MAX_MSG_LENGTH) {
             return msg;
@@ -74,7 +74,7 @@ private String truncateMessage(String msg) {
         return msg.substring(0, cutoff) + suffix;
     }
 
-    private String truncateStackTrace(StackTraceElement[] stackTrace) {
+    public static String truncateStackTrace(StackTraceElement[] stackTrace) {
         String suffix = "... (truncated) ...";
         int cutoff = MAX_STACKTRACE_LENGTH - suffix.length();
         List<String> truncatedLines = new ArrayList<>();

src/main/java/io/apitally/spring/ApitallyFilter.java

@@ -92,6 +92,12 @@ protected void doFilterInternal(@NonNull HttpServletRequest request, @NonNull Ht
                 client.consumerRegistry.addOrUpdateConsumer(consumer);
                 final String consumerIdentifier = consumer != null ? consumer.getIdentifier() : "";
 
+                // Get captured exception
+                Object capturedException = request.getAttribute("apitallyCapturedException");
+                if (exception == null && capturedException != null && capturedException instanceof Exception) {
+                    exception = (Exception) capturedException;
+                }
+
                 // Add request to counter
                 final long requestContentLength = request.getContentLengthLong();
                 final long requestSize = requestContentLength >= 0 ? requestContentLength
@@ -119,12 +125,12 @@ protected void doFilterInternal(@NonNull HttpServletRequest request, @NonNull Ht
                             new Request(startTime / 1000.0, consumerIdentifier, request.getMethod(), path,
                                     request.getRequestURL().toString(), requestHeaders, requestSize, requestBody),
                             new Response(response.getStatus(), responseTimeInMillis / 1000.0, responseHeaders,
-                                    responseSize, responseBody));
+                                    responseSize, responseBody),
+                            exception);
                 }
 
                 // Add validation error to counter
                 if (response.getStatus() >= 400 && response.getStatus() < 500) {
-                    Object capturedException = request.getAttribute("apitallyCapturedException");
                     if (capturedException instanceof ConstraintViolationException e) {
                         for (ConstraintViolation<?> violation : e.getConstraintViolations()) {
                             client.validationErrorCounter.addValidationError(
@@ -144,15 +150,8 @@ protected void doFilterInternal(@NonNull HttpServletRequest request, @NonNull Ht
                 }
 
                 // Add server error to counter
-                if (response.getStatus() == 500) {
-                    Object capturedException = request.getAttribute("apitallyCapturedException");
-                    if (exception == null && capturedException != null && capturedException instanceof Exception) {
-                        exception = (Exception) capturedException;
-                    }
-                    if (exception != null) {
-                        client.serverErrorCounter.addServerError(
-                                consumerIdentifier, request.getMethod(), path, exception);
-                    }
+                if (response.getStatus() == 500 && exception != null) {
+                    client.serverErrorCounter.addServerError(consumerIdentifier, request.getMethod(), path, exception);
                 }
             } catch (Exception e) {
                 logger.error("Error in Apitally filter", e);

src/test/java/io/apitally/common/ApitallyClientTest.java

@@ -68,7 +68,7 @@ void testSync() {
                 responseHeaders,
                 13L,
                 "{\"items\": []}".getBytes());
-        client.requestLogger.logRequest(request, response);
+        client.requestLogger.logRequest(request, response, null);
         client.requestLogger.maintain();
 
         List<Path> paths = Arrays.asList(new Path("GET", "/items"));