服务链路追踪(Spring Cloud Sleuth) sping boot 集成 zipkin 的 Demo（一）

一、首先建立四个项目

1、服务端项目名称 ZipkinServer

pom文件如下

其中主要是zipkin的依赖

<?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.zipkinServer</groupId>
	<artifactId>ZipkinServer</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>ZipkinServer</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.8.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>Camden.SR6</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-web</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>

		<!--加上zipkin的依赖和zipkin-autoconfigure-storage-elasticsearch-http的依赖-->
		<dependency>
			<groupId>io.zipkin.java</groupId>
			<artifactId>zipkin</artifactId>
			<version>1.28.0</version>
		</dependency>
		<dependency>
			<groupId>io.zipkin.java</groupId>
			<artifactId>zipkin-autoconfigure-storage-elasticsearch-http</artifactId>
			<version>1.28.0</version>
		</dependency>

		<!--ELK依赖-->
		<dependency>
			<groupId>net.logstash.logback</groupId>
			<artifactId>logstash-logback-encoder</artifactId>
			<version>4.9</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>

application.properties 文件如下

server.port=11008
spring.application.name=ZipkinServer

在启动主方法类中加上注解 @EnableZipkinServer，声明这是一个zipkin的服务端

package com.zipkinServer.ZipkinServer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import zipkin.server.EnableZipkinServer;

@SpringBootApplication
@EnableZipkinServer
public class ZipkinServerApplication {

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

}

2、客户端A 项目名称 ZipkinHello

pom文件如下，同样主要是zipkin的依赖

<?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.ZipkinHello</groupId>
	<artifactId>ZipkinHello</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>ZipkinHello</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.8.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>Camden.SR6</spring-cloud.version>
	</properties>

	<dependencies>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
        <!--
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-sleuth</artifactId>
		</dependency>
        -->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-zipkin</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

		<!--ELK依赖-->
		<dependency>
			<groupId>net.logstash.logback</groupId>
			<artifactId>logstash-logback-encoder</artifactId>
			<version>4.9</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>

application.properties文件如下

server.port=8989
spring.zipkin.base-url=http://localhost:11008
spring.application.name=ZipkinHello

集成日志工具logback往ELK输出所以logback.xml文件如下

