Skip to content

Implement OpenTelemetry in Spring Boot 3 using the Micrometer #18460

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spring-boot-modules/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
<module>spring-boot-mvc-birt</module>
<module>spring-boot-mvc-jersey</module>
<module>spring-boot-nashorn</module>
<module>spring-boot-open-telemetry</module>
<module>spring-boot-parent</module>
<module>spring-boot-performance</module>
<module>spring-boot-pkl</module>
Expand Down
20 changes: 20 additions & 0 deletions spring-boot-modules/spring-boot-open-telemetry/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
services:
product-service:
build: spring-boot-open-telemetry1/
ports:
- "8080:8080"
depends_on:
- collector

price-service:
build: spring-boot-open-telemetry2/
ports:
- "8081"
depends_on:
- collector

collector:
image: jaegertracing/jaeger:2.5.0
ports:
- "16686:16686"
- "4318:4318"
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
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.baeldung.spring.cloud</groupId>
<artifactId>spring-cloud-open-telemetry</artifactId>
<groupId>com.baeldung.spring.boot</groupId>
<artifactId>spring-boot-open-telemetry</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<name>spring-cloud-open-telemetry</name>
<name>spring-boot-open-telemetry</name>

<parent>
<groupId>com.baeldung.spring.cloud</groupId>
<artifactId>spring-cloud-modules</artifactId>
<groupId>com.baeldung.spring-boot-modules</groupId>
<artifactId>spring-boot-modules</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>

<modules>
<module>spring-cloud-open-telemetry1</module>
<module>spring-cloud-open-telemetry2</module>
<module>spring-boot-open-telemetry1</module>
<module>spring-boot-open-telemetry2</module>
</modules>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM openjdk:17-alpine

COPY target/spring-boot-open-telemetry1-1.0.0-SNAPSHOT.jar spring-boot-open-telemetry.jar

EXPOSE 8080

ENTRYPOINT ["java","-jar","/spring-boot-open-telemetry.jar"]
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
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>
<artifactId>spring-cloud-open-telemetry1</artifactId>
<groupId>com.baeldung.spring.cloud</groupId>
<artifactId>spring-boot-open-telemetry1</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>spring-cloud-open-telemetry1</name>
<name>spring-boot-open-telemetry1</name>

<parent>
<groupId>com.baeldung.spring.cloud</groupId>
<artifactId>spring-cloud-open-telemetry</artifactId>
<groupId>com.baeldung.spring.boot</groupId>
<artifactId>spring-boot-open-telemetry</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>

Expand All @@ -24,20 +23,6 @@
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${release.train.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-otel-dependencies</artifactId>
<version>${spring-cloud-sleuth-otel.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>

Expand All @@ -46,31 +31,37 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-brave</artifactId>
</exclusion>
</exclusions>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing</artifactId>
<version>${micrometer-tracing-version}</version>
</dependency>

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-otel-autoconfigure</artifactId>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-bridge-otel</artifactId>
<version>${micrometer-tracing-version}</version>
</dependency>

<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-exporter-otlp</artifactId>
<version>${otel-exporter-otlp.version}</version>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>${junit-jupiter.version}</version>
<version>${junit-jupiter-engine.version}</version>
<scope>test</scope>
</dependency>

</dependencies>

<build>
Expand All @@ -90,10 +81,11 @@
</build>

<properties>
<spring-boot-dependencies.version>2.7.9</spring-boot-dependencies.version>
<release.train.version>2021.0.5</release.train.version>
<spring-cloud-sleuth-otel.version>1.1.2</spring-cloud-sleuth-otel.version>
<otel-exporter-otlp.version>1.23.1</otel-exporter-otlp.version>
<spring-boot-dependencies.version>3.4.4</spring-boot-dependencies.version>
<micrometer-tracing-version>1.4.4</micrometer-tracing-version>
<otel-exporter-otlp.version>1.39.0</otel-exporter-otlp.version>
<logback.version>1.5.16</logback.version>
<junit-jupiter-engine.version>5.4.2</junit-jupiter-engine.version>
</properties>

</project>
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
package com.baeldung.opentelemetry.configuration;

import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class RestConfiguration {
class RestTemplateConfig {

@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
RestTemplate restTemplate(RestTemplateBuilder builder) {
return builder.build();
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

import com.baeldung.opentelemetry.exception.ProductNotFoundException;
import com.baeldung.opentelemetry.model.Product;
import jakarta.annotation.PostConstruct;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
spring:
application:
name: product-service
server:
port: '8080'

priceClient:
baseUrl: http://price-service:8081

management:
tracing:
sampling:
probability: '1.0'
otlp:
tracing:
endpoint: http://collector:4318/v1/traces
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.web.client.RestTemplate;


@ExtendWith(SpringExtension.class)
@SpringBootTest(classes = ProductApplication.class)
class SpringContextTest {

@Test
void whenSpringContextIsBootstrapped_thenNoExceptions() {
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM openjdk:17-alpine

COPY target/spring-boot-open-telemetry2-1.0.0-SNAPSHOT.jar spring-boot-open-telemetry.jar

EXPOSE 8081

ENTRYPOINT ["java","-jar","/spring-boot-open-telemetry.jar"]
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
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>
<artifactId>spring-cloud-open-telemetry2</artifactId>
<groupId>com.baeldung.spring.cloud</groupId>
<artifactId>spring-boot-open-telemetry2</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>spring-cloud-open-telemetry2</name>
<name>spring-boot-open-telemetry2</name>

<parent>
<groupId>com.baeldung.spring.cloud</groupId>
<artifactId>spring-cloud-open-telemetry</artifactId>
<groupId>com.baeldung.spring.boot</groupId>
<artifactId>spring-boot-open-telemetry</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>

Expand All @@ -24,20 +23,6 @@
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${release.train.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-otel-dependencies</artifactId>
<version>${spring-cloud-sleuth-otel.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>

Expand All @@ -46,31 +31,37 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-brave</artifactId>
</exclusion>
</exclusions>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing</artifactId>
<version>${micrometer-tracing-version}</version>
</dependency>

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-otel-autoconfigure</artifactId>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-bridge-otel</artifactId>
<version>${micrometer-tracing-version}</version>
</dependency>

<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-exporter-otlp</artifactId>
<version>${otel-exporter-otlp.version}</version>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>${junit-jupiter.version}</version>
<version>${junit-jupiter-engine.version}</version>
<scope>test</scope>
</dependency>

</dependencies>

<build>
Expand All @@ -90,10 +81,11 @@
</build>

<properties>
<spring-boot-dependencies.version>2.7.9</spring-boot-dependencies.version>
<release.train.version>2021.0.5</release.train.version>
<spring-cloud-sleuth-otel.version>1.1.2</spring-cloud-sleuth-otel.version>
<otel-exporter-otlp.version>1.23.1</otel-exporter-otlp.version>
<spring-boot-dependencies.version>3.4.4</spring-boot-dependencies.version>
<micrometer-tracing-version>1.4.4</micrometer-tracing-version>
<otel-exporter-otlp.version>1.39.0</otel-exporter-otlp.version>
<logback.version>1.5.16</logback.version>
<junit-jupiter-engine.version>5.4.2</junit-jupiter-engine.version>
</properties>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

import com.baeldung.opentelemetry.model.Price;
import com.baeldung.opentelemetry.exception.PriceNotFoundException;
import jakarta.annotation.PostConstruct;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.util.HashMap;
import java.util.Map;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
spring:
application:
name: price-service

server:
port: '8081'

management:
tracing:
sampling:
probability: '1.0'
otlp:
tracing:
endpoint: http://collector:4318/v1/traces
Loading