Spring Boot - Rastreando registros de microsserviço

A maioria dos desenvolvedores enfrenta dificuldade para rastrear logs se ocorrer algum problema. Isso pode ser resolvido pelo servidor Spring Cloud Sleuth e ZipKin para o aplicativo Spring Boot.

Spring Cloud Sleuth

Os registros do Spring cloud Sleuth são impressos no seguinte formato -

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

Onde,

Application-name = Nome do aplicativo
Traceid = cada traceid de solicitação e resposta é o mesmo ao chamar o mesmo serviço ou um serviço para outro serviço.
Spanid = Span Id é impresso junto com o Trace Id. O Span Id é diferente a cada solicitação e resposta que chama um serviço para outro serviço.
Zipkin-export = Por padrão, é falso. Se for verdade, os logs serão exportados para o servidor Zipkin.

Agora, adicione a dependência Spring Cloud Starter Sleuth em seu arquivo de configuração de compilação da seguinte maneira -

Os usuários Maven podem adicionar a seguinte dependência em seu arquivo pom.xml -

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

Os usuários do Gradle podem adicionar a seguinte dependência em seu arquivo build.gradle -

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

Agora, adicione os Logs em seu arquivo de classe Rest Controller do aplicativo Spring Boot, conforme mostrado aqui -

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

Agora, adicione o nome do aplicativo no arquivo application.properties conforme mostrado -

spring.application.name = tracinglogs

O código completo para o arquivo de configuração do build é fornecido abaixo -

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

Você pode criar um arquivo JAR executável e executar o aplicativo Spring Boot usando os seguintes comandos Maven ou Gradle.

Para Maven, você pode usar o seguinte comando -

mvn clean install

Após “BUILD SUCCESS”, você pode encontrar o arquivo JAR no diretório de destino.

Para Gradle, você pode usar o seguinte comando -

gradle clean build

Depois de “BUILD SUCCESSFUL”, você pode encontrar o arquivo JAR no diretório build / libs.

Agora, execute o arquivo JAR usando o comando mostrado aqui -

java –jar <JARFILE>

Agora, o aplicativo foi iniciado na porta 8080 do Tomcat.

Agora, acesse a URL em seu navegador da web e veja a saída no log do console.

http://localhost:8080/

Você pode ver os seguintes logs na janela do console. Observe que o log é impresso no seguinte formato [application-name, traceid, spanid, zipkin-export]

Servidor Zipkin

Zipkin é um aplicativo que monitora e gerencia os logs do Spring Cloud Sleuth do seu aplicativo Spring Boot. Para construir um servidor Zipkin, precisamos adicionar as dependências da IU do Zipkin e do servidor Zipkin em nosso arquivo de configuração de construção.

Os usuários Maven podem adicionar a seguinte dependência em seu arquivo 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>

Os usuários do Gradle podem adicionar a dependência abaixo em seu arquivo build.gradle -

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

Agora, configure server.port = 9411 no arquivo de propriedades do aplicativo.

Para usuários do arquivo de propriedades, inclua a propriedade abaixo no arquivo application.properties.

server.port = 9411

Para usuários YAML, adicione a propriedade abaixo no arquivo application.yml.

server:
   port: 9411

Adicione a anotação @EnableZipkinServer em seu arquivo de classe de aplicativo Spring Boot principal. A anotação @EnableZipkinServer é usada para permitir que seu aplicativo atue como um servidor 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);
   }
}

O código para o arquivo de configuração de compilação completo é fornecido abaixo.

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

Você pode criar um arquivo JAR executável e executar o aplicativo Spring Boot usando os comandos Maven ou Gradle abaixo -

Para Maven, use o comando fornecido abaixo -

mvn clean install

Após “BUILD SUCCESS”, você pode encontrar o arquivo JAR no diretório de destino.

Para Gradle, use o comando fornecido abaixo -

gradle clean build

Depois de “BUILD SUCCESSFUL”, você pode encontrar o arquivo JAR no diretório build / libs.

Execute o arquivo JAR usando o comando mostrado -

java –jar <JARFILE>

Agora, o aplicativo foi iniciado na porta Tomcat 9411 conforme mostrado abaixo -

Agora, acesse o URL abaixo e veja a IU do servidor Zipkin.

http://localhost:9411/zipkin/

Em seguida, adicione a seguinte dependência em seu aplicativo de serviço ao cliente e aponte o URL do servidor Zipkin para rastrear os registros de microsserviço por meio da IU do Zipkin.

Agora, adicione a dependência Spring Cloud Starter Zipkin em seu arquivo de configuração de compilação, conforme mostrado -

Os usuários Maven podem adicionar a seguinte dependência no arquivo pom.xml -

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

Os usuários do Gradle podem adicionar a dependência abaixo no arquivo build.gradle -

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

Agora, adicione o Always Sampler Bean em seu aplicativo Spring Boot para exportar os logs para o servidor Zipkin.

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

Se você adicionar o Feijão AlwaysSampler, a opção Exportar Spring Sleuth Zipkin automaticamente mudará de falso para verdadeiro.

Em seguida, configure o URL base do Zipkin Server no arquivo application.properties de serviço do cliente.

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

Em seguida, forneça o id de rastreamento e encontre os rastreamentos na IU do Zipkin.

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

↰ Previous page Next page ↱