zipkin为分布式链路调用监控系统,聚合各业务系统调用延迟数据,达到链路调用监控跟踪。

 

architecture

分布式系统监控系统zipkin入门
如图,在复杂的调用链路中假设存在一条调用链路响应缓慢,如何定位其中延迟高的服务呢?

  • 日志: 通过分析调用链路上的每个服务日志得到结果
  • zipkin:使用zipkinweb UI可以一眼看出延迟高的服务

分布式系统监控系统zipkin入门

如图所示,各业务系统在彼此调用时,将特定的跟踪消息传递至zipkin,zipkin在收集到跟踪信息后将其聚合处理、存储、展示等,用户可通过web UI方便 
获得网络延迟、调用链路、系统依赖等等。

zipkin主要涉及四个组件 collector storage search web UI

  • Collector接收各service传输的数据
  • Cassandra作为Storage的一种,也可以是mysql等,默认存储在内存中,配置cassandra可以参考这里
  • Query负责查询Storage中存储的数据,提供简单的JSON API获取数据,主要提供给web UI使用
  • Web 提供简单的web界面

2.安装

执行如下命令下载jar包

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

其为一个spring boot 工程,直接运行jar

nohup java -jar zipkin.jar & 
  • 1
  • 1

访问 http://ip:9411 
分布式系统监控系统zipkin入门

概念:

使用zipkin涉及几个概念

  • Span:基本工作单元,一次链路调用(可以是RPC,DB等没有特定的限制)创建一个span,通过一个64位ID标识它, 
    span通过还有其他的数据,例如描述信息,时间戳,key-value对的(Annotation)tag信息,parent-id等,其中parent-id 
    可以表示span调用链路来源,通俗的理解span就是一次请求信息

  • Trace:类似于树结构的Span集合,表示一条调用链路,存在唯一标识

  • Annotation: 注解,用来记录请求特定事件相关信息(例如时间),通常包含四个注解信息

    cs - Client Start,表示客户端发起请求

    sr - Server Receive,表示服务端收到请求

    ss - Server Send,表示服务端完成处理,并将结果发送给客户端

    cr - Client Received,表示客户端获取到服务端返回信息

  • BinaryAnnotation:提供一些额外信息,一般已key-value对出现

概念说完,来看下完整的调用链路 
分布式系统监控系统zipkin入门

上图表示一请求链路,一条链路通过Trace Id唯一标识,Span标识发起的请求信息,各span通过parent id 关联起来,如图 
分布式系统监控系统zipkin入门

整个链路的依赖关系如下: 
分布式系统监控系统zipkin入门

完成链路调用的记录后,如何来计算调用的延迟呢,这就需要利用Annotation信息

分布式系统监控系统zipkin入门

sr-cs 得到请求发出延迟

ss-sr 得到服务端处理延迟

cr-cs 得到真个链路完成延迟

 

brave

作为各调用链路,只需要负责将指定格式的数据发送给zipkin即可,利用brave可快捷完成操作。

