logback和log4j日志框架堆栈信息添加TraceId方式

 更新时间:2023年09月27日 09:27:50   作者:lllllLiangjia  
这篇文章主要介绍了logback和log4j日志框架堆栈信息添加TraceId方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

背景

TraceId是我在项目上自定义的,作为链路追踪来使用。至于为什么没有用市面上skywalking此类现成的链路追踪,是因为目前这个项目是boot单体,也不是分布式,不想引入过多比较复杂的依赖项,造成不必要的维护麻烦。

使用traceId只是来准确定位某个请求的日志信息,自己实现的话比较轻量化,也能够满足项目的开发和维护需求。

当请求访问时,被过滤器拦截到,生成一个唯一的traceId存放在MDC中(分布式项目可以通过请求头获取上游服务传过来的traceId),MDC是ThreadLocal类型线程安全的。

日志xml配置写上traceId会自动读取MDC。

logback日志框架

由于之前项目是使用的logback日志框架,如果只在xml日志文件中配置traceId的话,当报错时候输出的堆栈信息内不会保存traceId。

到时候线上排查问题,无法通过grep命令筛选出来报错的堆栈信息,也就不能快速定位代码中的报错位置。

堆栈信息不携带traceId

xml配置文件中的配置

堆栈信息携带traceId

logback想要在堆栈信息中添加traceId需要继承ThrowableProxyConverter,重写里面的方法。

import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
import ch.qos.logback.classic.spi.IThrowableProxy;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.MDC;
public class CompressedStackTraceConverter extends ThrowableProxyConverter {
    public CompressedStackTraceConverter() {
    }
    @Override
    protected String throwableProxyToString(IThrowableProxy tp) {
        String original = super.throwableProxyToString(tp);
        String traceId = MDC.get("traceId");
        if (StringUtils.isBlank(traceId)) {
            traceId = "";
        }
        traceId = "\t[ably-stack]\t[" + traceId + "]";
        return original.replaceAll("\n", traceId + "\n");
    }
}

此时的xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <conversionRule conversionWord="ex"
                    converterClass="com.example.springbootdemo.configuration.httpglobal.CompressedStackTraceConverter"/>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern xml:space="preserve">
                %d{yyyy-MM-dd HH:mm:ss.SSS}|-|%lsn|-|%thread|-|%X{traceType}|-|%X{traceId}|-|%logger{80}:%L|-|%msg|-|%ex|-|%n
            </pattern>
        </encoder>
    </appender>
    <root level="info">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

这样logback框架就可以打印堆栈信息的时候携带traceId了

log4j日志框架

目前这个新项目使用的log4j这个框架,这里的traceId也是放在MDC中。

堆栈信息不携带traceId

堆栈信息携带traceId

当我配置好traceId后,开始配置堆栈信息中的traceId,发现ThrowableProxyConverter是logback包下面的,无法使用它来添加。

于是我在网上找是否log4j有对应的像logback这种接口可以操作堆栈信息的。无果!(也有可能我没找到)。

后来偶然查到%throwable可以支持更改单个堆栈跟踪元素,我就想可不可以使用它来添加traceId。

通过了解%throwable的常用方法,看到了配合{suffix(pattern)}使用,可以在每个堆栈帧的末尾添加模式输出。

于是抱着试一试的态度就打印traceId,结果是可以的。

对应的traceId在堆栈信息以及主日志中都打印了出来

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • IntelliJ IDEA 2020最新激活码(亲测有效,可激活至 2089 年)

    IntelliJ IDEA 2020最新激活码(亲测有效,可激活至 2089 年

    这篇文章主要介绍了IntelliJ IDEA 2021最新激活码(亲测有效,可激活至 2089 年),非常不错,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-04-04
  • 一文详解Java方法重载与递归应用

    一文详解Java方法重载与递归应用

    方法重载 允许在同一个类中定义多个具有相同名称的方法,但 参数列表 必须不同,递归 是一种让函数调用自身的技术,它提供了一种将复杂问题分解为简单问题的方法,这样更容易解决,本文详细介绍了Java方法重载与递归应用,需要的朋友可以参考下
    2024-02-02
  • java并发编程工具类PriorityBlockingQueue优先级队列

    java并发编程工具类PriorityBlockingQueue优先级队列

    这篇文章主要为大家介绍了java并发编程工具类PriorityBlockingQueue优先级队列的方法示例应用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • Java自动读取指定文件夹下所有文件的方法

    Java自动读取指定文件夹下所有文件的方法

    这篇文章主要为大家详细介绍了Java自动读取指定文件夹下所有文件的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-02-02
  • 详解备忘录模式及其在Java设计模式编程中的实现

    详解备忘录模式及其在Java设计模式编程中的实现

    这篇文章主要介绍了详解备忘录模式及其在Java设计模式编程中的实现,备忘录模式数据的存储过程中应当注意浅拷贝和深拷贝的问题,需要的朋友可以参考下
    2016-04-04
  • java数据随机分页实现方案

    java数据随机分页实现方案

    本文主要介绍了java数据随机分页实现方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-06-06
  • 浅谈Java中的Queue家族

    浅谈Java中的Queue家族

    Java中Collection集合有三大家族List,Set和Queue。当然Map也算是一种集合类,但Map并不继承Collection接口。List,Set在我们的工作中会经常使用,通常用来存储结果数据,而Queue由于它的特殊性,通常用在生产者消费者模式中。今天这篇文章将带大家进入Queue家族。
    2021-06-06
  • 手把手带你粗略了解Java--类和对象

    手把手带你粗略了解Java--类和对象

    这篇文章主要给大家介绍了关于java中类和对象的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-08-08
  • Spring实战之使用@Resource配置依赖操作示例

    Spring实战之使用@Resource配置依赖操作示例

    这篇文章主要介绍了Spring实战之使用@Resource配置依赖操作,结合实例形式分析了Spring使用@Resource配置依赖具体步骤、实现及测试案例,需要的朋友可以参考下
    2019-12-12
  • Java统计50个10到50之间整数的随机出现次数

    Java统计50个10到50之间整数的随机出现次数

    这篇文章主要为大家详细介绍了Java统计50个10到50之间整数的随机出现次数,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-07-07

最新评论