Spring Boot跟蹤微服務紀錄檔

如果應用程式在執行過程發生問題，大多數開發人員都難以跟蹤紀錄檔。 這可以通過用於Spring Boot應用程式的Spring Cloud Sleuth和ZipKin伺服器來解決。

Spring Cloud Sleuth

Spring cloud Sleuth紀錄檔以下列格式列印 -

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

在上面格式中，

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>

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!";
   }
}

現在，在application.properties 檔案中新增應用程式名稱，如下所示 -

spring.application.name = tracinglogs

構建組態檔案的完整程式碼如下 -

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>

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

在「BUILD SUCCESS」 之後，可以在目標目錄下找到JAR檔案。

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

gradle clean build

在「BUILD SUCCESSFUL」 之後，可以在build/libs 目錄下找到JAR檔案。

現在，使用以下命令執行JAR檔案 -

java –jar <JARFILE>

現在，在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>

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

對於YAML使用者，請在application.yml 檔案中新增以下屬性。

server:
   port: 9411

在主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);
   }
}

完整構建組態檔案的程式碼如下所示。
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>

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

在「BUILD SUCCESS」之後，可以在target目錄下找到JAR檔案。

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

gradle clean build

在「BUILD SUCCESSFUL」之後，可以在build/libs目錄下找到JAR檔案。

使用顯示的命令執行JAR檔案 -

java –jar <JARFILE>

現在，應用程式已在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>

Gradle使用者可以在build.gradle 檔案中新增以下依賴項 -

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

現在，在Spring Boot應用程式中新增Always Sampler Bean，將紀錄檔匯出到Zipkin伺服器。

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

如果新增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}/