详解如何为SpringBoot Web应用的日志方便追踪

 更新时间:2023年11月01日 08:33:32   作者:JAVA旭阳  
在Web应用程序领域,有效的请求监控和可追溯性对于维护系统完整性和诊断问题至关重要,SpringBoot是一种用于构建Java应用程序的流行框架,在本文中,我们探讨了在SpringBoot中向日志添加唯一ID的重要性,需要的朋友可以参考下

前言

在 Web 应用程序领域,有效的请求监控和可追溯性对于维护系统完整性和诊断问题至关重要。Spring Boot 是一种用于构建 Java 应用程序的流行框架,它提供了强大的日志记录功能,可以通过为每个传入请求合并唯一标识符来进一步丰富这些功能。这种简洁而强大的实践使开发人员能够跟踪和分析单个请求流,从而简化调试并增强整体系统的可靠性。在本文中,我们探讨了在 Spring Boot 中向日志添加唯一 ID 的重要性,深入了解其实现以及它为应用程序开发和维护带来的众多好处。

问题

如今,我们通常为每项服务配备多个服务器。现在有两种检查日志的方法,第一种是进入单个服务器实例并检查日志。还有另一种方法可以从所有服务器收集日志,并且可以在一个地方查看它们。人们通常使用第二种方法来搜索和分析日志。现在,单个服务的多个服务器有如此多的日志,跟踪日志变得很困难。

此外,即使我们有一个服务的单个服务器,由于并发请求/线程,也会打印许多日志。面临的一个主要问题是跟踪,因为日志以交错方式打印。跟踪打印的日志变得非常困难。

解决方案

为了解决上述问题,我们需要某种与每个日志条目关联的标识符。我们可以生成一个唯一的 ID,然后将该 ID 分配给特定请求的所有日志。因此,为特定请求生成的所有日志都将具有唯一的 ID。借助这个ID,我们可以轻松地通过日志进行追踪。我们可以在日志中搜索这个ID并获取特定请求的所有日志。为了在 Spring Boot 中实现这一点,我们可以使用 AOP。

面向方面编程(AOP)是一种编程范式,允许开发人员将横切关注点(例如日志记录、安全性和事务管理)模块化,与核心业务逻辑分开,从而提高代码的可重用性和可维护性。它通过引入“方面”来实现这一点,这些“方面”可以应用于代码库的不同部分,而无需更改原始代码。

首先,您必须创建一个如下所示的请求过滤器。

/**
 * A filter that adds a key to the Mapped Diagnostic Context (MDC) to each request so you can print a unique id in the log messages of each request
 **/
@EqualsAndHashCode(callSuper = false)
@Component
@Slf4j
public class Slf4jMDCFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(final HttpServletRequest request, final HttpServletResponse response, final FilterChain chain) {
        try {
            MDC.put(MDC_UUID_TOKEN_KEY, UUID.randomUUID().toString());
            chain.doFilter(request, response);
        } catch (Exception ex) {
            log.error(ERROR_FORMAT, "Exception occurred in filter while setting UUID for logs", ex);
        } finally {
            MDC.remove(MDC_UUID_TOKEN_KEY);
        }
    }

    @Override
    protected boolean isAsyncDispatch(final HttpServletRequest request) {
        return false;
    }

    @Override
    protected boolean shouldNotFilterErrorDispatch() {
        return false;
    }
}

上述代码针对每个 API 请求运行一次,并将相同的唯一 ID 添加到为特定请求生成的所有日志中。接下来,您必须将上述 AOP 过滤器注册为 bean,如下所示:

@Configuration
@RequiredArgsConstructor
public class BeanConfig {
    private final Slf4jMDCFilter slf4jMDCFilter;

    @Bean
    public FilterRegistrationBean<Slf4jMDCFilter> servletRegistrationBean() {
        final FilterRegistrationBean<Slf4jMDCFilter> filterRegistrationBean = new FilterRegistrationBean<>();
        filterRegistrationBean.setFilter(slf4jMDCFilter);
        filterRegistrationBean.setOrder(2);
        return filterRegistrationBean;
    }
}

