Spring Boot - 微服务日志追踪

---

---

大多数开发人员在出现问题时难以追踪日志。这可以通过 Spring Cloud Sleuth 和 ZipKin 服务器来解决 Spring Boot 应用的问题。

注意* - Spring Cloud Sleuth 在 Spring Boot 3 中不再受支持，已迁移到分布式版本 micrometer。

Spring Cloud Sleuth

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.GetMapping;
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);
   }
   @GetMapping("/")
   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 = '3.3.3'
   }
   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 = 21

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”后，您可以在 target 目录下找到 JAR 文件。

对于 Gradle，您可以使用以下命令：

gradle clean build

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

现在，使用此处显示的命令运行 JAR 文件：

java –jar <JARFILE> 

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

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

https://127.0.0.1:8080/

您可以在控制台窗口中看到以下日志。注意日志以以下格式打印 [应用名称，TraceId，SpanId，Zipkin-export]