Spring Boot: traccia dei registri dei micro servizi

La maggior parte degli sviluppatori incontra difficoltà nel rintracciare i log in caso di problemi. Questo può essere risolto da Spring Cloud Sleuth e dal server ZipKin per l'applicazione Spring Boot.

Spring Cloud Sleuth

I registri Spring cloud Sleuth vengono stampati nel seguente formato:

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

Dove,

  • Nome-applicazione = nome dell'applicazione

  • Traceid = ogni richiesta e risposta traceid è la stessa quando si chiama lo stesso servizio o un servizio a un altro servizio.

  • Spanid = Span Id viene stampato insieme all'ID traccia. Span Id è diverso da ogni richiesta e risposta che chiama un servizio a un altro servizio.

  • Zipkin-export = Per impostazione predefinita è falso. Se è vero, i registri verranno esportati sul server Zipkin.

Ora aggiungi la dipendenza Spring Cloud Starter Sleuth nel file di configurazione della build come segue:

Gli utenti Maven possono aggiungere la seguente dipendenza nel file pom.xml:

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

Gli utenti Gradle possono aggiungere la seguente dipendenza nel file build.gradle:

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

Ora aggiungi i log nel file di classe Rest Controller dell'applicazione Spring Boot come mostrato qui -

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

Ora aggiungi il nome dell'applicazione nel file application.properties come mostrato -

spring.application.name = tracinglogs

Di seguito viene fornito il codice completo per il file di configurazione della build:

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

È possibile creare un file JAR eseguibile ed eseguire l'applicazione Spring Boot utilizzando i seguenti comandi Maven o Gradle.

Per Maven, puoi usare il seguente comando:

mvn clean install

Dopo "BUILD SUCCESS", è possibile trovare il file JAR nella directory di destinazione.

Per Gradle, puoi utilizzare il seguente comando:

gradle clean build

Dopo "BUILD SUCCESSFUL", è possibile trovare il file JAR nella directory build / libs.

Ora, esegui il file JAR usando il comando mostrato qui -

java –jar <JARFILE>

Ora l'applicazione è stata avviata sulla porta Tomcat 8080.

Ora, premi l'URL nel tuo browser web e guarda l'output nel log della console.

http://localhost:8080/

È possibile visualizzare i seguenti registri nella finestra della console. Osserva che il registro viene stampato nel seguente formato [nome-applicazione, traceid, spanid, zipkin-export]

Zipkin Server

Zipkin è un'applicazione che monitora e gestisce i log Spring Cloud Sleuth della tua applicazione Spring Boot. Per creare un server Zipkin, dobbiamo aggiungere l'interfaccia utente Zipkin e le dipendenze del server Zipkin nel nostro file di configurazione della build.

Gli utenti Maven possono aggiungere la seguente dipendenza nel file 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>

Gli utenti Gradle possono aggiungere la seguente dipendenza nel file build.gradle -

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

Ora, configura server.port = 9411 nel file delle proprietà dell'applicazione.

Per gli utenti del file delle proprietà, aggiungere la proprietà seguente nel file application.properties.

server.port = 9411

Per gli utenti YAML, aggiungi la seguente proprietà nel file application.yml.

server:
   port: 9411

Aggiungi l'annotazione @EnableZipkinServer nel file della classe dell'applicazione Spring Boot principale. L'annotazione @EnableZipkinServer viene utilizzata per abilitare la tua applicazione a fungere da server 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);
   }
}

Di seguito viene fornito il codice per il file di configurazione della build completo.

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

Puoi creare un file JAR eseguibile ed eseguire l'applicazione Spring Boot utilizzando i seguenti comandi Maven o Gradle:

Per Maven, utilizzare il comando fornito di seguito:

mvn clean install

Dopo "BUILD SUCCESS", è possibile trovare il file JAR nella directory di destinazione.

Per Gradle, utilizzare il comando fornito di seguito:

gradle clean build

Dopo "BUILD SUCCESSFUL", è possibile trovare il file JAR nella directory build / libs.

Esegui il file JAR utilizzando il comando mostrato -

java –jar <JARFILE>

Ora l'applicazione è stata avviata sulla porta Tomcat 9411 come mostrato di seguito:

Ora, premi l'URL sottostante e vedi l'interfaccia utente del server Zipkin.

http://localhost:9411/zipkin/

Quindi, aggiungi la seguente dipendenza nell'applicazione del servizio client e indica l'URL del server Zipkin per tracciare i log del microservizio tramite l'interfaccia utente di Zipkin.

Ora aggiungi la dipendenza Spring Cloud Starter Zipkin nel file di configurazione della build come mostrato -

Gli utenti Maven possono aggiungere la seguente dipendenza nel file pom.xml:

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

Gli utenti Gradle possono aggiungere la seguente dipendenza nel file build.gradle -

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

Ora aggiungi il file Always Sampler Bean nell'applicazione Spring Boot per esportare i log nel server Zipkin.

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

Se aggiungi AlwaysSampler Bean, automaticamente l'opzione Spring Sleuth Zipkin Export cambierà da falso a vero.

Quindi, configurare l'URL di base del server Zipkin nel file application.properties del servizio client.

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

Quindi, fornire l'ID traccia e trovare le tracce nell'interfaccia utente di Zipkin.

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