扩展dubbo的filter接口实现链路信息上报给zipkin

最新推荐文章于 2024-04-21 10:15:00 发布

xiongxianze

最新推荐文章于 2024-04-21 10:15:00 发布

阅读量897

点赞数

分类专栏： 1====>Java 文章标签： dubbo zipkin 分布式链路追踪

本文链接：https://blog.csdn.net/xiongxianze/article/details/87214180

版权

1====>Java 专栏收录该内容

85 篇文章 1 订阅

订阅专栏

一, 链路追踪的意义

一个分布式的系统, 由后台多个服务组成, 而一次请求会涉及到调用许多服务, 各服务又是分布式部署在各个节点, 这样对出了问题定位问题, 线上问题的处理是非常复杂, 费劲的. 通过分布式链路追踪可以很好的定位一次请求的调用链, 服务调用的流程信息, 服务响应时间, 服务的执行时间, 服务是否超时等.

比较好的一些分布式链路追踪框架有, zipkin, 美团点评的cat, skywalking, 京东的hydra(与dubbo结合密切). 本文将扩展dubbo的filter接口使用brave向zipkin上报数据, 以图形的形式展示链路调用信息.

二, 下载zipkin并启动.

wget -O zipkin.jar 'https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec' java -jar zipkin.jar

zipkin.jar是一个spring-boot项目, 可以直接通过java -jar zipkin.jar命令启动, 访问http://ip:port/9411即可. 如下图, 即表示zipkin启动成功:

注意: zipkin可以使用三种方式启动, 一是, in-memory内存形式启动, 重启后上一次的链路追踪信息丢失; 二是, MySQL方式, 将链路追踪信息保存在数据库; 三是, Elasticsearch方式; 这里采用的是简单的in-memory内存方式启动.

三, 扩展dubbo的filter接口

1 在classpath下创建META-INF/dubbo文件, 并添加tracing=com.xxz.dubbo.DubboTracingFilter其实现类.

2 创建DubboTracingFilter类

public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        System.out.println("===>进入链路追踪..");
        RpcContext rpcContext = RpcContext.getContext();
        //  判断此次调用是作为服务端还是客户端
        Span.Kind kind = rpcContext.isProviderSide() ? Span.Kind.SERVER : Span.Kind.CLIENT;
        final Span span;
        if (kind.equals(Span.Kind.CLIENT)) {
            // 若是rpc的客户端调用会从ThreadLocal中获取parent的 TraceContext ,
            // 为新生成的Span指定traceId及 parentId如果没有parent traceContext 
            // 则生成的Span为 root span
            span = tracer.nextSpan();
            // 将Span绑定的TraceContext中 属性信息复制到 Invocation中, 达到远程参数透传的作用
            injector.inject(span.context(), invocation.getAttachments());
        } else {
            // 若此次是rpc的服务提供端 , 从invocation中提取TraceContext相关信息及采样数据信息
            TraceContextOrSamplingFlags extracted = extractor.extract(invocation.getAttachments());
            // 生成span , 并且判断此次是否是首次调用(判断TraceContext == null)
            span = extracted.context() != null ? tracer.joinSpan(extracted.context()) : tracer.nextSpan(extracted);
        }
        
        if (!span.isNoop()) {
            span.kind(kind).start();
            // 记录接口信息及远程IP Port, 用于在zipkin的web页面上展示具体服务节点调用信息
            String service = invoker.getInterface().getSimpleName();
            String method = RpcUtils.getMethodName(invocation);
            span.kind(kind);
            span.name(service + "/" + method);
            InetSocketAddress remoteAddress = rpcContext.getRemoteAddress();
            span.remoteIpAndPort(
                    remoteAddress.getAddress() != null ? remoteAddress.getAddress().getHostAddress() : remoteAddress.getHostName(),remoteAddress.getPort());
        }
        
        boolean isOneway = false, deferFinish = false;
        try (Tracer.SpanInScope scope = tracer.withSpanInScope(span)){
            // 将创建的Span 作为当前Span (可以通过Tracer.currentSpan 访问到它) 并设置查询范围
            collectArguments(invocation, span, kind);
            // 执行真正的调用逻辑
            Result result = invoker.invoke(invocation);

            if (result.hasException()) {
                onError(result.getException(), span);
            }
            // oneway调用即只请求不接受结果
            isOneway = RpcUtils.isOneway(invoker.getUrl(), invocation);
            // 如果future不为空则为 async 调用 在回调中finish span
            Future<Object> future = rpcContext.getFuture();

            if (future instanceof FutureAdapter) {
                deferFinish = true;
                // 设置异步回调，回调代码执行span finish() .
                ((FutureAdapter) future).getFuture().setCallback(new FinishSpanCallback(span));
            }
            return result;
        } catch (Error | RuntimeException e) {
            onError(e, span);
            throw e;
        } finally {
            // oneway调用 因为不需等待返回值 即没有 cr (Client Receive) 需手动flush()
            if (isOneway) {
                span.flush();
            } 
            // 同步调用 业务代码执行完毕后需手动finish()
            else if (!deferFinish) {
                span.finish();
            }
        }
    }

3 使用

项目中直接引用该模块, 并在classpath下创建tracing_properties文件, 配置zipkin地址以及名称.

    <!-- 实现dubbo-tracing-filter -->
  	<dependency>
  		<groupId>com.xxz</groupId>
  		<artifactId>dubbo-tracing-filter</artifactId>
  		<version>0.0.1-SNAPSHOT</version>
  	</dependency>