前言:在上一章节中简单的概括了SpringCloud Sleuth和zipkin之间的关系,所以为了可视化得观察服务间的调用过程,我们本节会先去搭建zipkin

1、下载zipkin的jar包

注:SpringCloud从F版起已不需要自己构建Zipkin Server,只需调用jar包即可

zipkin server jar包下载地址:https://repo1.maven.org/maven2/io/zipkin/java/zipkin-server/

点进2.9.4版本目录

下载zipkin-server-2.9.4-exec.jar

2、运行zipkin server jar包

在zipkin-server-2.9.4-exec.jar包所在的目录运行cmd命令行,然后输入以下命令启动jar包

java -jar zipkin-server-2.9.4-exec.jar

效果图:

3、查看zipkin是否正常运行

在浏览器输入http://localhost:9411/zipkin/然后按下回车,进入zipkin控制台页面

效果图:

4、相关名词解释

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

Span:表示调用链路来源,通俗的理解span就是一次请求信息

下图表示一请求链路,一条链路通过Trace ld唯一标识,Span标识发起的请求信息,各span通过parent id关联起来

把图精简下

5、修改服务提供者provider-payment8001子模块的pom.xml文件,导入zipkin依赖,然后reolad一下,下载依赖

例:

<?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>springcloud01</artifactId>
        <groupId>com.ken.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>provider-payment8001</artifactId>

    <dependencies>
        <!--包含了sleuth+zipkin-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
        <!--以下依赖都没写版本号,没写版本号的情况下会引用父项目的版本-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--监控-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--Mybatis和SpringBoot的整合-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <!--mysql-connector-java-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--jdbc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <!--lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--引入自己定义的api调用包,可以使用Payment模块的entity-->
        <dependency>
            <groupId>com.ken.springcloud</groupId>
            <artifactId>api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--Eureka Clinet-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    </dependencies>

</project>

查看provider-payment8001子模块的依赖,可以看到spring-cloud-starter-zipkin包是包含了sleuth和zipkin的

6、修改provider-payment8001子模块的application.yml文件配置
#服务端口号
server:
  port: 8001

#服务名称
spring:
  application:
    name: cloud-payment-service
    #指定Zipkin的服务器地址
    zipkin:
      base-url: http://localhost:9411
    sleuth:
      sampler:
        #采样率值介于0到1之间,1则表示全部采集(一般用0.5,这里为了演示用1)
        probability: 1
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource      #当前数据源操作类型
    driver-class-name: com.mysql.cj.jdbc.Driver       #mysql驱动包(mysql驱动包版本是5的要写成com.mysql.jdbc.Driver)
    url: jdbc:mysql://localhost:3306/cloud?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=GMT%2B8 #mysql连接路径,记得把cloud这个数据库名改成自己的,或者新建名为cloud的数据库
    username: root
    password: 123456

eureka:
  client:
    #表示是否将自己注册进Eureka Server里,默认为true
    register-with-eureka: true
    #是否从Eureka Server抓取已有的注册信息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:7001/eureka
#      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
  instance:
    instance-id: payment8001
    #访问路径可以显示IP地址
    prefer-ip-address: true
    #Eureka客户端向服务端发送心跳的时间间隔,单位为秒(默认是30秒)
    lease-renewal-interval-in-seconds: 1
    #Eureka服务端在收到最后一次心跳后等待时间上限,单位为秒(默认是90秒),超时将剔除服务
    lease-expiration-duration-in-seconds: 2

