Spring Boot跟蹤微服務日志

如果應用程序在運行過程發生問題，大多數開發人員都難以跟蹤日志。 這可以通過用於Spring Boot應用程序的Spring Cloud Sleuth和ZipKin服務器來解決。

Spring Cloud Sleuth

Spring cloud Sleuth日志以下列格式打印 -

[application-name,traceid,spanid,zipkin-export] 

Java

在上面格式中，

Application-name = 應用程序的名稱
Traceid = 每個請求和響應traceid在調用相同服務或一個服務到另一個服務時是相同的。
Spanid = Span Id與Trace Id一起打印。對於將一個服務調用到另一個服務的每個請求和響應，Span Id都不同。
Zipkin-export = 默認情況下為false。 如果是，則將日志導出到Zipkin服務器。

現在，在構建配置文件中添加Spring Cloud Starter Sleuth依賴項，如下所示 -

<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-sleuth</artifactId> </dependency> 

XML

Gradle用戶可以在build.gradle 文件中添加以下依賴項 -

compile('org.springframework.cloud:spring-cloud-starter-sleuth')

現在，將Logs添加到Spring Boot應用程序Rest Controller類文件中，如下所示 -

package com.yiibai.sleuthapp; import java.util.logging.Level; import java.util.logging.Logger; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @SpringBootApplication @RestController public class SleuthappApplication { private static final Logger LOG = Logger.getLogger(SleuthappApplication.class.getName()); public static void main(String[] args) { SpringApplication.run(SleuthappApplication.class, args); } @RequestMapping("/") public String index() { LOG.log(Level.INFO, "Index API is calling"); return "Welcome Sleuth!"; } } 

Java

現在，在application.properties 文件中添加應用程序名稱，如下所示 -

spring.application.name = tracinglogs

Shell

構建配置文件的完整代碼如下 -

Maven構建文件 - pom.xml

<?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.yiibai</groupId> <artifactId>sleuthapp</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>sleuthapp</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </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.RELEASE</spring-cloud.version> </properties> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-sleuth</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> </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> 

XML

Gradle構建文件:build.gradle -

buildscript {
   ext {
      springBootVersion = '1.5.9.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.yiibai'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}
ext {
   springCloudVersion = 'Edgware.RELEASE'
}
dependencies {
   compile('org.springframework.cloud:spring-cloud-starter-sleuth')
   compile('org.springframework.boot:spring-boot-starter-web')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}
dependencyManagement {
   imports {
      mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
   }
}

可以創建可執行的JAR文件，並使用以下Maven或Gradle命令運行Spring Boot應用程序。

對於Maven，可以使用以下命令 -

mvn clean install

Shell

在“BUILD SUCCESS” 之后，可以在目標目錄下找到JAR文件。

對於Gradle，可以使用以下命令 -

gradle clean build

Shell

在“BUILD SUCCESSFUL” 之后，可以在build/libs 目錄下找到JAR文件。

現在，使用以下命令運行JAR文件 -

java –jar <JARFILE>

Shell

現在，在Web瀏覽器中的URL => http://localhost:8080/ ，然后在控制台日志中查看輸出。

在控制台窗口中看到以下日志，日志以下列格式打印[application-name，traceid，spanid，zipkin-export]。

Zipkin服務器

Zipkin是一個監視和管理Spring Boot應用程序的Spring Cloud Sleuth日志的應用程序。 要構建Zipkin服務器，需要在構建配置文件中添加Zipkin UI和Zipkin Server依賴項。

Maven用戶可以在pom.xml 文件中添加以下依賴項 -

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

XML

Gradle用戶可以在build.gradle 文件中添加以下依賴項 -

compile('io.zipkin.java:zipkin-autoconfigure-ui')
compile('io.zipkin.java:zipkin-server')

現在，在應用程序屬性文件中配置server.port = 9411。
對於屬性(properties)文件用戶，請在application.properties文件中添加以下屬性。

server.port = 9411

Shell

對於YAML用戶，請在application.yml 文件中添加以下屬性。

server: port: 9411 

YAML

在主Spring Boot應用程序類文件中添加@EnableZipkinServer注解。@EnableZipkinServer注釋用於使應用程序充當Zipkin服務器。

package com.yiibai.zipkinapp; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import zipkin.server.EnableZipkinServer; @SpringBootApplication @EnableZipkinServer public class ZipkinappApplication { public static void main(String[] args) { SpringApplication.run(ZipkinappApplication.class, args); } } 

Java

完整構建配置文件的代碼如下所示。
Maven構建文件 - pom.xml -

<?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.yiibai</groupId> <artifactId>zipkinapp</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>zipkinapp</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version> <relativePath /> <!-- lookup parent from repository --> </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.RELEASE</spring-cloud.version> </properties> <dependencies> <dependency> <groupId>io.zipkin.java</groupId> <artifactId>zipkin-server</artifactId> </dependency> <dependency> <groupId>io.zipkin.java</groupId> <artifactId>zipkin-autoconfigure-ui</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </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> 

XML

Gradle構建文件 – build.gradle 的內容如下：

buildscript {
   ext {
      springBootVersion = '1.5.9.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.yiibai'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}
ext {
   springCloudVersion = 'Edgware.RELEASE'
}
dependencies {
   compile('io.zipkin.java:zipkin-autoconfigure-ui')
   compile('io.zipkin.java:zipkin-server')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}
dependencyManagement {
   imports {
      mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
   }
}

可以創建一個可執行的JAR文件，並使用下面的Maven或Gradle命令運行Spring Boot應用程序 -
對於Maven，請使用下面給出的命令 -

mvn clean install

Shell

在“BUILD SUCCESS”之后，可以在target目錄下找到JAR文件。

對於Gradle，請使用下面給出的命令 -

gradle clean build

Shell

在“BUILD SUCCESSFUL”之后，可以在build/libs目錄下找到JAR文件。

使用顯示的命令運行JAR文件 -

java –jar <JARFILE>

Shell

現在，應用程序已在Tomcat端口9411上啟動。

現在，訪問URL => http://localhost:9411/zipkin/ ，並查看Zipkin服務器UI。

然后，在客戶端服務應用程序中添加以下依賴項，並指出Zipkin Server URL以通過Zipkin UI跟蹤微服務日志。

現在，在構建配置文件中添加Spring Cloud Starter Zipkin依賴項，如下所示 -

Maven用戶可以在pom.xml 文件中添加以下依賴項 -

<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-sleuth-zipkin</artifactId> </dependency> 

XML

Gradle用戶可以在build.gradle 文件中添加以下依賴項 -

compile('org.springframework.cloud:spring-cloud-sleuth-zipkin')

現在，在Spring Boot應用程序中添加Always Sampler Bean，將日志導出到Zipkin服務器。

@Bean public AlwaysSampler defaultSampler() { return new AlwaysSampler(); } 

Java

如果添加AlwaysSampler Bean，則自動Spring Sleuth Zipkin Export選項將從false更改為true。

接下來，在客戶端服務application.properties 文件中配置Zipkin Server基本URL。

spring.zipkin.baseUrl = http://localhost:9411/zipkin/

然后，提供跟蹤ID並在Zipkin UI中查找跟蹤。

http://localhost:9411/zipkin/traces/{traceid}/

Shell