技术场景

在日常的开发、测试或运维的过程中，经常存在这样的场景，开发人员在代码中使用日志工具（log4j、slf4j）记录日志，比如请求ID、IP等，方便在线上快速、精准的定位问题，通过完整的日志链路清晰的进行信息定位。一般的项目都是分层的、分布式的，在众多的日志信息中，如何区分哪些日志信息是同一请求发出来的，详细的实现如下。

技术框架

项目框架：Spring boot
分布式协调：Zookeeper、Dubbo
日志工具：Sf4j
构建工具：Maven
开发工具：IDEA

项目框架

mdc-dubbo-api：接口服务
mdc-dubbo-provider：服务端服务
mdc-dubbo-consumer：消费端服务

项目配置

mdc-dubbo-api

提供一个接口

public interface OrderService {
String getOrder(String orderid);
}

mdc-dubbo-consumer

在服务端，在Controller层使用MDC工具类放入一个TRACE_LOG_ID信息，在此请求的service层、mdc-dubbo-provider中使用该信息。

项目分为Controller、Service、Filter等各层：
Controller层：存放TRACE_LOG_ID， 打印

@GetMapping("get/{id}")
    public String get(@PathVariable("id") String id){
        String uuid = UUID.randomUUID().toString().replaceAll("-", "");
        MDC.put(Constants.TRACE_LOG_ID, uuid);
        LOGGER.info("controller->param:{}", id);
        return consumerService.getName(id);
    }
1
2
3
4
5
6
7

Service层：打印TRACE_LOG_ID

@Override
    public String getName(String id) {
        LOGGER.info("consumer->service->param:{}", id);
        return orderService.getOrder(id);
    }
1
2
3
4
5

Filter：

public class TraceFilter implements Filter {
@Override
    public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
        //从MDC中获取
        String logId = MDC.get(Constants.TRACE_LOG_ID);
        Map attachments = invocation.getAttachments();
        attachments.put(Constants.TRACE_LOG_ID, logId);
        return invoker.invoke(invocation);
    }
1
2
3
4
5
6
7
8
9

需要过滤器配置在resources->MATE-INF->dobbo文件夹下
![过滤器配置https://img-blog.csdnimg.cn/20181219100406136.png)
traceFilter=com.bestpay.provider.filter.TraceFilter
此处注意 此处使用到了Dubbo中spi机制，文件名必须是com.alibaba.dubbo.rpc.Filter
dubbo配置文件

    
   
    
    
    
    

    
    
    
    


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

其中filter="traceFilter是引用dobbo目录下配置中的key

logback配置

    
        
            [%date{yyyy-MM-dd HH:mm:ss}] [%-5level] %logger %line --%mdc{client} [%X{TRACE_LOG_ID}] %msg%n
            
            UTF-8
        
    
1
2
3
4
5
6
7

TRACE_LOG_ID对应放入MDC中的key

mdc-dubbo-provider

配置和## mdc-dubbo-consumer类似，其中在Filter上稍微有些差别

public class TraceFilter implements Filter {
    @Override
    public Result invoke(Invoker invoker, Invocation invocation) throws RpcException {
        String logId = invocation.getAttachment(Constants.TRACE_LOG_ID);
        MDC.put(Constants.TRACE_LOG_ID, logId);
        return invoker.invoke(invocation);
    }
}
1
2
3
4
5
6
7
8

项目运行

mdc-dubbo-consumer日志：
[2018-12-19 10:16:56] [INFO ] com.bestpay.comsumer.controller.ConsumerController 33 – [d88ecba6581c47b1b3ade78d2821d13a] controller->param:223
[2018-12-19 10:16:56] [INFO ] com.bestpay.comsumer.service.impl.ComsumerServiceImpl 20 – [d88ecba6581c47b1b3ade78d2821d13a] consumer->service->param:223

mdc-dubbo-provider日志：
[2018-12-19 10:16:56] [INFO ] com.bestpay.provider.service.OrderServiceImpl 13 – [d88ecba6581c47b1b3ade78d2821d13a] provider->service->param:223

以上，完成了dubbo分布式服务之间日志的完整链路。

作者简介:就职于甜橙金融信息技术部,负责服务端开发，专注于微服务、分布式、性能调优、高可用，欢迎各位同仁沟通交流。