Spring-boot-tracing-micro-service-logs
Spring Boot-マイクロサービスログのトレース
ほとんどの開発者は、問題が発生した場合、ログのトレースが困難になります。 これは、Spring Bootアプリケーション用のSpring Cloud SleuthとZipKinサーバーによって解決できます。
春のクラウドスルース
春のクラウドスルースログは、次の形式で印刷されます-
[application-name,traceid,spanid,zipkin-export]
どこで、
- アプリケーション名=アプリケーションの名前
- Traceid =同じサービスまたは1つのサービスを別のサービスに呼び出す場合、各要求と応答のtraceidは同じです。
- Spanid = Span IdはTrace Idと一緒に印刷されます。 スパンIDは、1つのサービスを別のサービスに呼び出す要求と応答ごとに異なります。
- Zipkin-export =デフォルトではfalseです。 trueの場合、ログはZipkinサーバーにエクスポートされます。
さて、次のようにビルド構成ファイルにSpring Cloud Starter Sleuth依存関係を追加します-
Mavenユーザーは、pom.xmlファイルに次の依存関係を追加できます-
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
Gradleユーザーは、build.gradleファイルに次の依存関係を追加できます-
compile('org.springframework.cloud:spring-cloud-starter-sleuth')
ここで、ここに示すように、ログをSpring BootアプリケーションRest Controllerクラスファイルに追加します-
package com.finddevguides.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!";
}
}
次に、示されているようにapplication.propertiesファイルにアプリケーション名を追加します-
spring.application.name = tracinglogs
ビルド構成ファイルの完全なコードは以下のとおりです-
*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.finddevguides</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.finddevguides'
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}"
}
}
次のMavenまたはGradleコマンドを使用して、実行可能JARファイルを作成し、Spring Bootアプリケーションを実行できます。
Mavenの場合、次のコマンドを使用できます-
mvn clean install
「BUILD SUCCESS」の後、ターゲットディレクトリの下にJARファイルがあります。
Gradleの場合、次のコマンドを使用できます-
gradle clean build
「BUILD SUCCESSFUL」の後、build/libsディレクトリの下にJARファイルがあります。
さて、ここに示すコマンドを使用してJARファイルを実行します-
java –jar <JARFILE>
これで、アプリケーションはTomcatポート8080で開始されました。
次に、WebブラウザーでURLにアクセスし、コンソールログで出力を確認します。
*http://localhost:8080/*
コンソールウィンドウで次のログを確認できます。 ログが次の形式で出力されることを確認します[アプリケーション名、traceid、spanid、zipkin-export]
Zipkinサーバー
Zipkinは、Spring BootアプリケーションのSpring Cloud Sleuthログを監視および管理するアプリケーションです。 Zipkinサーバーを構築するには、ビルド構成ファイルにZipkin UIおよびZipkinサーバーの依存関係を追加する必要があります。
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>
Gradleユーザーは、build.gradleファイルに以下の依存関係を追加できます-
compile('io.zipkin.java:zipkin-autoconfigure-ui')
compile('io.zipkin.java:zipkin-server')
次に、アプリケーションプロパティファイルでserver.port = 9411を構成します。
プロパティファイルユーザーの場合、application.propertiesファイルに以下のプロパティを追加します。
server.port = 9411
YAMLユーザーの場合、application.ymlファイルに以下のプロパティを追加します。
server:
port: 9411
メインのSpring Bootアプリケーションクラスファイルに@EnableZipkinServerアノテーションを追加します。 @EnableZipkinServerアノテーションは、アプリケーションがZipkinサーバーとして機能できるようにするために使用されます。
package com.finddevguides.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);
}
}
完全なビルド構成ファイルのコードを以下に示します。
*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.finddevguides</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.finddevguides'
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
「BUILD SUCCESS」の後、ターゲットディレクトリの下にJARファイルがあります。
Gradleの場合、以下に示すコマンドを使用します-
gradle clean build
「BUILD SUCCESSFUL」の後、build/libsディレクトリの下にJARファイルがあります。
示されているコマンドを使用してJARファイルを実行します-
java –jar <JARFILE>
これで、以下に示すように、アプリケーションはTomcatポート9411で開始されました-
次に、以下のURLにアクセスして、ZipkinサーバーUIを確認します。
*http://localhost:9411/zipkin/*
次に、クライアントサービスアプリケーションに次の依存関係を追加し、ZipkinサーバーURLを指定して、Zipkin UIを介してマイクロサービスログをトレースします。
次に、次のように、ビルド構成ファイルにSpring Cloud Starter Zipkin依存関係を追加します-
Mavenユーザーはpom.xmlファイルに次の依存関係を追加できます-
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-zipkin</artifactId>
</dependency>
Gradleユーザーは、build.gradleファイルに以下の依存関係を追加できます-
compile('org.springframework.cloud:spring-cloud-sleuth-zipkin')
次に、Spring Bootアプリケーションに Always Sampler Bean を追加して、ログをZipkinサーバーにエクスポートします。
@Bean
public AlwaysSampler defaultSampler() {
return new AlwaysSampler();
}
AlwaysSampler Beanを追加すると、自動的にSpring Sleuth Zipkin Exportオプションがfalseからtrueに変更されます。
次に、クライアントサービスのapplication.propertiesファイルでZipkinサーバーのベースURLを構成します。
spring.zipkin.baseUrl = http://localhost:9411/zipkin/
次に、トレースIDを指定して、Zipkin UIでトレースを見つけます。
*http://localhost:9411/zipkin/traces/\ {traceid}/*