Prometheus と Grafana を使用して Spring Boot アプリケーションを監視する

プロジェクトは GitHub にホストされています：y0ngb1n/spring-boot-samples、Star や Fork を歓迎します 😘

準備作業#

Prometheus v2.14.0
Grafana v6.5.0

Docker を使用して上記の基本環境をデプロイします。設定ファイルはdocker-compose.ymlで確認できます。以下のコマンドを入力してワンクリックデプロイを行います：

# 設定を確認
docker-compose config
# サービスを起動（-dはバックグラウンドで起動）
docker-compose up -d
# サービスを停止してクリーンアップ
docker-compose down

依存関係の追加#

pom.xml

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>

  <!-- Micrometerを使用してPrometheus監視システムに接続 -->
  <dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
  </dependency>
</dependencies>

application.yml

spring:
  application:
    name: monitoring-prometheus-grafana

management:
  endpoints:
    web:
      exposure:
        # Actuatorの/actuator/prometheusエンドポイントを公開
        include: 'prometheus'
  metrics:
    tags: 
      application: ${spring.application.name}

logging:
  level:
    io.github.y0ngb1n.*: debug

使用方法#

ステップ 1: サービスを起動

$ mvn spring-boot:run
...
2019-12-08 22:28:11.916  INFO 36157 --- [           main] o.s.b.a.e.web.EndpointLinksResolver      : Exposing 1 endpoint(s) beneath base path '/actuator'
2019-12-08 22:28:12.045  INFO 36157 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2019-12-08 22:28:12.050  INFO 36157 --- [           main] i.g.y.m.p.PrometheusGrafanaApplication   : Started PrometheusGrafanaApplication in 20.638 seconds (JVM running for 27.154)

ステップ 2: /actuator/prometheusポートにアクセス

$ curl -sS http://127.0.0.1:8080/actuator/prometheus
# HELP jvm_gc_memory_promoted_bytes_total GC前後の古い世代メモリプールのサイズの正の増加のカウント
# TYPE jvm_gc_memory_promoted_bytes_total counter
jvm_gc_memory_promoted_bytes_total{application="monitoring-prometheus-grafana",} 9986992.0
# HELP jvm_threads_daemon_threads 現在の生存しているデーモンスレッドの数
# TYPE jvm_threads_daemon_threads gauge
jvm_threads_daemon_threads{application="monitoring-prometheus-grafana",} 30.0
# HELP process_uptime_seconds Java仮想マシンの稼働時間
# TYPE process_uptime_seconds gauge
process_uptime_seconds{application="monitoring-prometheus-grafana",} 75.133
...

アプリを Prometheus に接続#

Prometheus の設定ファイルを追加します：prometheus.yml

scrape_configs:
  # 任意の名前を付けてください。英語を推奨し、特殊文字は含めないでください
  - job_name: 'spring-boot-app'
    # データをどのくらいの頻度で収集するか
    scrape_interval: 15s
    # 収集時のタイムアウト
    scrape_timeout: 10s
    # 収集するパス
    metrics_path: '/actuator/prometheus'
    # 収集するサービスのアドレス。Spring Bootアプリが存在するサーバーの具体的なアドレスを設定
    static_configs:
      - targets: ['192.168.31.44:8080']