首先导入jar包pom.xml

 
  1. <parent>

  2. <groupId>org.springframework.boot</groupId>

  3. <artifactId>spring-boot-starter-parent</artifactId>

  4. <version>1.3.6.RELEASE</version>

  5. </parent>

  6.  
  7.  
  8.  
  9. <!-- https://mvnrepository.com/artifact/io.zipkin.brave/brave-core -->

  10. <dependencies>

  11.  
  12. <dependency>

  13. <groupId>org.springframework.boot</groupId>

  14. <artifactId>spring-boot-starter-web</artifactId>

  15. </dependency>

  16. <dependency>

  17. <groupId>org.springframework.boot</groupId>

  18. <artifactId>spring-boot-starter-aop</artifactId>

  19. </dependency>

  20.  
  21. <dependency>

  22. <groupId>org.springframework.boot</groupId>

  23. <artifactId>spring-boot-starter-actuator</artifactId>

  24. </dependency>

  25.  
  26. <dependency>

  27. <groupId>io.zipkin.brave</groupId>

  28. <artifactId>brave-core</artifactId>

  29. <version>3.9.0</version>

  30. </dependency>

  31. <!-- https://mvnrepository.com/artifact/io.zipkin.brave/brave-http -->

  32. <dependency>

  33. <groupId>io.zipkin.brave</groupId>

  34. <artifactId>brave-http</artifactId>

  35. <version>3.9.0</version>

  36. </dependency>

  37. <dependency>

  38. <groupId>io.zipkin.brave</groupId>

  39. <artifactId>brave-spancollector-http</artifactId>

  40. <version>3.9.0</version>

  41. </dependency>

  42. <dependency>

  43. <groupId>io.zipkin.brave</groupId>

  44. <artifactId>brave-web-servlet-filter</artifactId>

  45. <version>3.9.0</version>

  46. </dependency>

  47.  
  48. <dependency>

  49. <groupId>io.zipkin.brave</groupId>

  50. <artifactId>brave-okhttp</artifactId>

  51. <version>3.9.0</version>

  52. </dependency>

  53.  
  54. <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->

  55. <dependency>

  56. <groupId>org.slf4j</groupId>

  57. <artifactId>slf4j-api</artifactId>

  58. <version>1.7.13</version>

  59. </dependency>

  60. <dependency>

  61. <groupId>org.apache.httpcomponents</groupId>

  62. <artifactId>httpclient</artifactId>

  63. <version>4.5.1</version>

  64. </dependency>

  65.  
  66. </dependencies>

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67

利用spring boot创建工程

