BAEL-8954 - How to log all requests and responses with an exception in a single place

Author: Alexandru-Borza

logging-modules/log-all-requests/pom.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>3.4.1</version>
+		<relativePath/>
+	</parent>
+	<groupId>com.baeldung</groupId>
+	<artifactId>log-all-requests</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<name>log-all-requests</name>
+	<description>log-all-requests</description>
+
+	<properties>
+		<java.version>17</java.version>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-actuator</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.springframework.boot</groupId>
+				<artifactId>spring-boot-maven-plugin</artifactId>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/GlobalExceptionHandler.java

@@ -0,0 +1,20 @@
+package com.baeldung.logallrequests;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+@ControllerAdvice
+public class GlobalExceptionHandler {
+
+    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<String> handleException(Exception ex) {
+        logger.error("Exception caught: {}", ex.getMessage(), ex);
+        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("An error occurred");
+    }
+}

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/HttpTraceActuatorConfiguration.java

@@ -0,0 +1,15 @@
+package com.baeldung.logallrequests;
+
+import org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class HttpTraceActuatorConfiguration {
+
+    @Bean
+    public InMemoryHttpExchangeRepository createTraceRepository() {
+        return new InMemoryHttpExchangeRepository();
+    }
+
+}

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/LogAllRequestsApplication.java

@@ -0,0 +1,13 @@
+package com.baeldung.logallrequests;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class LogAllRequestsApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(LogAllRequestsApplication.class, args);
+	}
+
+}

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/LoggingFilter.java

@@ -0,0 +1,51 @@
+package com.baeldung.logallrequests;
+
+import jakarta.servlet.Filter;
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+import java.io.IOException;
+
+@Component
+public class LoggingFilter implements Filter {
+
+    private static final Logger logger = LoggerFactory.getLogger(LoggingFilter.class);
+
+    @Override
+    public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, FilterChain chain)
+      throws IOException, ServletException {
+
+        if (request instanceof HttpServletRequest && response instanceof HttpServletResponse) {
+            HttpServletRequest httpRequest = (HttpServletRequest) request;
+            HttpServletResponse httpResponse = (HttpServletResponse) response;
+
+            logRequest(httpRequest);
+
+            ResponseWrapper responseWrapper = new ResponseWrapper(httpResponse);
+
+            chain.doFilter(request, responseWrapper);
+
+            logResponse(httpRequest, responseWrapper);
+        } else {
+            chain.doFilter(request, response);
+        }
+    }
+
+    private void logRequest(HttpServletRequest request) {
+        logger.info("Incoming Request: [{}] {}", request.getMethod(), request.getRequestURI());
+        request.getHeaderNames().asIterator().forEachRemaining(header ->
+          logger.info("Header: {} = {}", header, request.getHeader(header))
+        );
+    }
+
+    private void logResponse(HttpServletRequest request, ResponseWrapper responseWrapper) throws IOException {
+        logger.info("Outgoing Response for [{}] {}: Status = {}",
+          request.getMethod(), request.getRequestURI(), responseWrapper.getStatus());
+        logger.info("Response Body: {}", responseWrapper.getBodyAsString());
+    }
+}

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/ResponseWrapper.java

@@ -0,0 +1,26 @@
+package com.baeldung.logallrequests;
+
+import java.io.CharArrayWriter;
+import java.io.PrintWriter;
+
+import jakarta.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletResponseWrapper;
+
+public class ResponseWrapper extends HttpServletResponseWrapper {
+
+    private final CharArrayWriter charArrayWriter = new CharArrayWriter();
+    private final PrintWriter writer = new PrintWriter(charArrayWriter);
+
+    public ResponseWrapper(HttpServletResponse response) {
+        super(response);
+    }
+
+    @Override
+    public PrintWriter getWriter() {
+        return writer;
+    }
+
+    public String getBodyAsString() {
+        return charArrayWriter.toString();
+    }
+}

logging-modules/log-all-requests/src/main/java/com/baeldung/logallrequests/TestController.java

@@ -0,0 +1,20 @@
+package com.baeldung.logallrequests;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+public class TestController {
+
+    @GetMapping("/hello")
+    public String hello() {
+        return "Hello, World!";
+    }
+
+    @GetMapping("/error")
+    public String error() {
+        throw new RuntimeException("This is a test exception");
+    }
+}

logging-modules/log-all-requests/src/main/resources/application.yaml

@@ -0,0 +1,9 @@
+spring:
+  application:
+    name: log-all-requests
+
+management:
+  endpoints:
+    web:
+      exposure:
+        include: httpexchanges

logging-modules/pom.xml

@@ -23,6 +23,7 @@
         <module>logging-techniques</module>
         <module>solarwinds-loggly</module>
         <module>splunk-with-log4j2</module>
+        <module>log-all-requests</module>
     </modules>
 
 </project>