返回顶部
首页 > 资讯 > 后端开发 > Python >Springboot+MDC+traceId日志中打印唯一traceId
  • 871
分享到

Springboot+MDC+traceId日志中打印唯一traceId

2024-04-02 19:04:59 871人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

目录1. 为什么需要这个traceId 2.通过MDC设置traceId 2.1 使用filter过滤器设置traceId 2.2 使用Jwt token过滤器的项目 2.3 使用I

先看一张图:

在这里插入图片描述

有同学问:日志中[]中类似uuid的这个traceId是怎么实现的,这边文章就介绍下如何在SpringBoot工程下用MDC实现日志文件中打印traceId。

1. 为什么需要这个traceId

我们在定位问题的时候需要去日志中查找对应的位置,当我们一个接口的请求同用唯一的一个traceId,那我们只需要知道这个traceId,使用 grep ‘traceId' xxx.log 语句就能准确的定位到目标日志。在这边文章会介绍如何去设置这个traceId,而后如何在接口返回这个traceId。


#接口返回:
{
    "code": "0",
    "dealStatus": "1",
    "TRACE_ID": "a10e6e8d-9953-4de9-b145-32eee6aa5562"
}
#查询日志
 grep 'a10e6e8d-9953-4de9-b145-32eee6aa5562' xxxx.log

2.通过MDC设置traceId

笔者目前遇到的项目,可以有三种情况去设置traceId。先简单的介绍MDC


 #MDC定义
 Mapped Diagnostic Context,即:映射诊断环境。
 MDC是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。
 MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。
 #MDC的使用方法
 向MDC中设置值:MDC.put(key, value);
 从MDC中取值:MDC.get(key);
 将MDC中内容打印到日志中:%X{key}

2.1 使用filter过滤器设置traceId

新建一个过滤器,实现Filter,重写init,doFilter,destroy方法,设置traceId放在doFilter中,在destroy中调用MDC.clear()方法。


@Slf4j
@WEBFilter(filterName = "traceIdFilter",urlPatterns = "
    private static final String TRACE_ID = "TRACE_ID";
    
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        MDC.put(TRACE_ID, UUID.randomUUID().toString());
        filterChain.doFilter(request, servletResponse);
    }

    @Override
    public void destroy() {
    	MDC.clear();
    }
}


2.2 使用JWT token过滤器的项目

springboot项目经常使用spring security+jwt来做权限限制,在这种情况下,我们通过新建filter过滤器来设置traceId,那么在验证token这部分的日志就不会带上traceId,因此我们需要把代码放在jwtFilter中,如图:



@Component
public class JwtAuthenticationTokenFilter extends OncePerRequestFilter {
    @Autowired
    private TokenService tokenService;

    
    private static final String TRACE_ID = "TRACE_ID";

    @Override
    protected void doFilterInternal(httpservletRequest request, HttpServletResponse response, FilterChain chain)
            throws ServletException, IOException {
        MDC.put(TRACE_ID, UUID.randomUUID().toString());
        LoginUser loginUser = tokenService.getLoginUser(request);
        if (StringUtils.isNotNull(loginUser) && StringUtils.isNull(SecurityUtils.getAuthentication())) {
            tokenService.verifyToken(loginUser);
            UsernamePassWordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(loginUser, null, loginUser.getAuthorities());
            authenticationToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
            SecurityContextHolder.getContext().setAuthentication(authenticationToken);
        }
        chain.doFilter(request, response);
    }
    
    @Override
    public void destroy() {
        MDC.clear();
    }
}

2.3 使用Interceptor拦截器设置traceId

定义一个拦截器,重写preHandle方法,在方法中通过MDC设置traceId



@Component
public abstract class TraceIdInterceptor extends HandlerInterceptorAdapter {
    private static final String UNIQUE_ID = "TRACE_ID";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        MDC.put(UNIQUE_ID, UUID.randomUUID().toString());
        return true;
    }

	@Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        MDC.clear();
    }
}

3.logback.xml中配置traceId

与之前的相比只是添加了[%X{TRACE_ID}], [%X{***}]是一个模板,中间属性名是我们使用MDC put进去的。