<?xml version="1.0" encoding="UTF-8" ?>
<!-- 级别从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别，日志输出时，级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>ZipkinHello</contextName>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <springProperty scope="context" name="springAppName" source="spring.application.name"/>

    <!-- 日志输出格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS}[%X{X-B3-TraceId:-},%X{X-B3-SpanId:-}] [%thread] %-5level %logger{50} - %msg%n"/>
    <!-- 定义日志文件 输出位置 -->
    <property name="log.home_dir" value="F:\\logs\\ZipkinHello"/>
    <!-- 日志最大的历史 30天 -->
    <property name="log.maxHistory" value="30"/>
    <!-- 打印debug级别日志及以上级别日志 -->
    <property name="log.level" value="debug"/>

    <!-- ConsoleAppender 控制台输出日志 start -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
        <encoder>
            <pattern>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>utf8</charset>
            </pattern>
        </encoder>
    </appender>
    <!-- ConsoleAppender 控制台输出日志 end -->

    <!-- errorAppender 控制台输出日志 start -->
    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录WARN级别的日志 -->
        <!-- 果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责触发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可以是相对和绝对路径 -->
            <fileNamePattern>
                ${log.home_dir}/error/%d{yyyy-MM-dd}/errorLog-%i.log
            </fileNamePattern>
            <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件假设设置每个月滚动，且<maxHistory>是6， 则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${log.maxHistory}</maxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 单个log文件超过该大小就会重新建一个log文件 -->
                    <MaxFileSize>2MB</MaxFileSize>
                </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>utf8</charset>
            </pattern>
        </encoder>
    </appender>
    <!-- errorAppender 控制台输出日志 end -->

    <!-- warnAppender 控制台输出日志 start -->
    <appender name="warn" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>
                ${log.home_dir}/warn/%d{yyyy-MM-dd}/warnLog-%i.log
            </fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>2MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>utf8</charset>
            </pattern>
        </encoder>
    </appender>
    <!-- warnAppender 控制台输出日志 end -->

    <!-- infoAppender 控制台输出日志 start -->
    <appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.home_dir}/info/%d{yyyy-MM-dd}/infoLog-%i.log</fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>2MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>utf8</charset>
            </pattern>
        </encoder>
    </appender>
    <!-- infoAppender 控制台输出日志 end -->

    <!-- debugAppender 控制台输出日志 start -->
    <appender name="debug" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.home_dir}/debug/%d{yyyy-MM-dd}/debugLog-%i.log</fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>2MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                <charset>utf8</charset>
            </pattern>
        </encoder>
    </appender>
    <!-- debugAppender 控制台输出日志 end -->

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>
                %d{yyyy-MM-dd HH:mm:ss SSS} [%thread] %-5level %logger{36} - %msg%n
            </Pattern>
        </layout>
    </appender>

    <!--日志发送到logstash=>elasticSearch=>kibana start-->
    <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>localhost:9601</destination>
        <queueSize>1048576</queueSize>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder" />
    </appender>

    <logger name="kibanaLog" level="DEBUG" additivity="false">
        <appender-ref ref="LOGSTASH"/>
    </logger>
    <!--日志发送到logstash=>elasticSearch=>kibana end -->
    
    <root>
        <level value="${log.level}"/>
        <!-- 控制台输出 -->
        <appender-ref ref="console"/>
        <!-- 文件输出 -->
        <appender-ref ref="error"/>
        <appender-ref ref="warn"/>
        <appender-ref ref="info"/>
        <appender-ref ref="debug"/>
    </root>

    <!-- 文件不输出 -->
    <Logger name="org.springframework" level="ERROR"></Logger>
    <Logger name="org.hibernate" level="ERROR"></Logger>
    <Logger name="org.apache" level="ERROR"></Logger>
    <Logger name="com.netflix" level="ERROR"></Logger>
    <Logger name="ch.qos.logback" level="ERROR"></Logger>

</configuration>

程序入口代码

package com.zipkinServer.ZipkinServer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@SpringBootApplication
@RestController
public class ZipkinHelloApplication {

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

	private final static Logger logger = LoggerFactory.getLogger(ZipkinHelloApplication.class);
	private final static Logger kibanaLogger = LoggerFactory.getLogger("kibanaLog");

	@Autowired
	private RestTemplate restTemplate;

	@Bean
	public RestTemplate getRestTemplate(){
		return new RestTemplate();
	}

	@RequestMapping("/sayhello")
	public String sayhello() {
		logger.info("----sayhello----");
		kibanaLogger.info("======kibana:sayhello======");
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8999/helloToGoodBye?name={1}", String.class, "8989张三");
		return responseEntity.getBody();
	}
	@RequestMapping("/goodBye")
	public String goodBye(String name) {
		logger.info("----goodBye----");
		kibanaLogger.info("======kibana:goodBye======");
		return "goodBye,"+name;
	}

}

第一个sayHello是调用服务的发起者

第二个goodBye服务是被调用方

客户端A ZipkinHello 完毕

3、客户端B ZipkinUnicom 该服务作为 A C 服务的中转服务存在具体设置与客户端A类似主要取别如下

application.properties文件

server.port=8999
spring.zipkin.base-url=http://localhost:11008
spring.application.name=ZipkinUnicom

程序代码

package com.zipkinServer.ZipkinServer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@SpringBootApplication
@RestController
public class ZipkinUnicomApplication {

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

	private final static Logger logger = LoggerFactory.getLogger(ZipkinUnicomApplication.class);
	private final static Logger kibanaLogger = LoggerFactory.getLogger("kibanaLog");

	@Autowired
	private RestTemplate restTemplate;

	@Bean
	public RestTemplate getRestTemplate(){
		return new RestTemplate();
	}

