基于Dubbo的分布式服务日志追踪实现

叁歲伎倆 2022-02-14 10:57 329阅读 0赞

#### 日志系统中的`MDC`可以在服务内部提供很好的日志追踪支持。 ####

MDC.put(C.LOG.TRACE_ID, "唯一标识串");

#### 但是分布式（RPC）的情况下，如何实现呢？ ####

以`Dubbo`为例，我们可以借助Dubbo的上下文信息`RpcContext`配合Dubbo的SPI扩展实现`扩展拦截器`来完成服务间的日志追踪。

#### 一、上下文信息 ####

上下文中存放的是当前调用过程中所需的环境信息。  
`RpcContext` 是一个 `ThreadLocal` 的临时状态记录器，当接收到 RPC 请求，或发起 RPC 请求时，`RpcContext` 的状态都会变化。

比如：A 调 B，B 再调 C，则 B 机器上，在 B 调 C 之前，RpcContext 记录的是 A 调 B 的信息，在 B 调 C 之后，RpcContext 记录的是 B 调 C 的信息。

#### 二、拦截器拓展 ####

服务提供方和服务消费方调用过程拦截，Dubbo 本身的大多功能均基于此扩展点实现，每次远程方法执行，该拦截都会被执行，请注意对性能的影响。

关于拦截器拓展的具体实现可以参考[Dubbo官网\[调用拦截扩展\]][Dubbo]

#### 三、基于Dubbo实现服务追踪 ####

其实现思路很简单，参考下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzNDA0Mzk1_size_16_color_FFFFFF_t_70]

###### 1、Rpc消费方实现 ######

(1)消费端过滤器实现（需要实现）`com.alibaba.dubbo.rpc.Filter接口`：

import com.alibaba.dubbo.rpc.*;
    import org.slf4j.MDC;
    
    /** * @author wangcw * @create 2019-04-26 09:45 * @description：消费端请求服务前通过过滤器 **/
    public class RpcConsumeFilter implements Filter { 
    
        //仅需要实现其invoke()方法即可
        @Override
        public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException { 
            // 传递日志唯一标识
            String traceId = MDC.get("mdc_trace_id");
            RpcContext.getContext().setAttachment("mdc_trace_id", traceId);
            return invoker.invoke(invocation);
        }
    }

(2)定义过滤器缩略名（注意存放位置为：`src/main/resources/META-INF/dubbo/org.apache.dubbo.rpc.Filter`）：

org.apache.dubbo.rpc.Filter文件内容

comsumeFilter=com.xxx.dubbo.RpcConsumeFilter

（3）最后就是将过滤器配置到dubbo配置文件中（官方提供两种方式，选其一即可）：

<dubbo:reference filter="comsumeFilter" />
    
    <dubbo:consumer filter="comsumeFilter"/>

###### 2、Rpc提供方实现 ######

(1)提供方过滤器实现（需要实现）`com.alibaba.dubbo.rpc.Filter接口`：

import com.alibaba.dubbo.rpc.*;
    import org.slf4j.MDC;
    
    /** * @author wangcw * @create 2019-04-26 10:37 * @description：服务端被调用前通过过滤器 **/
    public class RpcProviderFilter implements Filter { 
    
        //仅需要实现其invoke()方法即可
        @Override
        public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException { 
            String traceId = RpcContext.getContext().getAttachment("mdc_trace_id");
            //存放到Slf4j的Mdc容器
            MDC.put("mdc_trace_id", traceId);
            return invoker.invoke(invocation);
        }
    }

(2)定义过滤器缩略名

org.apache.dubbo.rpc.Filter文件内容：

providerFilter=com.xxx.dubbo.RpcProviderFilter

(3)配置文件，以下二选一即可：

<dubbo:service filter="providerFilter" />
    
    <dubbo:provider filter="providerFilter"/>

[Dubbo]: http://dubbo.apache.org/zh-cn/docs/dev/impls/filter.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzNDA0Mzk1_size_16_color_FFFFFF_t_70]: /images/20220214/7578d50284464aa3be3e49833c9ca469.png