極簡！一個注解就能創建Jaeger的Span

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容：所有原創文章分類匯總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；

本篇概覽

• 在《Jaeger開發入門(java版)》一文中，咱們編碼實作了span的創建和上報，如下圖紅框，雖然代碼量不大，但是把這些代碼寫在業務代碼中，侵入性太強，很多程式員都不喜歡：

• 今天咱們試試AOP+自定義注解來解決上述問題，如下圖，mock是個普通方法，添加了紅框中的注解@MySpan，就會創建span然后上報到Jaeger，mock方法的代碼沒有任何改動：

• 通過上面兩圖的對比，可見注解非常簡潔，接下來就實戰上述手段，具體的步驟如下：

1. 新建web工程，里面有controller層，呼叫service層的服務Biz，服務Biz再呼叫另一個服務ChildBiz
2. 創建兩個注解MySpan和MyChildSpan
3. 創建AOP類SpanAspect，負責處理所有被注解MySpan和MyChildSpan修飾的方法；
4. 把注解MySpan和MyChildSpan用在普通的服務Biz和ChildBiz上
5. 啟動服務，驗證功能；

原始碼下載

• 本篇實戰中的完整原始碼可在GitHub下載到，地址和鏈接資訊如下表所示(https://github.com/zq2599/blog_demos)：

• 這個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和注解開發

• 接下來是今天的核心：處理注解的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上報；

你不孤單，欣宸原創一路相伴

1. Java系列
2. Spring系列
3. Docker系列
4. kubernetes系列
5. 資料庫+中間件系列
6. DevOps系列

歡迎關注公眾號：程式員欣宸

微信搜索「程式員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos

標籤：Java

上一篇：FireMonkey3D之中國象棋程式設計（六）完善演算法

下一篇：嵌套串列需要轉換為JSON