9、spring cloud sleuth

微服務架構是一個強大的設計規(guī)范，按照業(yè)務劃分單元，將負責的單體軟件分解為更小、更容易管理的多個單元。然而這種靈活性是要付出代價的，那就是復雜性，如果出現(xiàn)了錯誤和異常，很難定位到問題。例如一個請求可能會調到很多微服務單元，如果沒有分布式鏈路追蹤，很難定位問題出現(xiàn)在哪一步，哪個單元。

舉個例子，在微服務系統(tǒng)中，一個來自用戶的請求，請求先達到前端A（如前端界面），然后通過遠程調用，達到系統(tǒng)的中間件B、C（如負載均衡、網(wǎng)關等），最后達到后端服務D、E，后端經(jīng)過一系列的業(yè)務邏輯計算最后將數(shù)據(jù)返回給用戶。對于這樣一個請求，經(jīng)歷了這么多個服務，怎么樣將它的請求過程的數(shù)據(jù)記錄下來呢？這就需要用到服務鏈路追蹤。

目前，鏈路追蹤組件有Google的Dapper，Twitter 的Zipkin，以及阿里的Eagleeye （鷹眼）等，它們都是非常優(yōu)秀的鏈路追蹤開源組件。

本文主要講述如何在Spring Cloud Sleuth中集成Zipkin。在Spring Cloud Sleuth中集成Zipkin非常的簡單，只需要引入相應的依賴和做相關的配置即可。

搭建sleuth環(huán)境和使用

  1. 在服務中添加maven依賴
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>

這個依賴會拉取sleuth所需要的所有核心庫，只需要添加這一個jar包，我們的sleuth環(huán)境就搭建好了。
訪問我們consumer服務可以看到日志：

2018-11-26 19:52:49.048  INFO [consumer-server,cc2bbb7c4086560a,cc2bbb7c4086560a,true] 39657 --- [nio-8111-exec-4] c.h.w.s.cloud.controller.Controller      : =================================
2018-11-26 19:52:49.051  INFO [consumer-server,cc2bbb7c4086560a,cc2bbb7c4086560a,true] 39657 --- [nio-8111-exec-4] c.h.w.s.cloud.controller.Controller      : =================================

可以看到provider的日志：

2018-11-26 19:52:50.389  INFO [provider-server,cc2bbb7c4086560a,3fa321844b01d3f1,true] 39650 --- [nio-8081-exec-1] c.h.w.s.c.controller.ProviderController  : ========================================
2018-11-26 19:52:50.390  INFO [provider-server,cc2bbb7c4086560a,3fa321844b01d3f1,true] 39650 --- [nio-8081-exec-1] c.h.w.s.c.controller.ProviderController  : provider service 
2018-11-26 19:52:50.390  INFO [provider-server,cc2bbb7c4086560a,3fa321844b01d3f1,true] 39650 --- [nio-8081-exec-1] c.h.w.s.c.controller.ProviderController  : ========================================

可以看到服務應用程序編寫的所有日志中都包含spring cloud sleuth跟蹤信息，其中[provider-server,cc2bbb7c4086560a,3fa321844b01d3f1,true]這段跟蹤信息分為應用程序名稱、跟蹤id，用戶請求的唯一表示符、跨度ID，在用戶事物中每個服務都會有一個跨度ID、發(fā)送到zipkin標志，是否將日志發(fā)送給zipkin服務器

這里我們sleuth環(huán)境就搭建完成，接下來我們開始使用zipkin搭建日志收集工具

sleuth整合zipkin

  1. 搭建zipkin服務，收集日志
    首先創(chuàng)建zipkin服務項目，添加maven依賴
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
        </dependency>

        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
        </dependency>

接著在啟動類上添加@EnableZipkinServer注解

