Spring Boot - Verfolgung von Micro Service-Protokollen

Die meisten Entwickler haben Schwierigkeiten, Protokolle zu verfolgen, wenn ein Problem aufgetreten ist. Dies kann durch Spring Cloud Sleuth und ZipKin Server für Spring Boot-Anwendung gelöst werden.

Frühlingswolke Sleuth

Spring Cloud Sleuth-Protokolle werden im folgenden Format gedruckt:

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

Wo,

  • Anwendungsname = Name der Anwendung

  • Trace-ID = Jede Anforderungs- und Antwort-Trace-ID ist dieselbe, wenn derselbe Dienst oder ein Dienst zu einem anderen Dienst aufgerufen wird.

  • Spanid = Span-ID wird zusammen mit der Trace-ID gedruckt. Die Bereichs-ID unterscheidet sich bei jeder Anforderung und Antwort, die einen Dienst an einen anderen Dienst anruft.

  • Zipkin-Export = Standardmäßig ist es falsch. Wenn dies der Fall ist, werden Protokolle auf den Zipkin-Server exportiert.

Fügen Sie nun die Spring Cloud Starter Sleuth-Abhängigkeit wie folgt in Ihre Build-Konfigurationsdatei ein:

Maven-Benutzer können der Datei pom.xml die folgende Abhängigkeit hinzufügen:

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

Gradle-Benutzer können Ihrer build.gradle-Datei die folgende Abhängigkeit hinzufügen:

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

Fügen Sie nun die Protokolle wie hier gezeigt in die Rest Controller-Klassendatei Ihrer Spring Boot-Anwendung ein.

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

Fügen Sie nun den Anwendungsnamen wie gezeigt in die Datei application.properties ein -

spring.application.name = tracinglogs

Der vollständige Code für die Build-Konfigurationsdatei ist unten angegeben.

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

Sie können eine ausführbare JAR-Datei erstellen und die Spring Boot-Anwendung mit den folgenden Maven- oder Gradle-Befehlen ausführen.

Für Maven können Sie den folgenden Befehl verwenden:

mvn clean install

Nach "BUILD SUCCESS" finden Sie die JAR-Datei im Zielverzeichnis.

Für Gradle können Sie den folgenden Befehl verwenden:

gradle clean build

Nach "BUILD SUCCESSFUL" finden Sie die JAR-Datei im Verzeichnis build / libs.

Führen Sie nun die JAR-Datei mit dem hier gezeigten Befehl aus -

java –jar <JARFILE>

Jetzt wurde die Anwendung auf dem Tomcat-Port 8080 gestartet.

Klicken Sie nun in Ihrem Webbrowser auf die URL und sehen Sie die Ausgabe im Konsolenprotokoll.

http://localhost:8080/

Sie können die folgenden Protokolle im Konsolenfenster sehen. Beachten Sie, dass das Protokoll im folgenden Format gedruckt wird [Anwendungsname, Trace-ID, Spanid, Zipkin-Export]

Zipkin Server

Zipkin ist eine Anwendung, die die Spring Cloud Sleuth-Protokolle Ihrer Spring Boot-Anwendung überwacht und verwaltet. Um einen Zipkin-Server zu erstellen, müssen wir die Abhängigkeiten der Zipkin-Benutzeroberfläche und des Zipkin-Servers in unsere Build-Konfigurationsdatei aufnehmen.

Maven-Benutzer können der Datei pom.xml die folgende Abhängigkeit hinzufügen:

<dependency>
   <groupId>io.zipkin.java</groupId>
   <artifactId>zipkin-server</artifactId>
</dependency>
<dependency>
   <groupId>io.zipkin.java</groupId>
   <artifactId>zipkin-autoconfigure-ui</artifactId>
</dependency>

Gradle-Benutzer können die folgende Abhängigkeit in Ihre build.gradle-Datei einfügen -

compile('io.zipkin.java:zipkin-autoconfigure-ui')
compile('io.zipkin.java:zipkin-server')

Konfigurieren Sie nun server.port = 9411 in der Anwendungseigenschaftendatei.

Fügen Sie für Benutzer von Eigenschaftendateien die folgende Eigenschaft in die Datei application.properties ein.

server.port = 9411

Fügen Sie für YAML-Benutzer die folgende Eigenschaft in die Datei application.yml ein.

server:
   port: 9411

Fügen Sie die Annotation @EnableZipkinServer in Ihre Hauptanwendungsklasse für Spring Boot ein. Die Annotation @EnableZipkinServer wird verwendet, damit Ihre Anwendung als Zipkin-Server fungiert.

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

Der Code für die vollständige Build-Konfigurationsdatei ist unten angegeben.

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

Sie können eine ausführbare JAR-Datei erstellen und die Spring Boot-Anwendung mit den folgenden Maven- oder Gradle-Befehlen ausführen.

Verwenden Sie für Maven den folgenden Befehl:

mvn clean install

Nach "BUILD SUCCESS" finden Sie die JAR-Datei im Zielverzeichnis.

Verwenden Sie für Gradle den folgenden Befehl:

gradle clean build

Nach "BUILD SUCCESSFUL" finden Sie die JAR-Datei im Verzeichnis build / libs.

Führen Sie die JAR-Datei mit dem angezeigten Befehl aus -

java –jar <JARFILE>

Jetzt wurde die Anwendung auf dem Tomcat-Port 9411 wie unten gezeigt gestartet.

Klicken Sie nun auf die folgende URL und sehen Sie die Benutzeroberfläche des Zipkin-Servers.

http://localhost:9411/zipkin/

Fügen Sie dann die folgende Abhängigkeit in Ihre Client-Service-Anwendung ein und verweisen Sie auf die Zipkin-Server-URL, um die Microservice-Protokolle über die Zipkin-Benutzeroberfläche zu verfolgen.

Fügen Sie nun die Spring Cloud Starter Zipkin-Abhängigkeit wie gezeigt in Ihre Build-Konfigurationsdatei ein -

Maven-Benutzer können die folgende Abhängigkeit in die Datei pom.xml einfügen:

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

Gradle-Benutzer können die folgende Abhängigkeit in die Datei build.gradle einfügen -

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

Fügen Sie nun die hinzu Always Sampler Bean in Ihrer Spring Boot-Anwendung, um die Protokolle in den Zipkin-Server zu exportieren.

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

Wenn Sie die AlwaysSampler-Bean hinzufügen, ändert sich die Exportoption für Spring Sleuth Zipkin automatisch von false in true.

Konfigurieren Sie als Nächstes Ihre Zipkin Server-Basis-URL in der Datei client service application.properties.

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

Geben Sie dann die Ablaufverfolgungs-ID ein und suchen Sie die Ablaufverfolgungen in der Zipkin-Benutzeroberfläche.

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

ja/tutorial
es/tutorial
de/tutorial
fr/tutorial
th/tutorial
pt/tutorial
ru/tutorial
vi/tutorial
it/tutorial
ko/tutorial
tr/tutorial
id/tutorial
pl/tutorial
hi/tutorial
japost
espost
depost
frpost
thpost
ptpost
rupost
vipost
itpost
kopost
trpost
idpost
plpost
hipost

© Copyright 2021 - 2025 | All Rights Reserved