技術場景
在日常的開發、測試或運維的過程中，經常存在這樣的場景，開發人員在代碼中使用日志工具（log4j、slf4j）記錄日志，比如請求ID、IP等，方便在線上快速、精準的定位問題，通過完整的日志鏈路清晰的進行信息定位。
一般的項目都是分層的、分布式的，在眾多的日志信息中，如何區分哪些日志信息是同一請求發出來的，詳細的實現如下。
技術框架
項目框架：Spring boot
分布式協調：Zookeeper、Dubbo
日志工具：Sf4j
構建工具：Maven
開發工具：IDEA
項目框架
mdc-dubbo-api：接口服務
mdc-dubbo-provider：服務端服務
mdc-dubbo-consumer：消費端服務
項目配置
mdc-dubbo-api
提供一個接口
|
1
2
3
|
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， 打印
|
1
2
3
4
5
6
7
|
@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); } |
Service層：打印TRACE_LOG_ID
|
1
2
3
4
5
|
@Override public String getName(String id) { LOGGER.info("consumer->service->param:{}", id); return orderService.getOrder(id); } |
Filter：
|
1
2
3
4
5
6
7
8
9
|
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<String, String> attachments = invocation.getAttachments(); attachments.put(Constants.TRACE_LOG_ID, logId); return invoker.invoke(invocation); } |
需要過濾器配置在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
|
<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://code.alibabatech.com/schema/dubbo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd"> <!--過濾器配置--> <!-- <dubbo:provider filter="traceFilter" />--> <!-- 應用名--> <dubbo:application name="dmc-dubbo-provider"/> <!--zookeeper注冊中心--> <dubbo:registry address="zookeeper://127.0.0.1:2181"/> <dubbo:protocol name="dubbo" port="20880"/> <!--服務注冊--> <dubbo:service interface="com.bestpay.service.OrderService" ref="orderService" timeout="10000" **filter="traceFilter"**/> <bean id="orderService" class="com.bestpay.provider.service.OrderServiceImpl" /></beans> |
其中filter="traceFilter是引用dobbo目錄下配置中的key
logback配置
|
1
2
3
4
5
6
7
|
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] %logger %line --%mdc{client} [%X{TRACE_LOG_ID}] %msg%n</pattern> <!-- 控制臺也要使用UTF-8，不要使用GBK，否則會中文亂碼 --> <charset>UTF-8</charset> </encoder></appender> |
TRACE_LOG_ID對應放入MDC中的key
mdc-dubbo-provider
配置和## mdc-dubbo-consumer類似，其中在Filter上稍微有些差別
|
1
2
3
4
5
6
7
8
|
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); }} |
項目運行
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:223mdc-dubbo-provider日志：
[2018-12-19 10:16:56] [INFO ] com.bestpay.provider.service.OrderServiceImpl 13 – [d88ecba6581c47b1b3ade78d2821d13a] provider->service->param:223
以上，完成了dubbo分布式服務之間日志的完整鏈路。為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/weixin_39178876/article/details/85088410