#之前
<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />
#增加traceId后
<property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - [%X{TRACE_ID}] - %msg%n" />

4.补充异步方法带入上下文的traceId

异步方法会开启一个新线程,我们想要是异步方法和主线程共用同一个traceId,首先先新建一个任务适配器MdcTaskDecorator,如图:


public class MdcTaskDecorator implements TaskDecorator 
    
    @Override
    public Runnable decorate(Runnable runnable) {
        Map<String,String> map = MDC.getCopyOfContextMap();
        return () -> {
            try{
                MDC.setContextMap(map);
                runnable.run();
            } finally {
                MDC.clear();
            }
        };
    }
}

然后,在线程池配置中增加executor.setTaskDecorator(new MdcTaskDecorator())的设置


 
@EnableAsync
@Configuration
public class ThreadPoolConfig {
    private int corePoolSize = 50;
    private int maxPoolSize = 200;
    private int queueCapacity = 1000;
    private int keepAliveSeconds = 300;

    @Bean(name = "threadPoolTaskExecutor")
    public ThreadPoolTaskExecutor threadPoolTaskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setMaxPoolSize(maxPoolSize);
        executor.setCorePoolSize(corePoolSize);
        executor.setQueueCapacity(queueCapacity);
        executor.seTKEepAliveSeconds(keepAliveSeconds);
        executor.setTaskDecorator(new MdcTaskDecorator());
        // 线程池对拒绝任务(无线程可用)的处理策略
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        return executor;
    }
}

最后,在业务代码上使用@Async开启异步方法即可


    @Async("threadPoolTaskExecutor")
    void testSyncMethod();

5.在接口放回中,增加traceId返回

在笔者项目中,接口返回都使用了一个叫ajaxResult自定义类来包装,所以只需要把这个类的构造器中增加traceId返回即可,相对简单。


   
    private static final String TRACE_ID = "TRACE_ID";
    
    
    public AjaxResult() {
        super.put(TRACE_ID, MDC.get(TRACE_ID));
    }

    
    public AjaxResult(int code, String msg) {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, msg);
        super.put(TRACE_ID, MDC.get(TRACE_ID));
    }

    
    public AjaxResult(int code, String msg, Object data) {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, msg);
        super.put(TRACE_ID, MDC.get(TRACE_ID));
        if (StringUtils.isNotNull(data)) {
            super.put(DATA_TAG, data);
        }
    }

以上就是Springboot+MDC+traceId日志中打印唯一traceId的详细内容,更多关于Springboot 打印唯一traceId的资料请关注编程网其它相关文章!

--结束END--

本文标题: Springboot+MDC+traceId日志中打印唯一traceId