@SpringBootApplication
@EnableEurekaClient
@EnableZipkinStreamServer
public class ZipKinApplication {

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

然后配置配置application配置文件

eureka:
  instance:
    prefer-ip-address: true #注冊服務的IP
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka
    register-with-eureka: true

server:
  port: 8999

spring:
  application:
    name: zipkin-server

配置端口，服務ID，并注冊到eureka中，這樣我們的zipkin服務就搭建好了，zipkin支持四種方式存儲日志：

  • 內存保存
  • MySQL
  • Cassandra
  • elasticsearch

這里我們先模擬內存保存日志方式，這種方式，只要zipkin服務重啟，日志數(shù)據(jù)就會丟失。

  1. 配置使用zipkin端
    首先添加maven依賴
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
            <version>RELEASE</version>
        </dependency>

接著配置application配置文件

spring:
  application:
    name: consumer-server
  sleuth:
      sampler:
        percentage: 1
  zipkin:
    base-url: http://localhost:8999

這里spring.zipkin.base-url指定zipkin服務的位置，spring.sleuth.sampler.percentage它的值介于0和1之間，0表示spring cloud sleuth不會發(fā)送任何事物數(shù)據(jù)到zipkin中，1表示spring cloud sleuth會發(fā)送所有事物日志到zipkin中，默認情況是0.1.

這樣整個環(huán)境就搭建完成，分別啟動所有的服務。
訪問一次consumer服務，然后瀏覽器打開zipkin服務連接，就可以看到zipkin服務了


zipkin

這里我們可以根據(jù)traceID搜索整個鏈路的詳細信息，例如



zipkin整合Elasticsearch

上面zipkin服務是以內存的方式保存日志，很明顯這不是一個很好的方式，這里我們使用Elasticsearch作為保存日志方式，并結合kibana工具，完成日志的簡單搜索。

首先需要準備Elasticsearch環(huán)境、kibana環(huán)境、rabbitMQ環(huán)境。

  1. 重新搭建zipkin服務，添加maven依賴
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-sleuth-zipkin-stream</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin</artifactId>
            <version>2.8.4</version>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-storage-elasticsearch-http</artifactId>
            <version>2.8.4</version>
        </dependency>
  1. 重新配置application配置文件
spring:
  application:
    name: zipkin-server
  rabbitmq:                             #mq連接配置
    addresses: 192.168.33.10:5672       #address
    username: guest                     #用戶名
    password: guest                     #密碼
  cloud:
    stream:
      bindings:
        output:
          content-type: application/json    #mq序列化方式
        input:
          content-type: application/json    #mq序列化方式


server:
  port: 8999


zipkin:
  storage:
    type: elasticsearch                 #zipkin保存方式
    StorageComponent: elasticsearch
    elasticsearch:                      #elasticsearch配置
      cluster: elasticsearch
      max-requests: 30
      index: zipkin
      index-shards: 3
      index-replicas: 1
      hosts: 192.168.33.10:9200

eureka:
  instance:
    prefer-ip-address: true #注冊服務的IP
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka
    register-with-eureka: true

這里就是rabbitMQ配置和elasticsearch配置，注釋已經(jīng)說明。這里zipkin服務端已經(jīng)配置完成

  1. 配置zipkin客戶端的使用，添加maven依賴
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-sleuth-zipkin-stream</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-stream-rabbit</artifactId>
        </dependency>
  1. 配置application配置文件
spring:
  application:
    name: consumer-server
  rabbitmq:
    addresses: 192.168.33.10:5672
    username: guest
    password: guest
  sleuth:
      sampler:
        percentage: 1
  zipkin:
    base-url: http://localhost:8999

這里也是一些基本配置，不用過多說明，這樣就完成整個環(huán)境的搭建，分別啟動所有服務。

等所有服務都啟動完成后，訪問consumer 端，日志顯示正常，zipkin管理后端無異常，打開kibana，創(chuàng)建索引，我創(chuàng)建的索引為zipkin*，索引創(chuàng)建成功后，就可以看到訪問日志了

訪問日志

這里我們日志收集工作基本完成，剩下的就是kibana的使用了。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

友情鏈接更多精彩內容