问题及解决
问题
当线上环境出现问题需要捞日志排查原因时，如何能一次性捞出整个接口的全部日志呢？ 接口中开启线程并打印了日志，在获取接口全部日志时如何捞出线程中的日志呢？
解决方案
使用我们今天讲到的traceId为日志加入Id来区分
官网手册
源码
//创建拦截器并拦截所有请求，为其生成traceId
@Component
public class TraceIdInterceptor extends HandlerInterceptorAdapter {
private static final String TRACE_ID = "traceId";
String pathPatterns = "/**";
List<String> excludeURL = new ArrayList<String>();
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String traceId = String.format("%s", UUID.fastUUID().toString(true));
MDC.put(TRACE_ID, traceId);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
MDC.remove(TRACE_ID);
}
}
拦截请求traceId
@Component
public class InterceptorAdapter extends WebMvcConfigurerAdapter {
@Autowired
private TraceIdInterceptor traceIdInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册拦截器
InterceptorRegistration ir = registry.addInterceptor(traceIdInterceptor);
// 配置拦截的路径
ir.addPathPatterns(traceIdInterceptor.pathPatterns);
// 配置不拦截的路径
//ir.excludePathPatterns(traceIdInterceptor.excludeURL);
}
}
//或者
@Configuration
public class MvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new TraceIdInterceptor()).addPathPatterns("/**");
}
}
//异步创建traceId工具
public class ThreadMdcUtils {
public static Runnable wrapAsync(Runnable task, Map<String,String> context){
return () -> {
if(context==null){
MDC.clear();
}else {
MDC.setContextMap(context);
}
if(MDC.get("traceId")==null){
MDC.put("traceId", UUID.fastUUID().toString(true));
}
try {
task.run();
}finally {
MDC.clear();
}
};
}
}
//线程池异步处理配置
@Configuration
public class AsyncConfig implements AsyncConfigurer {
@Bean
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(10);
executor.setMaxPoolSize(20);
executor.setQueueCapacity(20);
executor.setKeepAliveSeconds(60);
executor.setThreadNamePrefix("user-async-");
// 等待所有任务结果候再关闭线程池
executor.setWaitForTasksToCompleteOnShutdown(true);
executor.setAwaitTerminationSeconds(60);
// 定义拒绝策略
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
//设置线程装饰器
executor.setTaskDecorator(runnable -> ThreadMdcUtils.wrapAsync(runnable, MDC.getCopyOfContextMap()));
// 初始化线程池, 初始化 core 线程
executor.initialize();
return executor;
}
}
//线程池获取线程执行业务
new Thread 改为 new AsyncConfig().getAsyncExecutor().execute(new Runnable() {});
<!-- logback.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoder 默认配置为PatternLayoutEncoder -->
<encoder>
<pattern>%d{yy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{36}-%L -%msg%n</pattern>
</encoder>
</appender>
<appender name="err"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/error.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--每日备份日志存储格式和位置 -->
<fileNamePattern>logs/bak/error.%d{yyyy-MM-dd}.log</fileNamePattern>
<!--最大保存天数 -->
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<MaxFileSize>20MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> -->
<encoder>
<pattern>%d{yy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger-%L -%msg%n</pattern>
</encoder>
</appender>
<appender name="warn"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/warn.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>WARN</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/bak/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{36}-%L -%msg%n</pattern>
</encoder>
</appender>
<appender name="suc"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/success.log</file>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/bak/success.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>5</maxHistory>
</rollingPolicy>
<!-- <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<MaxFileSize>20MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> -->
<encoder>
<pattern>%d{yy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{36}-%L -%msg%n</pattern>
</encoder>
</appender>
<appender name="bug"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/debug.log</file>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logs/bak/debug.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!-- <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<MaxFileSize>20MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> -->
<encoder>
<pattern>%d{yy-MM-dd HH:mm:ss.SSS} [%thread] [%X{traceId}] %-5level %logger{36}-%L -%msg%n</pattern>
</encoder>
</appender>
<root level="info">
<!-- <level value="error" /> <level value="info" /> -->
<appender-ref ref="suc" />
<appender-ref ref="err" />
<appender-ref ref="warn" />
<appender-ref ref="bug" />
<appender-ref ref="STDOUT" />
</root>
</configuration>