	@RequestMapping("/helloToGoodBye")
	public String helloToGoodBye(String name) {
		logger.info("====helloToGoodBye====");
		kibanaLogger.info("=========kibana:helloToGoodBye=========");
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8988/hello?name={1}", String.class, name);
		return responseEntity.getBody();
	}
	@RequestMapping("/goodByeToHello")
	public String goodByeToHello(String name) {
		logger.info("====goodByeToHello====");
		kibanaLogger.info("=========kibana:goodByeToHello=========");
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8989/goodBye?name={1}", String.class, name);
		return responseEntity.getBody();
	}

}

4、客户端C ZipkinGoodBye

application.properties代码如下

server.port=8988
spring.zipkin.base-url=http://localhost:11008
spring.application.name=ZipkinGoodBye

程序代码如下

package com.zipkinServer.ZipkinServer;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
@RestController
public class ZipkinGoodByeApplication {

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

	private final static Logger logger = LoggerFactory.getLogger(ZipkinGoodByeApplication.class);
	private final static Logger kibanaLogger = LoggerFactory.getLogger("kibanaLog");

	@Autowired
	private RestTemplate restTemplate;

	@Bean
	public RestTemplate getRestTemplate(){
		return new RestTemplate();
	}

	@RequestMapping("/sayGoodBye")
	public String sayGoodBye() {
		logger.info("----sayGoodBye----");
		kibanaLogger.info("=========kibana:sayGoodBye=========");
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost:8999/goodByeToHello?name={1}", String.class, "8988李四");
		return responseEntity.getBody();
	}
	@RequestMapping("/hello")
	public String sayHello2(String name) {
		logger.info("----hello----");
		kibanaLogger.info("=========kibana:hello=========");
		return "hello,"+name;
	}

}

二、启动这四个服务

启动顺序为 ZipkinServer -->ZipkinHello --> ZipkinUnicom --> ZipkinGoodBye 要按顺序启动

启动后打开http://localhost:11008/可看到界面

三、访问地址http://localhost:8988/sayGoodBye，http://localhost:8989/sayhello

可以看到返回信息界面

四、查看控制台打印的日志

三个客户端服务分别输出下列日志

2018-11-09 17:45:53.953[3b823e4538d5bd90,3b823e4538d5bd90] [http-nio-8989-exec-4] INFO  c.zipkinServer.ZipkinServer.ZipkinHelloApplication - ----sayhello----

2018-11-09 17:45:53.958[3b823e4538d5bd90,053423295201b4c4] [http-nio-8999-exec-4] INFO  c.z.ZipkinServer.ZipkinUnicomApplication - ====helloToGoodBye====

2018-11-09 17:45:53.966[3b823e4538d5bd90,dce48c58b696242f] [http-nio-8988-exec-5] INFO  c.z.ZipkinServer.ZipkinGoodByeApplication - ----hello----

因为logback服务定义的输出日志格式是

    <!-- 日志输出格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS}[%X{X-B3-TraceId:-},%X{X-B3-SpanId:-}] [%thread] %-5level %logger{50} - %msg%n"/>

[%X{X-B3-TraceId:-},%X{X-B3-SpanId:-}] 的部分都是“3b823e4538d5bd90”  表明它是一次调用的一个过程

这样就能通过日志查看服务的调用情况了

服务链路追踪(Spring Cloud Sleuth) sping boot 集成 zipkin 的 Demo（一）

使用c#强大的表达式树实现对象的深克隆之解决循环引用的问题

痞子衡嵌入式：恩智浦i.MX RT1xxx系列MCU启动那些事（12.A）- uSDHC eMMC启动时间(RT1170)

本地SSL证书过期输入命令在IIS自动生成

springboot+springsecurity單點登錄sso實現（csrf過濾器post驗證）

spring boot 單體項目集成 spring security 實現登錄認證權限認證 jwt token認證

前後端分離+springboot+springsecurity單點登錄sso實現（csrf過濾器post驗證）

服務鏈路追蹤(Spring Cloud Sleuth) sping boot 集成 zipkin 的 Demo（一）

springboot集成mybatis-plus時注入mapper失敗的問題

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結