#mybatis配置
mybatis:
  mapper-locations: classpath:mapper/*.xml            #扫描类路径下的mapper文件夹下所有的.xml配置文件
  type-aliases-package: com.ken.springcloud.entities  #该包下的所有Entity类都取默认别名

7、修改provider-payment8001子模块的PaymentController类,增加/payment/zipkin接口
package com.ken.springcloud.controller;

import com.ken.springcloud.entities.CommonResult;
import com.ken.springcloud.entities.Payment;
import com.ken.springcloud.service.PaymentService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;
import java.util.concurrent.TimeUnit;

@RestController
@Slf4j
public class PaymentController {

    @Resource
    private PaymentService paymentService;

    @Value("${server.port}")
    private String serverPort;

    @Resource
    private DiscoveryClient discoveryClient;

    @PostMapping("/payment/insert")
    public CommonResult insert(@RequestBody Payment payment) {
        int result = paymentService.insert(payment);
        log.info("插入结果{}",result);
        if(result > 0) {
            return new CommonResult(200,"插入数据库成功,提供服务的端口号为" + serverPort,result);
        }else {
            return new CommonResult(500,"插入数据库失败",result);
        }
    }

    @GetMapping("/payment/get/{id}")
    public CommonResult insert(@PathVariable("id") Long id) {
        Payment payment = paymentService.getPaymentById(id);
        log.info("查询结果{}",payment);
        if(payment != null) {
            return new CommonResult(200,"查询成功,提供服务的端口号为" + serverPort,payment);
        }else {
            return new CommonResult(500,"没有对应的数据,查询失败,查询id" + id,payment);
        }
    }

    @GetMapping("/payment/discovery")
    public Object discovery() {
        //获取eureka内的服务
        List<String> services = discoveryClient.getServices();
        for (String service : services) {
            log.info("***service:" + service);
        }
        //获取服务名为CLOUD-PAYMENT-SERVICE下的实例
        List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");
        for (ServiceInstance instance : instances) {
            log.info(instance.getServiceId()+"\t"+instance.getHost()+"\t"+instance.getPort()+"\t"+instance.getUri());
        }
        return this.discoveryClient;
    }

    @GetMapping("/payment/lb")
    public String getPaymentLB() {
        //返回当前服务的端口号
        return serverPort;
    }

    @GetMapping("/payment/feign/timeout")
    public String paymentFeigntimeout() {
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        //返回当前服务的端口号
        return serverPort;
    }

    @GetMapping("/payment/zipkin")
    public String paymentZipkin() {
        return "进入provider-payment8001模块的/payment/zipkin接口";
    }

}

8、修改服务消费者consumer-order80子模块的pom.xml文件,导入zipkin依赖,然后reolad一下,下载依赖

例:

<?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>springcloud01</artifactId>
        <groupId>com.ken.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>consumer-order80</artifactId>

    <dependencies>
        <!--包含了sleuth+zipkin-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
        <!--以下依赖都没写版本号,没写版本号的情况下会引用父项目的版本-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--监控-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <!--lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--引入自己定义的api调用包,可以使用Payment模块的entity-->
        <dependency>
            <groupId>com.ken.springcloud</groupId>
            <artifactId>api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--Eureka Clinet-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    </dependencies>

</project>

9、修改consumer-order80子模块的application.yml文件配置
server:
  port: 80  #用80端口是因为浏览器网页服务默认的端口号都是80(80端口是为HTTP开放的)

spring:
  application:
    name: cloud-order-service
  #指定Zipkin的服务器地址
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      #采样率值介于0到1之间,1则表示全部采集(一般用0.5,这里为了演示用1)
      probability: 1

eureka:
  client:
    #表示是否将自己注册进Eureka Server里,默认为true
    register-with-eureka: true
    #是否从Eureka Server抓取已有的注册信息,默认为true,单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url:
      #defaultZone: http://localhost:7001/eureka
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
#ribbon:
#  NFLoadBalancerRuleClassName=com.netflix.loadbalancer.RandomRule

10、修改consumer-order80子模块的OrderController类,增加/consumer/payment/zipkin接口
package com.ken.springcloud.controller;

import com.ken.springcloud.entities.CommonResult;
import com.ken.springcloud.entities.Payment;
import com.ken.springcloud.lb.LoadBalancer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import javax.annotation.Resource;
import java.net.URI;
import java.util.List;

@RestController
@Slf4j
public class OrderController {

    //public static final String PAYMENT_URL = "http://localhost:8001";
    public static final String PAYMENT_URL = "http://CLOUD-PAYMENT-SERVICE";

    @Resource
    private RestTemplate restTemplate;

    @Resource
    private LoadBalancer loadBalancer;

    @Resource
    private DiscoveryClient discoveryClient;

    @PostMapping("/consumer/insert")
    public CommonResult<Payment> insert(Payment payment) {
        log.info("payment:{}",payment);
        return restTemplate.postForObject(PAYMENT_URL + "/payment/insert",payment,CommonResult.class);
    }

    /**
     * 返回对象为响应体中数据转化成的对象,基本上可以理解为Json
     * @param id
     * @return
     */
    @GetMapping("/consumer/get/{id}")
    public CommonResult<Payment> getPayment(@PathVariable("id") Long id) {
        return restTemplate.getForObject(PAYMENT_URL + "/payment/get/" + id,CommonResult.class);
    }

    /**
     * 返回对象为ResponseEntity对象,包含了响应中的一些重要信息,比如响应头、响应状态码、响应体等
     * @param id
     * @return
     */
    @GetMapping("/consumer/getForEntity/{id}")
    public CommonResult<Payment> getPayment2(@PathVariable("id") Long id) {
        ResponseEntity<CommonResult> entity =  restTemplate.getForEntity(PAYMENT_URL + "/payment/get/" + id,CommonResult.class);
        if(entity.getStatusCode().is2xxSuccessful()) {
            return entity.getBody();
        }else {
            return new CommonResult<>(500,"异常");
        }
    }

    @GetMapping("/consumer/payment/lb")
    public String getPaymentLB() {
        //获取服务名为CLOUD-PAYMENT-SERVICE下的实例
        List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");
        if (instances == null || instances.size() <= 0) {
            return null;
        }
        //获取提供接口服务的服务实例
        ServiceInstance serviceInstance = loadBalancer.instances(instances);
        //获取接口地址
        URI uri = serviceInstance.getUri();
        //请求服务接口
        return restTemplate.getForObject(uri + "/payment/lb",String.class);
    }

    @GetMapping("/consumer/payment/zipkin")
    public String paymentZipkin() {
        String result = restTemplate.getForObject("http://localhost:8001/payment/zipkin/",String.class);
        return result;
    }

}

11、分别启动eureka-server7001、provider-payment8001、consumer-order80

效果图:

12、在浏览器地址栏输入http://localhost/consumer/payment/zipkin接口,然后多次按回车发起请求

13、使用zipkin追踪链路
(1)选择需要跟踪的微服务名称

我这里选择跟踪cloud_order-service服务

(2)选择需要跟踪的方法

我这里选择跟踪所有的方法

(3)选择回看过去多少时间内的跟踪

我这里选择回看过去1小时内的跟踪

(4)点击Find Traces按钮开始查找链路踪迹

效果图:

(5)随便点进去一个查看链路的调用情况

例如我点击第一个

效果图:

(6)可以看到有2个服务名称,其中cloud-payment-service在cloud-order-service的下一级,这说明是cloud-order-service服务调用的cloud-payment-service服务

(7)可以看到有2个方法名称,这说明的是cloud-order-service服务的/consumer/payment/zipkin接口调用cloud-order-service服务的/payment/zipkin/接口

(8)点击依赖分析

效果图:

可以看到箭头由cloud-payment-service服务指向cloud-order-service服务

Logo

汇聚全球AI编程工具,助力开发者即刻编程。

更多推荐