之后,您需要在日志文件中添加一个附加程序,如下所示:

<appender name="Console"
  class="ch.qos.logback.core.ConsoleAppender">
  <layout class="ch.qos.logback.classic.PatternLayout">
    <Pattern>
      %black(%d{ISO8601}) %X{Slf4jMDCFilter.UUID} %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable
    </Pattern>
  </layout>
</appender>

总结

在 Spring Boot 中为每个请求在日志中实现唯一的 ID 可以通过关联应用程序不同组件之间的日志来实现更好的可跟踪性和调试,特别是在并发场景中。这个唯一的标识符有助于跟踪请求流、识别潜在问题并提高整体系统的可观察性。

以上就是详解如何为Spring Boot Web应用的日志方便追踪的详细内容,更多关于Spring Boot Web日志追踪的资料请关注脚本之家其它相关文章!

相关文章

  • Spring Boot 拦截器帮助解锁5种常用场景(推荐)

    Spring Boot 拦截器帮助解锁5种常用场景(推荐)

    在SpringBoot中,拦截器用于在请求处理前后插入自定义逻辑,实现权限校验、日志记录、性能监控等功能,本文给大家介绍Spring Boot 拦截器帮助解锁5大实用场景,感兴趣的朋友跟随小编一起看看吧
    2026-01-01
  • Java中的数组流ByteArrayOutputStream用法

    Java中的数组流ByteArrayOutputStream用法

    Java中的ByteArrayOutputStream是java.io包中的一个类,用于在内存中创建字节数组缓冲区,支持动态扩展,它继承自OutputStream,允许以字节形式写入数据,无需与外部设备交互,常用方法包括write()、toByteArray()、toString()等
    2024-09-09
  • 深入了解Java.Util.Date详情

    深入了解Java.Util.Date详情

    这篇文章主要介绍了Java.Util.Date,很少有类能像java.util.Date那样在堆栈溢出方面引起如此多的类似问题,关于具体原因下文内容详细介绍,需要的朋友可以参考一下
    2022-06-06
  • 如何基于sqlite实现kafka延时消息详解

    如何基于sqlite实现kafka延时消息详解

    这篇文章主要给大家介绍了关于如何基于sqlite实现kafka延时消息的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-01-01
  • Spring中的@ExceptionHandler注解详解与应用示例

    Spring中的@ExceptionHandler注解详解与应用示例

    本文详细介绍了Spring框架中的@ExceptionHandler注解的用法,包括基本用法、全局异常处理、结合@ResponseStatus注解以及返回值类型,通过示例展示了如何使用@ExceptionHandler注解处理不同类型的异常,并提供定制化的异常处理响应,需要的朋友可以参考下
    2024-11-11
  • java中Swing五种常见的布局方式

    java中Swing五种常见的布局方式

    本文通过代码示例给大家详细讲解了java中Swing五种常见的布局方式,以及相关注意知识点,有兴趣的朋友参考学习下。
    2018-03-03
  • @Autowired注入为null的原因与解决方法

    @Autowired注入为null的原因与解决方法

    我们经常会通过@Autowired注解将某个类注到另一个类中,但是会发现注不进去,报NULL,所以本文就给大家分析了@Autowired 注入为null 的原因与解决方法,需要的朋友可以参考下
    2023-09-09
  • Java CAS底层实现原理实例详解

    Java CAS底层实现原理实例详解

    这篇文章主要介绍了Java CAS底层实现原理实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • java数据类型与二进制详细介绍

    java数据类型与二进制详细介绍

    这篇文章主要介绍了java数据类型与二进制详细介绍的相关资料,这里对数据类型进行了一一介绍分析,并说明自动转换和强制转换,需要的朋友可以参考下
    2017-07-07
  • 深入剖析Java之String字符串

    深入剖析Java之String字符串

    这篇文章主要为大家详细介绍了Java之String字符串,重新带大家认识String字符串,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07

最新评论