日志框架:基于Logback实现链路追踪

简介: 日志框架:基于Logback实现链路追踪

引言:链路追踪目的

每一个前端请求下的所有的日志信息都可以基于一个TraceId号,在我们服务器日志中,串联起来,方便查看程序运行和问题排查。

具体技术内容

Aop/Filter && Logback

具体操作

1、引入依赖

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>${org.slf4j}</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>${ch.qos.logback}</version>
</dependency>

2、 生产TraceId放置到MDC变量中

通过随机数生成traceId

我们的目的就是为了生成一个随机的完成线程下的链路ID,这里我们仅仅是举例说明,大家自行采取手段即可。

package com.taikang.trace.support;
import java.util.Base64;
import java.util.UUID;
public abstract class AbstractUUIDShort {
    /**生成唯一ID*/
    public static String generate() {
        UUID uuid = UUID.randomUUID();
        return compressedUUID(uuid);
    }
}

基于过滤器或者Aop实现Mdc赋值

1、通过过滤器实现

import com.baomidou.mybatisplus.core.toolkit.IdWorker;
import org.slf4j.MDC;
import javax.servlet.*;
import java.io.IOException;
public class LogFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 生成一个链路ID
        String traceId = AbstractUUIDShort.generate();
        // 放置此ID入MDC
        MDC.put("traceId",traceId);
        try {  
            chain.doFilter(request,response);  
        } finally {  
            MDC.clear();//must be,threadLocal  
        }  
    }
}

2、基于Aop实现

// 配置class的环绕通知,使用在方法aspect()上注册的切入点
    @Around(value = "logPoincut()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 生成一个链路ID
        String traceId = AbstractUUIDShort.generate();
        // 放置此ID入MDC
        MDC.put("traceId",traceId);
        //实际业务
        Object resultObj = joinPoint.proceed();
        try {  
            chain.doFilter(request,response);  
        } finally {  
            MDC.clear();//must be,threadLocal  
        }  
        return resultObj;
    }

3、配置Logback实现traceId的日志输出

<!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder charset="UTF-8">
            <!-- 输出日志记录格式,并打印 trace-id -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%trace-id] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

注意事项:MDC赋值之后,在我们的业务执行完毕之后,关键信息打印完毕之后,我们需要调用MDC.clear()方法,保证当我们MDC变量被线程池复用的时候,继续装入新的traceId和线程结束之后被清除掉。

至此:我们已经将一个http请求在后台服务器中打印的所有info级别的日志,使用一个traceId号串联起来,方便问题排查。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
2月前
|
XML Java 数据格式
【二十九】springboot整合logback实现日志管理
【二十九】springboot整合logback实现日志管理
61 1
|
4月前
|
存储 Java 数据库
若依框架----源码分析(@Log)
若依框架----源码分析(@Log)
287 0
|
4月前
|
Java Spring
【Spring Boot】logback和log4j日志异常处理
【1月更文挑战第25天】【Spring Boot】logback和log4j日志异常处理
|
1天前
|
XML Java Maven
Springboot整合与使用log4j2日志框架【详解版】
该文介绍了如何在Spring Boot中切换默认的LogBack日志系统至Log4j2。首先,需要在Maven依赖中排除`spring-boot-starter-logging`并引入`spring-boot-starter-log4j2`。其次,创建`log4j2-spring.xml`配置文件放在`src/main/resources`下,配置包括控制台和文件的日志输出、日志格式和文件切分策略。此外,可通过在不同环境的`application.yml`中指定不同的log4j2配置文件。最后,文章提到通过示例代码解释了日志格式中的各种占位符含义。
|
7天前
|
运维 监控 前端开发
[SpringAop + Logback +MDC] 现网必备全链路日志追踪
[SpringAop + Logback +MDC] 现网必备全链路日志追踪
|
19天前
|
Java Spring
日志之旅:深入Spring整合Logback的高效日志管理
日志之旅:深入Spring整合Logback的高效日志管理
20 2
|
2月前
|
监控 Java 测试技术
日志框架到底是Logback 还是 Log4j2
日志框架到底是Logback 还是 Log4j2
20 0
|
2月前
|
Java
使用logback异步打印日志
使用logback异步打印日志
使用logback异步打印日志
|
3月前
|
监控 前端开发
QGS
|
4月前
|
Java 数据库连接 Apache
Springboot日志框架logback与log4j2
Springboot日志框架logback与log4j2
QGS
42 0