本文链接: https://lsjlt.com/news/154627.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • Springboot+MDC+traceId日志中打印唯一traceId
    目录1. 为什么需要这个traceId 2.通过MDC设置traceId 2.1 使用filter过滤器设置traceId 2.2 使用JWT token过滤器的项目 2.3 使用I...
    99+
    2024-04-02
  • springboot实现打印彩色日志
    springboot打印彩色日志 logback配置 <?xml version="1.0" encoding="UTF-8"?> <confi...
    99+
    2024-04-02
  • python中打印日志
    一、日志介绍 1、日志级别:日志的优先级、重要性或者严重程度 2、日志的作用:调试程序,跟踪定位bug,分析用户行为与数据统计 3、常见的日志级别(从小级别到大级别排序):         debug:调试级别,打印非常详细的日志信息,通常...
    99+
    2023-09-25
    python
  • springboot怎么实现打印彩色日志
    这篇文章主要为大家展示了“springboot怎么实现打印彩色日志”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“springboot怎么实现打印彩色日志”这篇文章吧。springboot打印彩色...
    99+
    2023-06-20
  • springboot打印接口调用日志的实例
    目录概述方案思路封装HttpServletRequest请求把可重复读请求体通过过滤器往下传记录入参日志实现入参记录拦截器注册拦截器记录返参日志概述 请求日志几乎是所有大型企业级项目...
    99+
    2024-04-02
  • springboot如何整合mybatis将sql打印到日志
    这篇文章主要介绍了springboot如何整合mybatis将sql打印到日志,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。在前台请求数据的时候,sql语句一直都是打印到控制...
    99+
    2023-05-30
    mybatis spring boot
  • springboot下mybatis-plus如何打印sql日志和参数到日志文件
    最近在使用springboot过程中用到了mybatis-plus ,springboot版本是2.3.1.RELEASE,mybatis-plus 版本3.2.0。 ...
    99+
    2024-04-02
  • springboot下mybatis-plus怎么打印sql日志和参数到日志文件
    本篇内容主要讲解“springboot下mybatis-plus怎么打印sql日志和参数到日志文件”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“springboot下mybatis-plus怎么...
    99+
    2023-06-29
  • python中如何打印日志信息
    日志打印方式 常见的Python日志打印方式为使用内置函数print()或者logging模块打印日志。 print()只能将日志打印至控制台,不推荐此方式logging模块默认将日志打印至控制台,也...
    99+
    2023-09-05
    python
  • Linux部署springboot项目彩色日志打印方式
    目录Linux部署springboot项目彩色日志打印springboot配置控制台彩色日志输出总结Linux部署springboot项目彩色日志打印 未做处理tail日志log.o...
    99+
    2023-05-14
    Linux部署springboot springboot彩色日志打印 springboot日志打印
  • SpringBoot日志的打印与持久化详细解析
    目录1. 日志有什么用2. 日志怎么用3. Spring Boot 自定义日志的打印3.1 先获取到打印日志对象3.2 使用日志对象打印日志3.3 日志格式说明4. 日志级别5. 日...
    99+
    2024-04-02
  • springboot下mybatisplus开启打印sql日志怎么配置
    本文小编为大家详细介绍“springboot下mybatisplus开启打印sql日志怎么配置”,内容详细,步骤清晰,细节处理妥当,希望这篇“springboot下mybatisplus开启打印sql日志怎么配置”文章能帮助大家解决疑惑,下...
    99+
    2023-07-05
  • linux怎么打印日志到文件中
    在Linux中,可以使用以下命令将日志打印到文件中:1. 使用`echo`命令将日志内容输出到标准输出,并使用重定向符`>`将输出重...
    99+
    2023-10-09
    linux
  • springboot下mybatis-plus开启打印sql日志的配置指南
    需要以下三个配置 1:设置mybatisplus包下的日志级别为DEBUG; logging: level: com: baomidou: m...
    99+
    2023-03-03
    mybatis-plus打印sql日志 mybatisplus开启日志 mybatisplus打印SQL语句
  • Python中的logging模块实现日志打印
    目录方法1:配置并输出日志到标准输出方法2:配置输出到日志文件前言: 大家在写代码的时候,经常会使用print打印日志方便排查问题,然而print的问题就是太过简单,缺少时间、日志级...
    99+
    2024-04-02
  • 在node中如何打印全链路日志
    这篇文章给大家分享的是有关在node中如何打印全链路日志的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。当用户报问题:线上某个功能使用报错时,如何快速准确地定位?当某个请求接口返回...
    99+
    2024-04-02
  • thinkphp中怎么引入ThinkWechat.php并打印日志
    这期内容当中小编将会给大家带来有关thinkphp中怎么引入ThinkWechat.php并打印日志,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。在Index.php中需要引入该文件use app\lib...
    99+
    2023-06-20
  • Java项目中怎么打印错误日志
    这篇文章将为大家详细讲解有关Java项目中怎么打印错误日志,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。1.上层系统引入的非法参数。对于非法参数引入的错误, 可以通过参数校验和前置条件校验来...
    99+
    2023-06-16
  • Android中安全地打印日志的示例
    这篇文章主要介绍了Android中安全地打印日志的示例,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。在Android开发过程中,不管是写Demo还是实战项目中,都会打印一些日...
    99+
    2023-05-30
  • springboot log4j2不能打印框架错误日志的解决方案
    springboot log4j2为什么不能打印框架错误日志 问题 使用springboot时老的框架使用的是log4j2,为了兼容不能够使用logback,按照网上的教程导入了lo...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作