springboot项目日志使用MDC添加TraceId--688IT编程网

springboot项⽬⽇志使⽤MDC添加TraceId

0. ⽇志打印添加traceid, 每次请求有不同的traceId

1. 引⼊springboot的aop, web

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

<version>2.3.4.RELEASE</version>

</dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-aop</artifactId>

<version>2.3.4.RELEASE</version>

</dependency>

2. 编写

demo.interceptor;

slf4j.Slf4j;

import org.slf4j.MDC;

import org.springframework.util.StringUtils;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.util.UUID;

/**

* ⽇志⽣成THREAD_ID，供⽇志打印和返回对象使⽤

* @Author: zy

@Slf4j

public class LogInterceptor implements HandlerInterceptor {

/**

* 线程ID常量

public static final String THREAD_ID = "THREAD_ID";

/**

* controller⽅法前调⽤

@Override

public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {

log.debug("preHandle running ...");

// 使⽤UUID⽣成唯⼀编号

String threadId = UUID.randomUUID().toString().trim().replaceAll("-", "");

// 判断MDC(log4j中的上下⽂对象) 中是否有该threadId

if (StringUtils.(THREAD_ID))) {

// 如果没有，添加

MDC.put(THREAD_ID, threadId);

}

// 永远返回truespring ioc注解

return true;

}

/**

* preHandle⽅法返回true之后

* 在controller⽅法处理完之后调⽤

@Override

public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object, ModelAndView modelAndView) throws Exception { log.debug("postHandle running ...");

//controller结束之后删除对应的唯⼀值

}

/**

* preHandle⽅法返回true之后

* 在DispatcherServlet进⾏视图的渲染之后调⽤

@Override

public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServle

tResponse, Object object, Exception e) throws Exception {

log.debug("afterCompletion running ...");

}

3. 编写Config类, 将LogInterceptor添加到容器

fig;

demo.interceptor.LogInterceptor;

import t.annotation.Bean;

import t.annotation.Configuration;

import org.springframework.fig.annotation.EnableWebMvc;

import org.springframework.fig.annotation.InterceptorRegistry;

import org.springframework.fig.annotation.ResourceHandlerRegistry;

import org.springframework.fig.annotation.WebMvcConfigurer;

/**

* ⽣产traceid的LogInterceptor到容器

* @Author: zy

@Configuration

@EnableWebMvc

public class WebMvcConfig implements WebMvcConfigurer {

/**

* 注解LogInterceptor类到IOC容器中

@Bean

public LogInterceptor logInterceptor() {

return new LogInterceptor();

}

@Override

public void addInterceptors(InterceptorRegistry registry) {

//注册⽇志

registry.addInterceptor(logInterceptor());

}

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

/**

* 解决 webmvc 与 swagger 页⾯冲突的问题

* blog.csdn/Kerwin_luo/article/details/114266444

* @param registry

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/ /webjars/");

//添加静态页⾯资源，⽂件下载资源等

registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/",

"classpath:/resources/", "classpath:/static/", "classpath:/public/","file:/E:/","file:/");

}

4. 编写aop

demo.aop;

le.gson.Gson;

demo.bean.BaseResponse;

demo.interceptor.LogInterceptor;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.ProceedingJoinPoint;

import org.aspectj.lang.annotation.*;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.slf4j.MDC;

import org.springframework.stereotype.Component;

import org.t.request.RequestContextHolder;

import org.t.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@Aspect

@Component

public class aopWebLogAspect {

private final static Logger LOGGER = Logger(aopWebLogAspect.class);

/**

* 以Controller包下定义所有请求的⽅法

@Pointcut("execution(public * demo..*Controller.*(..)) ")

private void webLog() {

}

/**

* 在切⼊点之前进⾏

@Before("webLog()")

public void doBefore(JoinPoint joinPoint) {

ServletRequestAttributes attributes = (ServletRequestAttributes) RequestAttributes();

HttpServletRequest request = Request();

LOGGER.info("========================================== Start ==========================================");

//打印请求参数相关⽇志

// 打印请求 url

LOGGER.info("url:{}", RequestURI());

// 打印 Http method

LOGGER.info("HTTP Method:{}", Method());

// 打印调⽤ controller 的全路径以及执⾏⽅法

LOGGER.info("Class Method:{}.{}", Signature().getDeclaringTypeName(), Signature().getName());

// 打印请求的 IP

LOGGER.info("IP :{}", RemoteAddr());

// 打印请求⼊参

LOGGER.info("Request Args:{}", new Gson().Args()));

}

/**

* 在切⼊点之后执⾏

@After("webLog()")

public void doAfter() {

LOGGER.info("========================================== end ==========================================");

}

@Around("webLog()")

public Object doAroud(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {

long startTime = System.currentTimeMillis();

BaseResponse result = (BaseResponse) proceedingJoinPoint.proceed();

if (result != null) {

// 将线程id赋值给返回的traceId

result.(LogInterceptor.THREAD_ID));

//打印出参

LOGGER.info("Response Args : {}", new Gson().toJson(result));

// 执⾏耗时

LOGGER.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);

}

return result;

}

5. 拷贝l到resources⽬录下

配置⽂件中使⽤ %X{THREAD_ID}

<?xml version="1.0" encoding="UTF-8"?>

<!-- debug：当此属性设置为true时，

将打印出logback内部⽇志信息，实时查看logback运⾏状态。默认值为false。 -->

<contextName>logback</contextName>

<!--<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logb

ack.WhitespaceThrowableProxyConverter" />-->

<property name="CONSOLE_LOG_PATTERN"

value="%red(%d{yyyy-MM-dd HH:mm:ss.SSS})-%green([%X{THREAD_ID}])-%highlight(%-5level[%4line])-%boldMagenta(%logger{10}) : %cyan(%msg%n)"/>

<property name="FILE_LOG_PATTERN"

value="%d{yyyy-MM-dd HH:mm:ss.SSS}-[%X{THREAD_ID}]-%-5level[%4line] - %logger{10} - %msg%n"/>

</filter>

<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>

</encoder>

</appender>

<file>${log.path}/devops-cloud.log</file>

<fileNamePattern>./log/devops-cloud.%i.log.zip</fileNamePattern>

</rollingPolicy>

</triggeringPolicy>

<Pattern>^A[%date{yyyy-MM-dd HH:mm:ss.SSS}]-[%X{THREAD_ID}] [%level] [DEVOPS-CLOUD] [%t] %msg %n</Pattern>

</encoder>

</appender>

<!--

<logger>⽤来设置某⼀个包或者具体的某⼀个类的⽇志打印级别、

以及指定<appender>。<logger>仅有⼀个name属性，

⼀个可选的level和⼀个可选的addtivity属性。

name:⽤来指定受此logger约束的某⼀个包或者具体的某⼀个类。

level:⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

还有⼀个特俗值INHERITED或者同义词NULL，代表强制执⾏上级的级别。

如果未设置此属性，那么当前logger将会继承上级的级别。

addtivity：是否向上级logger传递打印信息。默认是true。

<!--

使⽤mybatis的时候，sql语句是debug下才会打印，⽽这⾥我们只配置了info，所以想要查看sql语句的话，有以下两种操作：第⼀种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样⽇志那边会出现很多其他消息

第⼆种就是单独给dao下⽬录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：

-->

<!--

root节点是必选节点，⽤来指定最基础的⽇志输出级别，只有⼀个level属性

level:⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，

不能设置为INHERITED或者同义词NULL。默认是DEBUG

可以包含零个或多个元素，标识这个appender将会添加到这个logger。

-->

<appender-ref ref="CONSOLE" />

<appender-ref ref="dailyRollingFileAppender" />

</root>

</configuration>

688IT编程网

springboot项目日志使用MDC添加TraceId

发表评论

推荐文章

negotiable certificates of deposits -回复

trandate翻译 -回复

tenoke翻译 -回复

避免合同倒签的方法

cut down the transaction cost

热门文章

cas regexregisteredservice 票根 -回复

SSD硬盘日常维护和Trim

truncate 函数

deployment删除流程

bankaccount类banktransaction -回复

Computer arrangement using non-refreshed dram

kotlin copyonwritearraylist -回复

PACKET LOSS TOLERANT RESHAPING METHOD

COMPUTING MECHANISM FOR PREVENTION OF COLUMN TRUNC

Chain-stopped unsaturated polyester resin

TruncateTable用法

[宝典]MSSQL数据库修复方法

翻译学习积累

命令翻译

专四词汇精讲讲义曲根

TD英文对照

Deployable truss having second order augmentation

托福词汇介绍之四胞胎quadruplets

物流行业术语的英文翻译概要

premature truncating mutations -回复

最新文章

trandate翻译 -回复

tenoke翻译 -回复

避免合同倒签的方法

cut down the transaction cost

pronoun-antecedent agreement -回复

recurring transaction authority -回复

标签列表