• 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
  • 相关阅读:
    反向代理与 Real-IP 和 X-Forwarded-For
    Jmeter学习笔记(十一)——定时器
    Jmeter学习笔记(十)——元件的作用域和执行顺序
    Jmeter学习笔记(九)——响应断言
    Jmeter学习笔记(八)——监听器元件之聚合报告
    Jmeter学习笔记(七)——监听器元件之察看结果树
    Jmeter学习笔记(六)——使用badboy录制脚本
    Jmeter学习笔记(五)——dubbo接口测试
    Jmeter学习笔记(四)配置元件之计数器
    jmeter学习笔记(三)配置元件之HTTP信息头管理
  • 原文地址:https://www.cnblogs.com/borter/p/12423859.html
Copyright © 2020-2023  润新知