How can I effectively log HTTP requests and responses, including exceptions, in my Spring Boot application?

Logging Requests and Responses with Spring Boot

Introduction

Logging HTTP requests and responses is crucial for debugging and performance analysis in Spring Boot applications. This article provides an overview of a practical solution using Spring Boot's Actuator module, enabling you to log all requests and responses with exceptions in a single place.

Using Spring Boot Actuator

Spring Boot Actuator provides out-of-the-box support for tracking HTTP requests. By default, it logs the last 100 requests to the /trace endpoint (or /actuator/httptrace in Spring Boot 2.0 ).

To enable request logging, add the spring-boot-starter-actuator dependency to your project.

<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-actuator</artifactid>
</dependency>

Customizing Request Logging

By default, Actuator only logs a minimal amount of request information. To customize the logged details, you can create a custom WebMvcConfigurerAdapter and override the addInterceptors method to add a custom interceptor.

public class RequestLoggingInterceptor extends HandlerInterceptorAdapter {

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    // Log request details
    logger.info("Path: {}", request.getPathInfo());
    logger.info("Method: {}", request.getMethod());
    logger.info("Arguments: {}", request.getParameterMap());

    // Store request and response details for later use
    HttpServletRequestWrapper requestWrapper = new HttpServletRequestWrapper(request);
    HttpServletResponseWrapper responseWrapper = new HttpServletResponseWrapper(response);
    request.setAttribute("wrappedRequest", requestWrapper);
    response.setAttribute("wrappedResponse", responseWrapper);

    return super.preHandle(request, response, handler);
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    // Log response details
    HttpServletRequestWrapper requestWrapper = (HttpServletRequestWrapper) request.getAttribute("wrappedRequest");
    HttpServletResponseWrapper responseWrapper = (HttpServletResponseWrapper) response.getAttribute("wrappedResponse");

    logger.info("Status: {}", responseWrapper.getStatus());
    logger.info("Response: {}", responseWrapper.getContentAsString());

    super.postHandle(request, response, handler, modelAndView);
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // Log exceptions
    if (ex != null) {
      logger.error("Exception: {}", ex.getClass().getName());
      logger.error("Message: {}", ex.getMessage());
      logger.error("Stacktrace:");
      ex.printStackTrace();
    }

    super.afterCompletion(request, response, handler, ex);
  }
}

Accessing Logged Requests

The logged requests can be accessed from the /actuator/httptrace endpoint. The JSON output contains details of each request, including:

• Status
• Path
• Method
• Query string
• Request arguments
• Response body
• Exceptions (if any)

Conclusion

Spring Boot Actuator provides a convenient solution for logging all HTTP requests and responses in a single place. By customizing the logging interceptor, you can tailor the logged details to meet your specific requirements. This enables you to thoroughly debug issues, analyze performance, and gain insights into your application's interactions with clients.

The above is the detailed content of How can I effectively log HTTP requests and responses, including exceptions, in my Spring Boot application?. For more information, please follow other related articles on the PHP Chinese website!