基于日志MDC请求链路跟踪实现

最新推荐文章于 2024-09-07 18:06:33 发布

kinnzen

最新推荐文章于 2024-09-07 18:06:33 发布

阅读量661

点赞数 22

文章标签： spring boot

本文链接：https://blog.csdn.net/zengqzhen/article/details/141197745

版权

实现思路

采用filebeat、logstash、elasticsearch、kibana完成整体的日志收集与分析过程。其中filebeat和logstash用于日志文件的采集，elasticsearch用于日志的存储、kibana负责最终日志数据的查询分析。

有了底层的基础支撑，那么服务之间的链路调用跟踪可简单采用Log日志追踪MDC来实现，实际上就是基于TheadLocal的原理在当前线程能传递一个traceId来进行调用的关联。

日志收集基础环境

具体的filebeat、logstash、elasticsearch、kibana搭建不在这里说明，可参考：手把手教你Windows下搭建Filebeat+Logstash+ElasticSearch+Kibana系统_filebeat windows-CSDN博客

代码实现

（1）application.yml修改

配置文件中需要添加日志路径与日志输出格式的设置，日志路径只是为了让filebeat能够扫描所进行的设置，其他位置都是可以的。日志输出格式的内容中增加了应用名称、通过mdc获取的traceId和时间戳ts

logging:
  file:
    path: 'E:\applicationFile\log\${spring.application.name}'
  pattern:
    level: '%5p [${spring.application.name},%mdc{traceId:-},%mdc{ts:-}]'

（2）增加自定义的过滤器

其中最重要的就是在通过MDC.put方法设置参数，这里我们设置traceId和ts两个参数就可以。

import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;
import java.util.UUID;

@Slf4j
public class MdcFilter implements Filter {


    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        try{
            HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
            String traceId = httpServletRequest.getHeader("traceId");
            if(traceId == null){
                traceId = UUID.randomUUID().toString();
            }
            MDC.put("traceId", traceId);
            MDC.put("ts", String.valueOf(new Date().getTime()));
            log.info(httpServletRequest.getRequestURI()+"call received");
            filterChain.doFilter(servletRequest, servletResponse);
        }finally {
            MDC.clear();
        }
    }

}

（3）注册过滤器Bean

由于采用springboot进行的业务开发，为了让自定义的过滤器能使用，就需要注入的spring容器中。

import com.example.order.filter.MdcFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<MdcFilter> loggingFilter(){
        FilterRegistrationBean<MdcFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new MdcFilter());
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }
}

（4）简单写个Controller

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class TestController {

    @GetMapping("/test")
    public String test(String id){
        log.info("调用test方法，入参：{}",id);
        return "调用成功，id:"+id;
    }
}