Spring Boot - 跟踪微服务日志

如果发生任何问题，大多数开发人员都面临着跟踪日志的困难。这可以通过 Spring Cloud Sleuth 和 Spring Boot 应用程序的 ZipKin 服务器来解决。

春云侦探

Spring Cloud Sleuth 日志按以下格式打印 -

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

在哪里，

  • 应用程序名称=应用程序的名称

  • Traceid = 当调用相同的服务或一个服务到另一个服务时，每个请求和响应的traceid都是相同的。

  • Spanid = Span Id 与 Trace Id 一起打印。调用一个服务到另一服务的每个请求和响应的 Span Id 都是不同的。

  • Zipkin-export = 默认为 false。如果为 true，日志将被导出到 Zipkin 服务器。

现在，在构建配置文件中添加 Spring Cloud Starter Sleuth 依赖项，如下所示 -

Maven 用户可以在 pom.xml 文件中添加以下依赖项 -

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

Gradle 用户可以在 build.gradle 文件中添加以下依赖项 -

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

现在，将日志添加到 Spring Boot 应用程序 Rest Controller 类文件中，如下所示 -

package com.tutorialspoint.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.tutorialspoint</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.tutorialspoint'
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>

现在，应用程序已在 Tomcat 端口 8080 上启动。

在Tomcat端口8080上启动应用程序

现在，在 Web 浏览器中点击 URL 并查看控制台日志中的输出。

http://本地主机: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。

对于属性文件用户，请在 application.properties 文件中添加以下属性。

server.port = 9411

对于 YAML 用户，请在 application.yml 文件中添加以下属性。

server:
   port: 9411

在主 Spring Boot 应用程序类中添加 @EnableZipkinServer 注释。@EnableZipkinServer 注释用于使您的应用程序充当 Zipkin 服务器。

package com.tutorialspoint.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.tutorialspoint</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.tutorialspoint'
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”后，您可以在目标目录下找到JAR文件。

对于 Gradle，使用下面给出的命令 -

gradle clean build

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

使用所示命令运行 JAR 文件 -

java –jar <JARFILE>

现在，应用程序已在 Tomcat 端口 9411 上启动，如下所示 -

输出Tomcat端口9411

现在，点击下面的 URL 并查看 Zipkin 服务器 UI。

http://localhost:9411/zipkin/

Zipkin 服务器 UI

然后，在客户端服务应用程序中添加以下依赖项，并指出 Zipkin 服务器 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 服务器基本 URL。

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

然后，提供跟踪 ID 并在 Zipkin UI 中查找跟踪。

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