关于云计算:极简一个注解就能创建Jaeger的Span

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，波及 Java、Docker、Kubernetes、DevOPS 等；

在《Jaeger 开发入门 (java 版)》一文中，咱们编码实现了 span 的创立和上报，如下图红框，尽管代码量不大，然而把这些代码写在业务代码中，侵入性太强，很多程序员都不喜爱：

明天咱们试试 AOP+ 自定义注解来解决上述问题，如下图，mock 是个一般办法，增加了红框中的注解 @MySpan，就会创立 span 而后上报到 Jaeger，mock 办法的代码没有任何改变：

通过下面两图的比照，可见注解十分简洁，接下来就实战上述伎俩，具体的步骤如下：

新建 web 工程，外面有 controller 层，调用 service 层的服务 Biz，服务 Biz 再调用另一个服务 ChildBiz
创立两个注解 MySpan 和 MyChildSpan
创立 AOP 类 SpanAspect，负责解决所有被注解 MySpan 和 MyChildSpan 润饰的办法；
把注解 MySpan 和 MyChildSpan 用在一般的服务 Biz 和 ChildBiz 上
启动服务，验证性能；

本篇实战中的残缺源码可在 GitHub 下载到，地址和链接信息如下表所示 (https://github.com/zq2599/blo…)：

名称	链接	备注
我的项目主页	https://github.com/zq2599/blo…	该我的项目在 GitHub 上的主页
git 仓库地址 (https)	https://github.com/zq2599/blo…	该我的项目源码的仓库地址，https 协定
git 仓库地址 (ssh)	git@github.com:zq2599/blog_demos.git	该我的项目源码的仓库地址，ssh 协定

这个 git 我的项目中有多个文件夹，本篇的源码在 spring-cloud-tutorials 文件夹下，如下图红框所示：

spring-cloud-tutorials 文件夹下有多个子工程，本篇的代码是 jaeger-annonation-demo，如下图红框所示：

创立 spring-cloud-tutorials 的子工程 jaeger-annonation-demo，其 pom.xml 如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spring-cloud-tutorials</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>jaeger-annonation-demo</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>common</artifactId>
            <version>${project.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>io.opentracing.contrib</groupId>
            <artifactId>opentracing-spring-jaeger-cloud-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <layers>
                        <enabled>true</enabled>
                    </layers>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

配置文件 application.yml：

spring:
  application:
    name: jaeger-annonation-demo
opentracing:
  jaeger:
    enabled: true
    udp-sender:
      host: 127.0.0.1
      port: 6831
server:
  port: 18080

启动类：

package com.bolingcavalry.annonation;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AnnonationDemoApplication {public static void main(String[] args) {SpringApplication.run(AnnonationDemoApplication.class, args);
    }
}

第一个接口 Biz：

package com.bolingcavalry.annonation.service;

public interface ChildBiz {void mockChild();
}

它的实现：

package com.bolingcavalry.annonation.service.impl;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Component
@Slf4j
public class ChildBizImpl implements ChildBiz {
    @Override
    public void mockChild() {log.info("mockChild");
    }
}

第二个接口：

package com.bolingcavalry.annonation.service;

public interface Biz {void mock();
}

它的实现，可见其 mock 办法中会调用 childBiz 的 mockChild 办法：

package com.bolingcavalry.annonation.service.impl;

import com.bolingcavalry.annonation.service.Biz;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Component
@Slf4j
public class BizImpl implements Biz {

    final ChildBiz childBiz;

    public BizImpl(ChildBiz childBiz) {this.childBiz = childBiz;}

    @Override
    public void mock() {log.info("mock");
      childBiz.mockChild();}
}

当初一个简略的 web 服务开发实现，有 web 层也有 service 层，够咱们来试验了

定义两个注解，一个用于创立 span，另一个用于创立子 span：
注解 MySpan 用于心愿全新创立一个 span 的场景：

package com.bolingcavalry.annonation.aop;

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface MySpan {String spanName() default "";
}

第二个是 MyChildSpan，用于心愿在以后 span 下创立一个子 span 的场景：

package com.bolingcavalry.annonation.aop;

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface MyChildSpan {String spanName() default "";
}

定义好了注解，能够开发 AOP 来解决注解的逻辑了

接下来是明天的外围：解决注解的 AOP 类，中文正文曾经写得很具体，就不再赘述太多了，惟一要留神的是注解 @Around(“@annotation(mySpan)”)，它指定了该办法会解决所有被 mySpan 润饰的办法：

package com.bolingcavalry.annonation.aop;

import io.opentracing.Span;
import io.opentracing.Tracer;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
@Slf4j
public class SpanAspect {

    private Tracer tracer;

    public SpanAspect(Tracer tracer) {this.tracer = tracer;}

    /**
     * 获得实在办法的相干信息
     * @param proceedingJoinPoint
     * @return
     */
    private static String getOperationDesc(ProceedingJoinPoint proceedingJoinPoint) {Signature signature = proceedingJoinPoint.getSignature();
        // 提取类名
        return StringUtils.substringAfterLast(signature.getDeclaringTypeName(), ".")
                + ":"
                + signature.getName();}

    @Around("@annotation(mySpan)")
    public Object traceSpan(ProceedingJoinPoint proceedingJoinPoint, MySpan mySpan) throws Throwable {

        // 类名: 办法名
        String operationDesc = getOperationDesc(proceedingJoinPoint);

        // 看办法的注解中有没有设置 name
        String name = mySpan.spanName();

        // 如果没有设置 name，就给 span 一个默认 name
        if (StringUtils.isEmpty(name)) {name = "span-aspect-" + operationDesc;}

        // 创立一个 span，在创立的时候就增加一个 tag
        Span span = tracer.buildSpan(name).start();

        // span 日志
        span.log("span log of" + operationDesc);

        // 减少一个 tag
        span.setTag("operation-desc", operationDesc);

        // span 完结
        span.finish();

        return proceedingJoinPoint.proceed();}

    @Around("@annotation(myChildSpan)")
    public Object traceChildSpan(ProceedingJoinPoint proceedingJoinPoint, MyChildSpan myChildSpan) throws Throwable {
        // 类名: 办法名
        String operationDesc = getOperationDesc(proceedingJoinPoint);

        // 看办法的注解中有没有设置 name
        String name = myChildSpan.spanName();

        // 如果没有设置 name，就给 span 一个默认 name
        if (StringUtils.isEmpty(name)) {name = "child-span-aspect-" + operationDesc;}

        // 从上下文中获得已存在的 span
        Span parentSpan = tracer.activeSpan();

        if (null==parentSpan) {log.error("can not get span from context");
        } else {Span span = tracer.buildSpan(name).asChildOf(parentSpan).start();

            // span 日志
            span.log("child span log of" + operationDesc);

            // 减少一个 tag
            span.setTag("child-operation-desc", operationDesc);

            // span 完结
            span.finish();}

        return proceedingJoinPoint.proceed();}
}

注解和 AOP 都写好了，咱们把注解用上，看看成果如何

把 MySpan 用来润饰 BizImpl.mock 办法，留神设置其 spanName 属性，作为 span 的 name：

把 MyChildSpan 用来润饰办法 ChildBizImpl.mockChild 办法，用于创立一个子 span，留神注解不设置任何属性，AOP 类中会给这个 span 设置默认的名称：

以上就是全副代码了，咱们运行起来试试吧；

用 docker 启动 Jaeger 后盾服务：

docker run -d \
--name jaeger \
-e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
-p 5775:5775/udp \
-p 6831:6831/udp \
-p 6832:6832/udp \
-p 5778:5778 \
-p 16686:16686 \
-p 14268:14268 \
-p 14269:14269 \
-p 9411:9411 jaegertracing/all-in-one:1.26

启动利用 jaeger-annonation-demo
浏览器拜访 http://localhost:18080/hello，触发 web 接口类和 service 类的执行
关上 jaeger 的 web 页面，地址是 http://localhost:16686/search，如下图，可见 trace 曾经上报了：

点开上图红框中的记录，能够看到这个 trace 的详情，如下图可见，数据都合乎预期：

至此，基于注解的 Jaeger 上报就实现了，本篇只是提供一个思路和参考代码，在理论利用中，聪慧的您齐全能够制作出更加弱小的注解式上报，例如减少更丰盛的注解属性、基于类的注解、基于参数的注解等，甚至弃用注解，间接用纯正的 AOP 针对特定 package、办法等进行 Jaeger 上报；

Java 系列
Spring 系列
Docker 系列
kubernetes 系列
数据库 + 中间件系列
DevOps 系列

微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游 Java 世界 …
https://github.com/zq2599/blog_demos

关于云计算:极简一个注解就能创建Jaeger的Span

欢送拜访我的 GitHub

本篇概览

源码下载

编码

定义注解

AOP 和注解开发

应用注解

验证

你不孤独，欣宸原创一路相伴

欢送关注公众号：程序员欣宸

Just My Socks（注册教程内含优惠码）

关于云计算:极简一个注解就能创建Jaeger的Span

欢送拜访我的 GitHub

本篇概览

源码下载

编码

定义注解

AOP 和注解开发

应用注解

验证

你不孤独，欣宸原创一路相伴

欢送关注公众号：程序员欣宸

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）