Spring Boot 4のOpenTelemetry対応のやつ

Author: backpaper0

observability-example/compose.yaml

@@ -1,18 +1,4 @@
 services:
-  zipkin:
-    image: openzipkin/zipkin
-    ports:
-      - "9411:9411"
-
-  prometheus:
-    image: prom/prometheus
-    ports:
-      - "9090:9090"
-    volumes:
-      - ./docker/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
-
-  grafana:
-    image: grafana/grafana-oss
-    ports:
-      - "3000:3000"
-
+  grafana-lgtm:
+    image: grafana/otel-lgtm
+    ports: ["3000:3000", "4317:4317", "4318:4318"]

observability-example/observability-example-web/pom.xml

@@ -1,20 +1,25 @@
 <?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"
+<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">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>com.example</groupId>
         <artifactId>spring-boot-sandbox-parent</artifactId>
         <version>0.0.1-SNAPSHOT</version>
-		<relativePath>../../</relativePath>
+        <relativePath>../../</relativePath>
     </parent>
     <artifactId>observability-example-web</artifactId>
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
-<dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-aspectj</artifactId>
+        </dependency>
+        <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-security</artifactId>
         </dependency>
@@ -23,12 +28,17 @@
             <artifactId>spring-boot-starter-webmvc</artifactId>
         </dependency>
         <dependency>
-            <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-tracing-bridge-brave</artifactId>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-opentelemetry</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-micrometer-metrics</artifactId>
         </dependency>
         <dependency>
-            <groupId>io.zipkin.reporter2</groupId>
-            <artifactId>zipkin-reporter-brave</artifactId>
+            <groupId>io.opentelemetry.instrumentation</groupId>
+            <artifactId>opentelemetry-logback-appender-1.0</artifactId>
+            <version>2.21.0-alpha</version>
         </dependency>
 
         <dependency>
@@ -63,4 +73,4 @@
         </plugins>
     </build>
 
-</project>
+</project>

observability-example/observability-example-web/src/main/java/com/example/App.java

@@ -8,7 +8,6 @@
 @EnableScheduling
 public class App {
 
-    @SuppressWarnings("resource")
     public static void main(String[] args) {
         SpringApplication.run(App.class, args);
     }

observability-example/observability-example-web/src/main/java/com/example/Example.java

@@ -1,47 +1,21 @@
 package com.example;
 
-import io.micrometer.observation.Observation;
-import io.micrometer.observation.ObservationRegistry;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Component;
 
 @Component
 public class Example {
 
-    private final ObservationRegistry registry;
+    private final Logger logger = LoggerFactory.getLogger(Example.class);
 
-    public Example(ObservationRegistry registry) {
-        this.registry = registry;
-    }
+    @Autowired
+    private ExampleService service;
 
     @Scheduled(cron = "*/10 * * * * *")
     public void run() {
-        Observation.createNotStarted("foo", registry)
-                .lowCardinalityKeyValue("lowTag", "lowTagValue")
-                .highCardinalityKeyValue("highTag", "highTagValue")
-                .observe(() -> {
-                    sleep(100);
-                    runInternal();
-                    sleep(100);
-                });
-    }
-
-    private void runInternal() {
-        Observation.createNotStarted("bar", registry)
-                .lowCardinalityKeyValue("lowTag", "lowTagValue")
-                .highCardinalityKeyValue("highTag", "highTagValue")
-                .observe(() -> {
-                    sleep(100);
-                    System.out.println("Hello");
-                    sleep(100);
-                });
-    }
-
-    static void sleep(long millis) {
-        try {
-            Thread.sleep(millis);
-        } catch (InterruptedException e) {
-            e.printStackTrace();
-        }
+        logger.info(service.sayHello("world"));
     }
 }

observability-example/observability-example-web/src/main/java/com/example/InstallOpenTelemetryAppender.java

@@ -0,0 +1,21 @@
+package com.example;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.stereotype.Component;
+
+@Component
+class InstallOpenTelemetryAppender implements InitializingBean {
+
+    private final OpenTelemetry openTelemetry;
+
+    InstallOpenTelemetryAppender(OpenTelemetry openTelemetry) {
+        this.openTelemetry = openTelemetry;
+    }
+
+    @Override
+    public void afterPropertiesSet() {
+        OpenTelemetryAppender.install(this.openTelemetry);
+    }
+}

observability-example/observability-example-web/src/main/java/com/example/ObservedConfig.java

@@ -9,7 +9,7 @@
 public class WebSecurityConfig {
 
     @Bean
-    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
+    SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
         return http.authorizeHttpRequests(c -> c.anyRequest().permitAll()).build();
     }
 }

observability-example/observability-example-web/src/main/java/com/example/WebSecurityConfig.java

@@ -1,7 +1,14 @@
+spring.application.name=observability-example-web
 spring.security.user.password=pass
 
-management.endpoints.web.exposure.include=health, metrics, prometheus
+# management.endpoints.web.exposure.include=health, metrics, prometheus
 
-# すべてのリクエストがバックエンド(ここではZipkin)へ送信されるようにする
+# すべてのリクエストのトレースが送信されるようにする
 # (デフォルトでは過負荷を避けるためリクエストの10%だけを送信するようになっている)
 management.tracing.sampling.probability=1.0
+
+management.observations.annotations.enabled=true
+
+management.opentelemetry.tracing.export.otlp.endpoint=http://localhost:4318/v1/traces
+management.opentelemetry.logging.export.otlp.endpoint=http://localhost:4318/v1/logs
+management.otlp.metrics.export.url=http://localhost:4318/v1/metrics

observability-example/observability-example-web/src/main/resources/application.properties

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <include resource="org/springframework/boot/logging/logback/base.xml"/>
+
+    <appender name="OTEL" class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender">
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="CONSOLE"/>
+        <appender-ref ref="OTEL"/>
+    </root>
+</configuration>