Effective logging is essential for debugging, monitoring, and maintaining applications. Let us delve into understanding how Spring Boot can centralize HTTP logging and how it helps track requests, responses, and exceptions effectively.<\/p>\n
Logging<\/a> is a crucial part of any application. It helps developers track HTTP requests, responses, and exceptions to debug issues effectively. Proper logging ensures better maintainability and faster issue resolution.<\/p>\n Spring Boot Actuator<\/a> provides production-ready features such as monitoring and logging. It offers various built-in endpoints to track application health, performance, and runtime configurations.<\/p>\n Spring Boot Actuator is a powerful tool that enhances observability, making it easier to manage and debug applications in production.<\/p>\n To enable Actuator, add the following dependency in your To expose all Actuator endpoints for monitoring and debugging, add the following configuration to your With this setup, Spring Boot will log incoming requests at the DEBUG level.<\/p>\n To log requests and responses in detail, create a custom filter:<\/p>\n The To log exceptions globally, create an exception handler using \n
1.1 Best Practices for Effective Logging<\/h2>\n
\n
TRACE<\/code>, DEBUG<\/code>, INFO<\/code>, WARN<\/code>, and ERROR<\/code>.<\/li>\n1.2 What is Spring Boot Actuator?<\/h3>\n
1.2.1 Common Actuator Endpoints<\/h4>\n
\n
\/actuator\/health<\/code> – Displays the application’s health status.<\/li>\n\/actuator\/loggers<\/code> – Allows dynamic configuration of logging levels at runtime.<\/li>\n\/actuator\/httptrace<\/code> – Logs recent HTTP requests and responses (needs to be enabled in properties).<\/li>\n\/actuator\/metrics<\/code> – Provides application metrics such as memory usage, CPU load, and active threads.<\/li>\n\/actuator\/info<\/code> – Displays custom application information (can be configured in application.properties<\/code>).<\/li>\n\/actuator\/env<\/code> – Shows the environment properties of the application.<\/li>\n<\/ul>\n1.2.2 Benefits of Using Spring Boot Actuator<\/h4>\n
\n
<\/a>2. Code Example<\/h2>\n
2.1 Maven Dependencies<\/h3>\n
pom.xml<\/code>:<\/p>\n<dependencies>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-web<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>org.springframework.boot<\/groupId>\n <artifactId>spring-boot-starter-actuator<\/artifactId>\n <\/dependency>\n <dependency>\n <groupId>ch.qos.logback<\/groupId>\n <artifactId>logback-classic<\/artifactId>\n <\/dependency>\n<\/dependencies>\n<\/pre>\n
2.2 Enable Actuator in application.properties<\/h3>\n
application.properties<\/code> or application.yml<\/code> file:# Expose all actuator endpoints\nmanagement.endpoints.web.exposure.include=*\n# Enable the \/actuator\/loggers endpoint for runtime logging level changes\nmanagement.endpoint.loggers.enabled=true\n# Enable detailed request logging for debugging\nlogging.level.org.springframework.web.filter.CommonsRequestLoggingFilter=DEBUG\n<\/pre>\n
2.3 Create a Custom Logging Filter<\/h3>\n
import org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport org.springframework.stereotype.Component;\n\nimport javax.servlet.Filter;\nimport javax.servlet.FilterChain;\nimport javax.servlet.ServletException;\nimport javax.servlet.ServletRequest;\nimport javax.servlet.ServletResponse;\nimport javax.servlet.http.HttpServletRequest;\nimport javax.servlet.http.HttpServletResponse;\nimport java.io.IOException;\n\n@Component\npublic class LoggingFilter implements Filter {\n private static final Logger logger = LoggerFactory.getLogger(LoggingFilter.class);\n\n @Override\n public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)\n throws IOException, ServletException {\n HttpServletRequest httpRequest = (HttpServletRequest) request;\n HttpServletResponse httpResponse = (HttpServletResponse) response;\n\n logger.info(\"Incoming Request: [{}] {}\", httpRequest.getMethod(), httpRequest.getRequestURI());\n\n chain.doFilter(request, response);\n\n logger.info(\"Outgoing Response: Status={}\", httpResponse.getStatus());\n }\n}\n<\/pre>\n2.3.1 Code Explanation<\/h4>\n
LoggingFilter<\/code> class is a Spring Boot component that implements the Filter<\/code> interface to log incoming HTTP requests and outgoing responses. Annotated with @Component<\/code>, it is automatically detected as a Spring-managed bean. Inside the doFilter<\/code> method, the request and response objects are cast to HttpServletRequest<\/code> and HttpServletResponse<\/code>, respectively. Before forwarding the request down the filter chain using chain.doFilter(request, response)<\/code>, it logs the HTTP method and request URI using SLF4J’s logger. After the request is processed, it logs the HTTP response status, helping with debugging and monitoring API traffic.<\/p>\n2.4 Create a Global Exception Handler<\/h3>\n
@ControllerAdvice<\/code>:<\/p>\nimport org.slf4j.Logger;\nimport org.slf4j.LoggerFactory;\nimport org.springframework.http.HttpStatus;\nimport org.springframework.http.ResponseEntity;\nimport org.springframework.web.bind.annotation.ExceptionHandler;\nimport org.springframework.web.bind.annotation.RestControllerAdvice;\n\n@RestControllerAdvice\npublic class GlobalExceptionHandler {\n\n private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);\n\n @ExceptionHandler(Exception.class)\n public ResponseEntity<String> handleException(Exception e) {\n logger.error(\"Exception occurred: {}\", e.getMessage());\n return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)\n .body(\"An error occurred: \" + e.getMessage());\n }\n}\n<\/pre>\n2.4.1 Code Explanation<\/h4>\n