Nob docs

Appearance

Prometheus向けにSpring Boot Actuatorを有効化する ​

Spring Boot Actuatorを有効化し、Prometheus向けにメトリクスを作成します。

手順 ​

依存関係の追加 ​

cf.

Spring Bootアプリに依存関係を追加します:

xml
		<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-actuator -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
			<version>3.5.6</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/io.micrometer/micrometer-registry-prometheus -->
		<dependency>
			<groupId>io.micrometer</groupId>
			<artifactId>micrometer-registry-prometheus</artifactId>
			<version>1.15.4</version>
		</dependency>

エンドポイントの付与 ​

cf.

src/main/resources配下に、下記内容でapplication.ymlを作成します:

yaml
spring:
  application:
    name: easyapp

management:
  endpoints:
    web:
      exposure:
        include:
          - metrics
          - prometheus
  metrics:
    enable:
      "[http.server.requests]": true

Prometheusからの監視 ​

cf.

下記内容でprometheusの監視設定を定義します:

yaml
scrape_configs:
  - job_name: "easyapp"
    metrics_path: "/actuator/prometheus"
    static_configs:
      - targets: ["easyapp:8080"] # {java app IP}:{port}

例として、下記docker-composeによってアプリを動かし、メトリクスをPrometheus上で確認することができます:

yaml
services:
  java:
    container_name: easyapp
    image: eclipse-temurin:25
    ports:
      - 8080:8080
    volumes:
      - ./volumes/easyapp/easyapp-0.0.1-SNAPSHOT.jar:/easyapp-0.0.1-SNAPSHOT.jar
    entrypoint: ["java", "-jar", "/easyapp-0.0.1-SNAPSHOT.jar"]
  prometheus:
    image: prom/prometheus:latest
    container_name: prometheus
    ports:
      - 9090:9090
    volumes:
      - ./volumes/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml