结合ELK添加日志跟踪链条

本文已参与「新人创作礼」活动，一起开启掘金创作之路

1、背景

如果是分布式服务，公司系统架构会拆分出多个模块，多个模块之间相互调用比较复杂，模块内部处理也比较多。如果访问量比较大时，不能清晰的描述一个请求的生命周期，报错无法快速定位问题

2、问题处理思路

每次请求在网关处拦截分配一个流水ID，在调用别的模块的时候可以往下一直透传，直到请求完成，清除该traceId。

3、处理

本次处理只是做一个示例，使用一个SpringBoot单体项目的拦截器处理。

创建拦截器TraceInterceptor,主要作用是用来拦截所有的请求,然后在这些请求上的日志类MDC上加入"x-trace-id"

public class TraceInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String traceId = UUID.randomUUID().toString().replace("-","").toUpperCase();
        MDC.put("x-trace-id", traceId);
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
        MDC.remove("x-trace-id");
    }
}

在SpringBoot中配置拦截器springmvc中

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Bean
    public TraceInterceptor initTraceInterceptor() {
        return new TraceInterceptor();
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(initTraceInterceptor()).addPathPatterns("/**");
    }
}

在logback-spring.xml文件里配置"trace": "%X{x-trace-id}"，显示

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <springProperty scope="context" name="SPRING_APPLICATION_NAME" source="spring.application.name"/>
    <springProperty scope="context" name="LOGSTASH_DESTINATION" source="logging.logstash.destination"/>
    <!-- 控制台 appender -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 为logstash输出的JSON格式的Appender -->
    <appender name="logstash" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>${LOGSTASH_DESTINATION}</destination>
        <!-- 日志输出编码 -->
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers>
                <timestamp>
                    <timeZone>UTC</timeZone>
                </timestamp>
                <pattern>
                    <pattern>
                        {
                        "app": "${SPRING_APPLICATION_NAME:-}",
                        "level": "%level",
                        "trace": "%X{x-trace-id}",
                        "span": "%X{X-B3-SpanId:-}",
                        "thread": "%thread",
                        "class": "%logger{40}",
                        "message": "%message"
                        }
                    </pattern>
                </pattern>
            </providers>
        </encoder>
    </appender>
    <!--日志打印的包的范围，及分类日志文件存储 -->
    <logger name="cn.amoqi.springbootelk" additivity="false">
        <level value="DEBUG"/>
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="logstash"/>
    </logger>
    <!--控制台打印资源加载信息-->
    <root level="WARN">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="logstash"/>
    </root>
</configuration>