如果应用程序在运行过程发生问题,大多数开发人员都难以跟踪日志。 这可以通过用于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依赖项,如下所示 -
org.springframework.cloud
spring-cloud-starter-sleuth
Gradle用户可以在build.gradle 文件中添加以下依赖项 -
compile('org.springframework.cloud:spring-cloud-starter-sleuth')
现在,将Logs添加到Spring Boot应用程序Rest Controller类文件中,如下所示 -
package com.felix.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
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">
4.0.0
com.felix
sleuthapp
0.0.1-SNAPSHOT
jar
sleuthapp
Demo project for Spring Boot
org.springframework.boot
spring-boot-starter-parent
1.5.9.RELEASE
UTF-8
UTF-8
1.8
Edgware.RELEASE
org.springframework.cloud
spring-cloud-starter-sleuth
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
org.springframework.cloud
spring-cloud-dependencies
${spring-cloud.version}
pom
import
org.springframework.boot
spring-boot-maven-plugin
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.felix'
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
现在,在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 文件中添加以下依赖项 -
io.zipkin.java
zipkin-server
io.zipkin.java
zipkin-autoconfigure-ui
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.felix.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 -
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">
4.0.0
com.felix
zipkinapp
0.0.1-SNAPSHOT
jar
zipkinapp
Demo project for Spring Boot
org.springframework.boot
spring-boot-starter-parent
1.5.9.RELEASE
UTF-8
UTF-8
1.8
Edgware.RELEASE
io.zipkin.java
zipkin-server
io.zipkin.java
zipkin-autoconfigure-ui
org.springframework.boot
spring-boot-starter-test
test
org.springframework.cloud
spring-cloud-dependencies
${spring-cloud.version}
pom
import
org.springframework.boot
spring-boot-maven-plugin
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.felix'
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
现在,应用程序已在Tomcat端口9411上启动。
现在,访问URL => http://localhost:9411/zipkin/ ,并查看Zipkin服务器UI。
然后,在客户端服务应用程序中添加以下依赖项,并指出Zipkin Server URL以通过Zipkin UI跟踪微服务日志。
现在,在构建配置文件中添加Spring Cloud Starter Zipkin依赖项,如下所示 -
Maven用户可以在pom.xml 文件中添加以下依赖项 -
org.springframework.cloud
spring-cloud-sleuth-zipkin
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}/