wen 极简！一个注解就能创建Jaeger的Span
欢迎访问我的GitHub
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/blog_demos)：
| 名称 | 链接 | 备注 |
|---|---|---|
| 项目主页 | https://github.com/zq2599/blog_demos | 该项目在GitHub上的主页 |
| git仓库地址(https) | https://github.com/zq2599/blog_demos.git | 该项目源码的仓库地址，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和注解开发
- 接下来是今天的核心：处理注解的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