Application.Java

 
  1. package com.lkl.zipkin;

  2.  
  3. import org.springframework.boot.SpringApplication;

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

  5.  
  6. /**

  7. *

  8. * Created by liaokailin on 16/7/27.

  9. */

  10. @SpringBootApplication

  11. public class Application {

  12.  
  13.  
  14. public static void main(String[] args) {

  15. SpringApplication app = new SpringApplication(Application.class);

  16. app.run(args);

  17.  
  18.  
  19. }

  20. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

建立controller对外提供服务

HomeController.java

 
  1. RestController

  2. @RequestMapping("/")

  3. public class HomeController {

  4.  
  5. @Autowired

  6. private OkHttpClient client;

  7.  
  8. private Random random = new Random();

  9.  
  10. @RequestMapping("start")

  11. public String start() throws InterruptedException, IOException {

  12. int sleep= random.nextInt(100);

  13. TimeUnit.MILLISECONDS.sleep(sleep);

  14. Request request = new Request.Builder().url("http://localhost:9090/foo").get().build();

  15. Response response = client.newCall(request).execute();

  16. return " [service1 sleep " + sleep+" ms]" + response.body().toString();

  17. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

HomeController中利用OkHttpClient调用发起http请求。在每次发起请求时则需要通过brave记录Span信息,并异步传递给zipkin 
作为被调用方(服务端)也同样需要完成以上操作.

ZipkinConfig.java

 
  1.  
  2. package com.lkl.zipkin.config;

  3.  
  4. import com.github.kristofa.brave.Brave;

  5. import com.github.kristofa.brave.EmptySpanCollectorMetricsHandler;

  6. import com.github.kristofa.brave.SpanCollector;

  7. import com.github.kristofa.brave.http.DefaultSpanNameProvider;

  8. import com.github.kristofa.brave.http.HttpSpanCollector;

  9. import com.github.kristofa.brave.okhttp.BraveOkHttpRequestResponseInterceptor;

  10. import com.github.kristofa.brave.servlet.BraveServletFilter;

  11. import okhttp3.OkHttpClient;

  12. import org.springframework.beans.factory.annotation.Autowired;

  13. import org.springframework.context.annotation.Bean;

  14. import org.springframework.context.annotation.Configuration;

  15.  
  16. /**

  17. * Created by liaokailin on 16/7/27.

  18. */

  19. @Configuration

  20. public class ZipkinConfig {

  21.  
  22. @Autowired

  23. private ZipkinProperties properties;

  24.  
  25.  
  26. @Bean

  27. public SpanCollector spanCollector() {

  28. HttpSpanCollector.Config config = HttpSpanCollector.Config.builder().connectTimeout(properties.getConnectTimeout()).readTimeout(properties.getReadTimeout())

  29. .compressionEnabled(properties.isCompressionEnabled()).flushInterval(properties.getFlushInterval()).build();

  30. return HttpSpanCollector.create(properties.getUrl(), config, new EmptySpanCollectorMetricsHandler());

  31. }

  32.  
  33.  
  34. @Bean

  35. public Brave brave(SpanCollector spanCollector){

  36. Brave.Builder builder = new Brave.Builder(properties.getServiceName()); //指定state

  37. builder.spanCollector(spanCollector);

  38. builder.traceSampler(Sampler.ALWAYS_SAMPLE);

  39. Brave brave = builder.build();

  40. return brave;

  41. }

  42.  
  43. @Bean

  44. public BraveServletFilter braveServletFilter(Brave brave){

  45. BraveServletFilter filter = new BraveServletFilter(brave.serverRequestInterceptor(),brave.serverResponseInterceptor(),new DefaultSpanNameProvider());

  46. return filter;

  47. }

  48.  
  49. @Bean

  50. public OkHttpClient okHttpClient(Brave brave){

  51. OkHttpClient client = new OkHttpClient.Builder()

  52. .addInterceptor(new BraveOkHttpRequestResponseInterceptor(brave.clientRequestInterceptor(), brave.clientResponseInterceptor(), new DefaultSpanNameProvider()))

  53. .build();

  54. return client;

  55. }

  56. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • SpanCollector 配置收集器

  • Brave 各工具类的封装,其中builder.traceSampler(Sampler.ALWAYS_SAMPLE)设置采样比率,0-1之间的百分比

  • BraveServletFilter 作为拦截器,需要serverRequestInterceptor,serverResponseInterceptor 分别完成srss操作

  • OkHttpClient 添加拦截器,需要clientRequestInterceptor,clientResponseInterceptor 分别完成cscr操作,该功能由 
    brave中的brave-okhttp模块提供,同样的道理如果需要记录数据库的延迟只要在数据库操作前后完成cscr即可,当然brave提供其封装。

以上还缺少一个配置信息ZipkinProperties.java

 
  1. package com.lkl.zipkin.config;

  2.  
  3. import org.springframework.boot.context.properties.ConfigurationProperties;

  4. import org.springframework.context.annotation.Configuration;

  5.  
  6. /**

  7. * Created by liaokailin on 16/7/28.

  8. */

  9. @Configuration

  10. @ConfigurationProperties(prefix = "com.zipkin")

  11. public class ZipkinProperties {

  12.  
  13. private String serviceName;

  14.  
  15. private String url;

  16.  
  17. private int connectTimeout;

  18.  
  19. private int readTimeout;

  20.  
  21. private int flushInterval;

  22.  
  23. private boolean compressionEnabled;

  24.  
  25. public String getUrl() {

  26. return url;

  27. }

  28.  
  29. public void setUrl(String url) {

  30. this.url = url;

  31. }

  32.  
  33. public int getConnectTimeout() {

  34. return connectTimeout;

  35. }

  36.  
  37. public void setConnectTimeout(int connectTimeout) {

  38. this.connectTimeout = connectTimeout;

  39. }

  40.  
  41. public int getReadTimeout() {

  42. return readTimeout;

  43. }

  44.  
  45. public void setReadTimeout(int readTimeout) {

  46. this.readTimeout = readTimeout;

  47. }

  48.  
  49. public int getFlushInterval() {

  50. return flushInterval;

  51. }

  52.  
  53. public void setFlushInterval(int flushInterval) {

  54. this.flushInterval = flushInterval;

  55. }

  56.  
  57. public boolean isCompressionEnabled() {

  58. return compressionEnabled;

  59. }

  60.  
  61. public void setCompressionEnabled(boolean compressionEnabled) {

  62. this.compressionEnabled = compressionEnabled;

  63. }

  64.  
  65. public String getServiceName() {

  66. return serviceName;

  67. }

  68.  
  69. public void setServiceName(String serviceName) {

  70. this.serviceName = serviceName;

  71. }

  72. }

  73.  
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74

则可以在配置文件application.properties中配置相关信息

 
  1. com.zipkin.serviceName=service1

  2. com.zipkin.url=http://110.173.14.57:9411

  3. com.zipkin.connectTimeout=6000

  4. com.zipkin.readTimeout=6000

  5. com.zipkin.flushInterval=1

  6. com.zipkin.compressionEnabled=true

  7. server.port=8080

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

那么其中的service1即完成,同样的道理,修改配置文件(调整com.zipkin.serviceName,以及server.port)以及controller对应的方法构造若干服务

service1 中访问http://localhost:8080/start需要访问http://localhost:9090/foo,则构造server2提供该方法

server2配置

 
  1. com.zipkin.serviceName=service2

  2. com.zipkin.url=http://110.173.14.57:9411

  3. com.zipkin.connectTimeout=6000

  4. com.zipkin.readTimeout=6000

  5. com.zipkin.flushInterval=1

  6. com.zipkin.compressionEnabled=true

  7.  
  8.  
  9. server.port=9090

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

controller方法

 
  1. @RequestMapping("foo")

  2. public String foo() throws InterruptedException, IOException {

  3. Random random = new Random();

  4. int sleep= random.nextInt(100);

  5. TimeUnit.MILLISECONDS.sleep(sleep);

  6. Request request = new Request.Builder().url("http://localhost:9091/bar").get().build(); //service3

  7. Response response = client.newCall(request).execute();

  8. String result = response.body().string();

  9. request = new Request.Builder().url("http://localhost:9092/tar").get().build(); //service4

  10. response = client.newCall(request).execute();

  11. result += response.body().string();

  12. return " [service2 sleep " + sleep+" ms]" + result;

  13. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

server2中调用server3server4中的方法

方法分别为

 
  1. @RequestMapping("bar")

  2. public String bar() throws InterruptedException, IOException { //service3 method

  3. Random random = new Random();

  4. int sleep= random.nextInt(100);

  5. TimeUnit.MILLISECONDS.sleep(sleep);

  6. return " [service3 sleep " + sleep+" ms]";

  7. }

  8.  
  9. @RequestMapping("tar")

  10. public String tar() throws InterruptedException, IOException { //service4 method

  11. Random random = new Random();

  12. int sleep= random.nextInt(1000);

  13. TimeUnit.MILLISECONDS.sleep(sleep);

  14. return " [service4 sleep " + sleep+" ms]";

  15. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

将工程修改后编译成jar形式

执行

 
  1.  
  2. nohup java -jar server4.jar &

  3. nohup java -jar server3.jar &

  4. nohup java -jar server2.jar &

  5. nohup java -jar server1.jar &

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

访问http://localhost:8080/start后查看zipkinweb UI

分布式系统监控系统zipkin入门

点击条目可以查看具体的延迟信息

分布式系统监控系统zipkin入门

服务之间的依赖为 
分布式系统监控系统zipkin入门

 

brave 源码

以上完成了基本的操作,下面将从源码角度来看下brave的实现

首先从SpanCollector来入手

 
  1.  
  2. @Bean

  3. public SpanCollector spanCollector() {

  4. HttpSpanCollector.Config config = HttpSpanCollector.Config.builder().connectTimeout(properties.getConnectTimeout()).readTimeout(properties.getReadTimeout())

  5. .compressionEnabled(properties.isCompressionEnabled()).flushInterval(properties.getFlushInterval()).build();

  6. return HttpSpanCollector.create(properties.getUrl(), config, new EmptySpanCollectorMetricsHandler());

  7. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

从名称上看HttpSpanCollector是基于httpspan收集器,因此超时配置是必须的,默认给出的超时时间较长,flushInterval表示span的传递 
间隔,实际为定时任务执行的间隔时间.在HttpSpanCollector中覆写了父类方法sendSpans

 
  1.  
  2. @Override

  3. protected void sendSpans(byte[] json) throws IOException {

  4. // intentionally not closing the connection, so as to use keep-alives

  5. HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();

  6. connection.setConnectTimeout(config.connectTimeout());

  7. connection.setReadTimeout(config.readTimeout());

  8. connection.setRequestMethod("POST");

  9. connection.addRequestProperty("Content-Type", "application/json");

  10. if (config.compressionEnabled()) {

  11. connection.addRequestProperty("Content-Encoding", "gzip");

  12. ByteArrayOutputStream gzipped = new ByteArrayOutputStream();

  13. try (GZIPOutputStream compressor = new GZIPOutputStream(gzipped)) {

  14. compressor.write(json);

  15. }

  16. json = gzipped.toByteArray();

  17. }

  18. connection.setDoOutput(true);

  19. connection.setFixedLengthStreamingMode(json.length);

  20. connection.getOutputStream().write(json);

  21.  
  22. try (InputStream in = connection.getInputStream()) {

  23. while (in.read() != -1) ; // skip

  24. } catch (IOException e) {

  25. try (InputStream err = connection.getErrorStream()) {

  26. if (err != null) { // possible, if the connection was dropped

  27. while (err.read() != -1) ; // skip

  28. }

  29. }

  30. throw e;

  31. }

  32. }

  33. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34

可以看出最终span信息是通过HttpURLConnection实现的,同样道理就可以推理bravebrave-spring-resttemplate-interceptors模块的实现, 
只是换了一种http封装。

Brave

 
  1. @Bean

  2. public Brave brave(SpanCollector spanCollector){

  3. Brave.Builder builder = new Brave.Builder(properties.getServiceName()); //指定state

  4. builder.spanCollector(spanCollector);

  5. builder.traceSampler(Sampler.ALWAYS_SAMPLE);

  6. Brave brave = builder.build();

  7. return brave;

  8. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

Brave类包装了各种工具类

 
  1. public Brave build() {

  2. return new Brave(this);

  3. }

  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

创建一个Brave

 
  1.  
  2. private Brave(Builder builder) {

  3. serverTracer = ServerTracer.builder()

  4. .randomGenerator(builder.random)

  5. .spanCollector(builder.spanCollector)

  6. .state(builder.state)

  7. .traceSampler(builder.sampler).build();

  8.  
  9. clientTracer = ClientTracer.builder()

  10. .randomGenerator(builder.random)

  11. .spanCollector(builder.spanCollector)

  12. .state(builder.state)

  13. .traceSampler(builder.sampler).build();

  14.  
  15. localTracer = LocalTracer.builder()

  16. .randomGenerator(builder.random)

  17. .spanCollector(builder.spanCollector)

  18. .spanAndEndpoint(SpanAndEndpoint.LocalSpanAndEndpoint.create(builder.state))

  19. .traceSampler(builder.sampler).build();

  20.  
  21. serverRequestInterceptor = new ServerRequestInterceptor(serverTracer);

  22. serverResponseInterceptor = new ServerResponseInterceptor(serverTracer);

  23. clientRequestInterceptor = new ClientRequestInterceptor(clientTracer);

  24. clientResponseInterceptor = new ClientResponseInterceptor(clientTracer);

  25. serverSpanAnnotationSubmitter = AnnotationSubmitter.create(SpanAndEndpoint.ServerSpanAndEndpoint.create(builder.state));

  26. serverSpanThreadBinder = new ServerSpanThreadBinder(builder.state);

  27. clientSpanThreadBinder = new ClientSpanThreadBinder(builder.state);

  28. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29

封装了*Tracer,*Interceptor,*Binder

其中 serverTracer当服务作为服务端时处理span信息,clientTracer当服务作为客户端时处理span信息

Filter

BraveServletFilterhttp模块提供的拦截器功能,传递serverRequestInterceptor,serverResponseInterceptor,spanNameProvider等参数 
其中spanNameProvider表示如何处理span的名称,默认使用method名称,spring boot中申明的filter bean 默认拦截所有请求

 
  1. @Override

  2. public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {

  3.  
  4. String alreadyFilteredAttributeName = getAlreadyFilteredAttributeName();

  5. boolean hasAlreadyFilteredAttribute = request.getAttribute(alreadyFilteredAttributeName) != null;

  6.  
  7. if (hasAlreadyFilteredAttribute) {

  8. // Proceed without invoking this filter...

  9. filterChain.doFilter(request, response);

  10. } else {

  11.  
  12. final StatusExposingServletResponse statusExposingServletResponse = new StatusExposingServletResponse((HttpServletResponse) response);

  13. requestInterceptor.handle(new HttpServerRequestAdapter(new ServletHttpServerRequest((HttpServletRequest) request), spanNameProvider));

  14.  
  15. try {

  16. filterChain.doFilter(request, statusExposingServletResponse);

  17. } finally {

  18. responseInterceptor.handle(new HttpServerResponseAdapter(new HttpResponse() {

  19. @Override

  20. public int getHttpStatusCode() {

  21. return statusExposingServletResponse.getStatus();

  22. }

  23. }));

  24. }

  25. }

  26. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27

首先来看requestInterceptor.handle方法,

 
  1.  
  2. public void handle(ServerRequestAdapter adapter) {

  3. serverTracer.clearCurrentSpan();

  4. final TraceData traceData = adapter.getTraceData();

  5.  
  6. Boolean sample = traceData.getSample();

  7. if (sample != null && Boolean.FALSE.equals(sample)) {

  8. serverTracer.setStateNoTracing();

  9. LOGGER.fine("Received indication that we should NOT trace.");

  10. } else {

  11. if (traceData.getSpanId() != null) {

  12. LOGGER.fine("Received span information as part of request.");

  13. SpanId spanId = traceData.getSpanId();

  14. serverTracer.setStateCurrentTrace(spanId.traceId, spanId.spanId,

  15. spanId.nullableParentId(), adapter.getSpanName());

  16. } else {

  17. LOGGER.fine("Received no span state.");

  18. serverTracer.setStateUnknown(adapter.getSpanName());

  19. }

  20. serverTracer.setServerReceived();

  21. for(KeyValueAnnotation annotation : adapter.requestAnnotations())

  22. {

  23. serverTracer.submitBinaryAnnotation(annotation.getKey(), annotation.getValue());

  24. }

  25. }

  26. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27

其中serverTracer.clearCurrentSpan()清除当前线程上的span信息,调用ThreadLocalServerClientAndLocalSpanState中的

 
  1.  
  2. @Override

  3. public void setCurrentServerSpan(final ServerSpan span) {

  4. if (span == null) {

  5. currentServerSpan.remove();

  6. } else {

  7. currentServerSpan.set(span);

  8. }

  9. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

currentServerSpanThreadLocal对象

private final static ThreadLocal<ServerSpan> currentServerSpan = new ThreadLocal<ServerSpan>() {
  • 1
  • 1

回到ServerRequestInterceptor#handle()方法中final TraceData traceData = adapter.getTraceData()

 
  1. @Override

  2. public TraceData getTraceData() {

  3. final String sampled = serverRequest.getHttpHeaderValue(BraveHttpHeaders.Sampled.getName());

  4. if (sampled != null) {

  5. if (sampled.equals("0") || sampled.toLowerCase().equals("false")) {

  6. return TraceData.builder().sample(false).build();

  7. } else {

  8. final String parentSpanId = serverRequest.getHttpHeaderValue(BraveHttpHeaders.ParentSpanId.getName());

  9. final String traceId = serverRequest.getHttpHeaderValue(BraveHttpHeaders.TraceId.getName());

  10. final String spanId = serverRequest.getHttpHeaderValue(BraveHttpHeaders.SpanId.getName());

  11.  
  12. if (traceId != null && spanId != null) {

  13. SpanId span = getSpanId(traceId, spanId, parentSpanId);

  14. return TraceData.builder().sample(true).spanId(span).build();

  15. }

  16. }

  17. }

  18. return TraceData.builder().build();

  19. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19

其中SpanId span = getSpanId(traceId, spanId, parentSpanId) 将构造一个SpanId对象

 
  1. private SpanId getSpanId(String traceId, String spanId, String parentSpanId) {

  2. return SpanId.builder()

  3. .traceId(convertToLong(traceId))

  4. .spanId(convertToLong(spanId))

  5. .parentId(parentSpanId == null ? null : convertToLong(parentSpanId)).build();

  6. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

traceId,spanId,parentId关联起来,其中设置parentId方法为

 
  1.  
  2. public Builder parentId(@Nullable Long parentId) {

  3. if (parentId == null) {

  4. this.flags |= FLAG_IS_ROOT;

  5. } else {

  6. this.flags &= ~FLAG_IS_ROOT;

  7. }

  8. this.parentId = parentId;

  9. return this;

  10. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10

如果parentId为空为根节点,则执行this.flags |= FLAG_IS_ROOT ,因此后续在判断节点是否为根节点时,只需要执行(flags & FLAG_IS_ROOT) == FLAG_IS_ROOT即可.

构造完SpanId后看

 
  1. serverTracer.setStateCurrentTrace(spanId.traceId, spanId.spanId,

  2. spanId.nullableParentId(), adapter.getSpanName());

  • 1
  • 2
  • 1
  • 2

设置当前Span

 
  1. public void setStateCurrentTrace(long traceId, long spanId, @Nullable Long parentSpanId, @Nullable String name) {

  2. checkNotBlank(name, "Null or blank span name");

  3. spanAndEndpoint().state().setCurrentServerSpan(

  4. ServerSpan.create(traceId, spanId, parentSpanId, name));

  5. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

ServerSpan.create创建Span信息

 
  1.  
  2. static ServerSpan create(long traceId, long spanId, @Nullable Long parentSpanId, String name) {

  3. Span span = new Span();

  4. span.setTrace_id(traceId);

  5. span.setId(spanId);

  6. if (parentSpanId != null) {

  7. span.setParent_id(parentSpanId);

  8. }

  9. span.setName(name);

  10. return create(span, true);

  11. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

构造了一个包含Span信息的AutoValue_ServerSpan对象

通过setCurrentServerSpan设置到当前线程上

继续看serverTracer.setServerReceived()方法

 
  1. public void setServerReceived() {

  2. submitStartAnnotation(zipkinCoreConstants.SERVER_RECV);

  3. }

  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

为当前请求设置了server received event

 
  1.  
  2. void submitStartAnnotation(String annotationName) {

  3. Span span = spanAndEndpoint().span();

  4. if (span != null) {

  5. Annotation annotation = Annotation.create(

  6. currentTimeMicroseconds(),

  7. annotationName,

  8. spanAndEndpoint().endpoint()

  9. );

  10. synchronized (span) {

  11. span.setTimestamp(annotation.timestamp);

  12. span.addToAnnotations(annotation);

  13. }

  14. }

  15. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

在这里为Span信息设置了Annotation信息,后续的

 
  1. for(KeyValueAnnotation annotation : adapter.requestAnnotations())

  2. {

  3. serverTracer.submitBinaryAnnotation(annotation.getKey(), annotation.getValue());

  4. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 1
  • 2
  • 3
  • 4
  • 5

设置了BinaryAnnotation信息,adapter.requestAnnotations()在构造HttpServerRequestAdapter时已完成

 
  1. @Override

  2. public Collection<KeyValueAnnotation> requestAnnotations() {

  3. KeyValueAnnotation uriAnnotation = KeyValueAnnotation.create(

  4. TraceKeys.HTTP_URL, serverRequest.getUri().toString());

  5. return Collections.singleton(uriAnnotation);

  6. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

以上将Span信息(包括sr)存储在当前线程中,接下来继续看BraveServletFilter#doFilter方法的finally部分

 
  1.  
  2. responseInterceptor.handle(new HttpServerResponseAdapter(new HttpResponse() {

  3. @Override //获取http状态码

  4. public int getHttpStatusCode() {

  5. return statusExposingServletResponse.getStatus();

  6. }

  7. }));

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

handle方法

 
  1. public void handle(ServerResponseAdapter adapter) {

  2. // We can submit this in any case. When server state is not set or

  3. // we should not trace this request nothing will happen.

  4. LOGGER.fine("Sending server send.");

  5. try {

  6. for(KeyValueAnnotation annotation : adapter.responseAnnotations())

  7. {

  8. serverTracer.submitBinaryAnnotation(annotation.getKey(), annotation.getValue());

  9. }

  10. serverTracer.setServerSend();

  11. } finally {

  12. serverTracer.clearCurrentSpan();

  13. }

  14. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

首先配置BinaryAnnotation信息,然后执行serverTracer.setServerSend,在finally中清除当前线程中的Span信息(不管前面是否清楚成功,最终都将执行该不走),ThreadLocal中的数据要做到有始有终

serverTracer.setServerSend()

 
  1. public void setServerSend() {

  2. if (submitEndAnnotation(zipkinCoreConstants.SERVER_SEND, spanCollector())) {

  3. spanAndEndpoint().state().setCurrentServerSpan(null);

  4. }

  5. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

终于看到spanCollector收集器了,说明下面将看是收集Span信息,这里为ss注解

 
  1.  
  2. boolean submitEndAnnotation(String annotationName, SpanCollector spanCollector) {

  3. Span span = spanAndEndpoint().span();

  4. if (span == null) {

  5. return false;

  6. }

  7. Annotation annotation = Annotation.create(

  8. currentTimeMicroseconds(),

  9. annotationName,

  10. spanAndEndpoint().endpoint()

  11. );

  12. span.addToAnnotations(annotation);

  13. if (span.getTimestamp() != null) {

  14. span.setDuration(annotation.timestamp - span.getTimestamp());

  15. }

  16. spanCollector.collect(span);

  17. return true;

  18. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

首先获取当前线程中的Span信息,然后处理注解信息,通过annotation.timestamp - span.getTimestamp()计算延迟, 
调用spanCollector.collect(span)进行收集Span信息,那么Span信息是同步收集的吗?肯定不是的,接着看

分布式系统监控系统zipkin入门

调用spanCollector.collect(span)则执行FlushingSpanCollector中的collect方法

 
  1.  
  2. @Override

  3. public void collect(Span span) {

  4. metrics.incrementAcceptedSpans(1);

  5. if (!pending.offer(span)) {

  6. metrics.incrementDroppedSpans(1);

  7. }

  8. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

首先进行的是metrics统计信息,可以自定义该SpanCollectorMetricsHandler信息收集各指标信息,利用如grafana等展示信息

pending.offer(span)span信息存储在BlockingQueue中,然后通过定时任务去取出阻塞队列中的值,偷偷摸摸的上传span信息

定时任务利用了Flusher类来执行,在构造FlushingSpanCollector时构造了Flusher

 
  1.  
  2. static final class Flusher implements Runnable {

  3. final Flushable flushable;

  4. final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);

  5.  
  6. Flusher(Flushable flushable, int flushInterval) {

  7. this.flushable = flushable;

  8. this.scheduler.scheduleWithFixedDelay(this, 0, flushInterval, SECONDS);

  9. }

  10.  
  11. @Override

  12. public void run() {

  13. try {

  14. flushable.flush();

  15. } catch (IOException ignored) {

  16. }

  17. }

  18. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

创建了一个核心线程数为1的线程池,每间隔flushInterval秒执行一次Span信息上传,执行flush方法

 
  1. @Override

  2. public void flush() {

  3. if (pending.isEmpty()) return;

  4. List<Span> drained = new ArrayList<Span>(pending.size());

  5. pending.drainTo(drained);

  6. if (drained.isEmpty()) return;

  7.  
  8. int spanCount = drained.size();

  9. try {

  10. reportSpans(drained);

  11. } catch (IOException e) {

  12. metrics.incrementDroppedSpans(spanCount);

  13. } catch (RuntimeException e) {

  14. metrics.incrementDroppedSpans(spanCount);

  15. }

  16. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17

首先将阻塞队列中的值全部取出存如集合中,最后调用reportSpans(List<Span> drained)抽象方法,该方法在AbstractSpanCollector得到覆写

 
  1. @Override

  2. protected void reportSpans(List<Span> drained) throws IOException {

  3. byte[] encoded = codec.writeSpans(drained);

  4. sendSpans(encoded);

  5. }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

转换成字节流后调用sendSpans抽象方法发送Span信息,此时就回到一开始说的HttpSpanCollector通过HttpURLConnection实现的sendSpans方法。


具体使用可以参考:https://github.com/liaokailin/zipkin#architecture,下载这个maven项目并按照里面的说明运行即可。

相关文章: