服务链路追踪---Sleuth

蔚落 2022-05-26 06:37 244阅读 0赞

Sleuth：日志收集工具包，封装了Dapper和log-based追踪以及Zipkin和HTrace操作，为SpringCloud应用实现了一种分布式追踪解决方案。

当服务与服务之间调用复杂时，SpringCloud Sleuth配合Zipkin提供的界面，可以直观的分析追踪数据，这篇文章介绍SpringCloud Sleuth与Zipkin配合使用。

新建Zipkin Server，加入zipkin依赖，pom文件如下：

<?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">
    	<modelVersion>4.0.0</modelVersion>
    
    	<groupId>com.dalaoyang</groupId>
    	<artifactId>springcloud_zipkin</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>springcloud_zipkin</name>
    	<description>springcloud_zipkin</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Edgware.SR1</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    
    		<dependency>
    			<groupId>io.zipkin.java</groupId>
    			<artifactId>zipkin-server</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>io.zipkin.java</groupId>
    			<artifactId>zipkin-autoconfigure-ui</artifactId>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    
    </project>

配置文件只配置了一个端口号：

##端口号
    server.port=9000

启动类加入注解@EnableZipkinServer，来声明是一个ZipkinServer，启动项目，可以看到控制的log已经变化了，如图

![image][]

然后在浏览器访问[http://localhost:9000/zipkin/dependency/][http_localhost_9000_zipkin_dependency]，如下图

![image][image 1]

为了方便我们观察，分别创建了两个项目，first\_service（9001），second\_service（9002），pom文件加入spring-cloud-starter-zipkin依赖，  
first\_service（9001）pom文件代码如下：

<?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">
    	<modelVersion>4.0.0</modelVersion>
    
    	<groupId>com.dalaoyang</groupId>
    	<artifactId>springcloud_zipkin_firstservice</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>springcloud_zipkin_firstservice</name>
    	<description>springcloud_zipkin_firstservice</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Edgware.SR1</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-devtools</artifactId>
    			<scope>runtime</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-zipkin</artifactId>
    			<version>1.3.1.RELEASE</version>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    
    </project>

配置文件，其中spring.zipkin.base-url指定zipkin server地址

server.port=9001
    spring.zipkin.base-url=http://localhost:9000
    spring.application.name=first_service

启动类加上@RestController注解方便测试，然后新建两个方法，一个用于被调用，一个调用其他，代码如下：

package com.dalaoyang;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.context.annotation.Bean;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    @RestController
    public class SpringcloudZipkinFirstserviceApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(SpringcloudZipkinFirstserviceApplication.class, args);
    	}
    
    	@Bean
    	@LoadBalanced
    	RestTemplate restTemplate() {
    		return new RestTemplate();
    	}
    
    	@Value("${spring.application.name}")
    	String serviceName;
    
    	@RequestMapping("/callSecond")
    	public String callSecond(){
    		return restTemplate().getForObject("http://localhost:9002/second", String.class);
    	}
    
    
    	@RequestMapping("/first")
    	public String first(){
    		return serviceName;
    
    	}
    }

到这里first\_service（9001）代码展示完成，接下来是second\_service（9002）代码，内容不在赘述，和first\_service（9001）类似。

pom文件

<?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">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.dalaoyang</groupId>
        <artifactId>springcloud_zipkin_secondservice</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>springcloud_zipkin_secondservice</name>
        <description>springcloud_zipkin_secondservice</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.9.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <spring-cloud.version>Edgware.SR1</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zipkin</artifactId>
                <version>1.3.1.RELEASE</version>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

配置文件：

server.port=9002
    spring.zipkin.base-url=http://localhost:9000
    spring.application.name=second_service

启动类：

package com.dalaoyang;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.loadbalancer.LoadBalanced;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    @RestController
    public class SpringcloudZipkinSecondserviceApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(SpringcloudZipkinSecondserviceApplication.class, args);
    	}
    
    
    	@Bean
    	@LoadBalanced
    	RestTemplate restTemplate() {
    		return new RestTemplate();
    	}
    
    	@Value("${spring.application.name}")
    	String serviceName;
    
    	@RequestMapping("/second")
    	public String second(){
    		return serviceName;
    	}
    
    	@RequestMapping("/callFirst")
    	public String callFirst(){
    		return restTemplate().getForObject("http://localhost:9001/first",String.class);
    	}
    }

启动这两个项目，浏览器访问[http://localhost:9001/callSecond][http_localhost_9001_callSecond]，然后观看Zipkin Server页面，可以看到调用关系，请求细节等，如下图：

![image][image 2]

![image][image 3]

![image][image 4]

![image][image 5]

源码下载 ：[大老杨码云][Link 1]

个人网站：[https://www.dalaoyang.cn][https_www.dalaoyang.cn]

[image]: /images/20220526/d2178974cdbd4e6fbb1772d60f35d401.png
[http_localhost_9000_zipkin_dependency]: http://localhost:9000/zipkin/dependency/
[image 1]: /images/20220526/17869e2733b24cc3b12414e1928e0023.png
[http_localhost_9001_callSecond]: http://localhost:9001/callSecond
[image 2]: /images/20220526/5c6e4719fa4f421eb1d389ab5b5928d9.png
[image 3]: /images/20220526/19a4a03456744b438b074da40bcd02c7.png
[image 4]: /images/20220526/0832c404bc164ccf8d4baaffc1cb9028.png
[image 5]: /images/20220526/fe60eb4fc8ee4672a6793c2d0837862f.png
[Link 1]: https://gitee.com/dalaoyang/springcloud_learn.git
[https_www.dalaoyang.cn]: https://www.dalaoyang.cn/