Spring Cloud Sleuth服务链路追踪(Finchley版本)

一、简介

微服务结构是一个分布式架构,微服务系统按照业务划分服务单元,一个微服务系统往往有很多个服务单元。由于服务单元数量众多,服务单元之间的调用很复杂,一旦出现错误和异常,很难去定位。所以在微服务架构中必须实现分布式服务链路追踪。目前,常见的链路追踪组件有Google的Dapper,Twitter的Zipkin,以及阿里的Eagleeye(鹰眼)等,它们都是非常优秀的链路追踪开源组件。

本章主要讲述如何在Spring Cloud Sleuth中集成Zipkin。

二、基本术语

  • Span:基本哦工作单元,发送一个远程调度任务就会产生一个Span,Span是用一个64位ID唯一标识的,Trace是用另一个64位ID唯一标识的。Span还包含了其它信息,例如:摘要,时间戳事件,Span的ID以及进程ID;
  • Trace:由一系列的Span组成,呈树状结构。请求一个微服务系统的API接口,这个API接口需要调用多个微服务单元,调用每个微服务单元都会产生一个新的Span,所有由这个请求产生的Span组成这个Trace;
  • Annotation:用于记录一个事件,一些核心注解用于定义一个请求的开始和结束,这些注解如下:
    • cs - Client Sent:客户端发送一个请求,表示Span的开始
    • sr - Server Received:服务端接收请求并准备开始处理它。(sr-cs)等于网络的延迟
    • ss - Server Sent:服务端发送响应,该注解表明请求处理的完成。(ss-sr)表示服务端处理请求的时间
    • cr - Client Received:客户端接收响应,此时Span结束。(cr-cs)表示整个请求所消耗的时间

如果一个服务的调用关系如下:


调用关系

那么此时将Span和Trace在一个系统中使用Zipkin注解的过程图形化:


Zipkin注解的过程图形化

每个颜色的表明一个Span(总计7个Spans,从A到G),每个Span有类似的信息:
Trace Id = X
Span Id = D
Client Sent

此Span表示Span的Trance Id是X,Span Id是D,同时它发送一个Client Sent事件。

Spans 的parent/child关系图形化如下:


Spans的parent/child关系图形化

三、Spring Cloud Sleuth + Zipkin整合案例

3.1 相关工程说明

服务 端口 服务说明
eureka 8761 服务注册于发现
provider 8800 服务提供者
consumer 8801 服务消费者
chainMonitor 8770 链路追踪服务端

3.2 服务链路追踪服务端

1. pom.xml添加依赖
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- zipkin 界面-->
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.11.5</version>
        </dependency>
        <!-- zipkin 服务类-->
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.11.5</version>
        </dependency>
2.配置文件
server:
  port: 8770

spring:
  application:
    name: chainmonitor

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
management:
  metrics:
    web:
      server:
        auto-time-requests: false
3.启动类添加注解@EnableZipkinServer
@SpringBootApplication
@EnableEurekaClient
@EnableZipkinServer
public class ChainmonitorApplication {

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

3.3 服务链路追踪客户端

3.3.1 服务提供者provider

1.pom.xml添加依赖
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
2.配置文件
server:
  port: 8800

spring:
  application:
    name: provider
  # zipkin的地址:通过真实IP地址访问  
  zipkin:
    base-url: http://localhost:8770
    #通过服务名访问
    #base-url: http://chainmonitor/
  sleuth:
    sampler:
      #设置采样率,为了测试设置100%采集,设置为1.0
      probability: 1.0
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
3.服务接口
@RestController
public class HelloController {
    @RequestMapping(value = "/getBookByName")
    public String getNameById(@RequestParam("id") String id){
        String bookName = "";
        switch (id){
            case "1" :
                bookName = "Java";
                break;
            case "2" :
                bookName = "C++";
                break;
            default:
                bookName = "phython";
        }
        return bookName;
    }
}

3.3.2 服务消费者consumer

1.pom.xml添加依赖
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
2.配置文件
server:
  port: 8801

spring:
  application:
    name: consumer
  # zipkin的地址:通过真实IP地址访问  
  zipkin:
    base-url: http://localhost:8770
    #通过服务名访问
    #base-url: http://chainmonitor/
  sleuth:
    sampler:
      #设置采样率,为了测试设置100%采集,设置为1.0
      probability: 1.0
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

3.feign远程调用接口

@FeignClient(name = "provider")
public interface FeignService {
    @RequestMapping(value = "/getBookByName",method = RequestMethod.GET)
    String getBookByName(@RequestParam("id") String id);
}

4.服务接口

@RestController
public class HelloController {
    @Autowired
    private FeignService feignService;

    @RequestMapping(value = "getBookName")
    public String getBookName(@RequestParam("id") String id){
        return feignService.getBookByName(id);
    }
}

四、zipkin中图形化数据解析

4.1 zipkin可视化成功调用

在Zipkin中展示了跟踪信息,红框里是一个Trace


Trace

点击每个Trace,可以看到多个Span


span

点击每个span,可以看到详细信息
span详细信息

4.2 zipkin可视化失败调用

如果调用链路中发生接口调用失败,zipkin会默认使用红色展示信息,如下图:


span

点击红色的span,可以看到详细的失败信息:


失败信息

github示例代码下载

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容