Spring Boot - śledzenie dzienników Micro Service

Większość programistów napotyka trudności w śledzeniu dzienników, jeśli wystąpi jakikolwiek problem. Można to rozwiązać za pomocą Spring Cloud Sleuth i serwera ZipKin dla aplikacji Spring Boot.

Wiosenny tropiciel chmur

Dzienniki Spring Cloud Sleuth są drukowane w następującym formacie -

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

Gdzie,

  • Application-name = nazwa aplikacji

  • Traceid = każde żądanie i identyfikator traceid są takie same podczas wywoływania tej samej usługi lub jednej usługi do innej usługi.

  • Spanid = Span Id jest drukowany wraz z identyfikatorem śledzenia. Identyfikator zakresu jest inny dla każdego żądania i odpowiedzi wzywającej jedną usługę do innej usługi.

  • Zipkin-export = Domyślnie jest to fałsz. Jeśli to prawda, dzienniki zostaną wyeksportowane na serwer Zipkin.

Teraz dodaj zależność Spring Cloud Starter Sleuth do pliku konfiguracji kompilacji w następujący sposób -

Użytkownicy Maven mogą dodać następującą zależność w pliku pom.xml -

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

Użytkownicy Gradle mogą dodać następującą zależność w pliku build.gradle -

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

Teraz dodaj dzienniki do pliku klasy Rest Controller aplikacji Spring Boot, jak pokazano tutaj -

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

Teraz dodaj nazwę aplikacji w pliku application.properties, jak pokazano -

spring.application.name = tracinglogs

Pełny kod pliku konfiguracyjnego kompilacji znajduje się poniżej -

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

Możesz utworzyć wykonywalny plik JAR i uruchomić aplikację Spring Boot za pomocą następujących poleceń Maven lub Gradle.

W przypadku Mavena możesz użyć następującego polecenia -

mvn clean install

Po „BUILD SUCCESS” można znaleźć plik JAR w katalogu docelowym.

W przypadku Gradle możesz użyć następującego polecenia -

gradle clean build

Po komunikacie „BUILD SUCCESSFUL” można znaleźć plik JAR w katalogu build / libs.

Teraz uruchom plik JAR za pomocą polecenia pokazanego tutaj -

java –jar <JARFILE>

Teraz aplikacja została uruchomiona na porcie Tomcat 8080.

Teraz naciśnij adres URL w przeglądarce internetowej i zobacz dane wyjściowe w dzienniku konsoli.

http://localhost:8080/

W oknie konsoli możesz zobaczyć następujące dzienniki. Zwróć uwagę, że dziennik jest drukowany w następującym formacie [nazwa aplikacji, identyfikator śledzenia, spanid, eksport zipkin]

Serwer Zipkin

Zipkin to aplikacja, która monitoruje i zarządza dziennikami Spring Cloud Sleuth Twojej aplikacji Spring Boot. Aby zbudować serwer Zipkin, musimy dodać Zipkin UI i Zipkin Server zależności w naszym pliku konfiguracji kompilacji.

Użytkownicy Maven mogą dodać następującą zależność w pliku 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>

Użytkownicy Gradle mogą dodać poniższą zależność w pliku build.gradle -

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

Teraz skonfiguruj server.port = 9411 w pliku właściwości aplikacji.

W przypadku użytkowników plików właściwości dodaj poniższą właściwość w pliku application.properties.

server.port = 9411

Dla użytkowników YAML dodaj poniższą właściwość w pliku application.yml.

server:
   port: 9411

Dodaj adnotację @EnableZipkinServer w swojej głównej klasie aplikacji Spring Boot, fie. Adnotacja @EnableZipkinServer służy do umożliwienia aplikacji działania jako serwera 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);
   }
}

Kod pełnego pliku konfiguracyjnego kompilacji znajduje się poniżej.

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

Możesz utworzyć wykonywalny plik JAR i uruchomić aplikację Spring Boot za pomocą poniższych poleceń Maven lub Gradle -

W przypadku Mavena użyj polecenia podanego poniżej -

mvn clean install

Po „BUILD SUCCESS” można znaleźć plik JAR w katalogu docelowym.

W przypadku Gradle użyj polecenia podanego poniżej -

gradle clean build

Po komunikacie „BUILD SUCCESSFUL” można znaleźć plik JAR w katalogu build / libs.

Uruchom plik JAR za pomocą pokazanego polecenia -

java –jar <JARFILE>

Teraz aplikacja została uruchomiona na porcie Tomcat 9411, jak pokazano poniżej -

Teraz kliknij poniższy adres URL i zobacz interfejs użytkownika serwera Zipkin.

http://localhost:9411/zipkin/

Następnie dodaj następującą zależność w aplikacji usługi klienckiej i wskaż adres URL serwera Zipkin, aby śledzić dzienniki mikrousług za pośrednictwem interfejsu użytkownika Zipkin.

Teraz dodaj zależność Spring Cloud Starter Zipkin do pliku konfiguracji kompilacji, jak pokazano -

Użytkownicy Maven mogą dodać następującą zależność w pliku pom.xml -

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

Użytkownicy Gradle mogą dodać poniższą zależność w pliku build.gradle -

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

Teraz dodaj Always Sampler Bean w aplikacji Spring Boot, aby wyeksportować dzienniki do serwera Zipkin.

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

Jeśli dodasz fasolkę AlwaysSampler, automatycznie opcja Spring Sleuth Zipkin Export zmieni się z false na true.

Następnie skonfiguruj podstawowy adres URL serwera Zipkin w pliku application.properties usługi klienta.

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

Następnie podaj identyfikator śledzenia i znajdź ślady w interfejsie użytkownika Zipkin.

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 - 2024 | All Rights Reserved