SpringBoot 效能監控

主要利用Prometheus + Grafana來展示基本的SpringBoot應用程式系統監控

前言

先前我對系統監控，停留在使用JMX加JConsole，JMX打幾個洞，可以更改log level，可以重新執行batch task，可以重連DB，其它的我就沒什麼要求了。Jconsole裡顯示什麼我就看什麼，不挑的。

再來商業層的部份，就在log中做展示，ELK之於我，已是不可或缺的系統基本元件。

不過最近受到了點啟發，發現系統監控的部份可以再更好一些，但不需要耗費太多人力，才有了這篇筆記。

SpringBoot

SpringBoot本來就有使用micrometer來記錄，所以提供做為Prometheus的資料來源其實很容易。

要注意的有下列幾項

Dependency

在pom.xml裡要加入actuator及micrometer相關的library。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
    <version>1.3.0</version>
</dependency>

Management

在application.yml中要加入management的相關設定

management:
  metrics:
    export:
      prometheus:
        enabled: true
  endpoints:
    web:
      exposure:
        include: "*"

開啟prometheus的export及actuator相關的webapi。

MeterRegistry

還要在SpringConfig裡多加一個Bean

@Bean
MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
    return registry -> registry.config().commonTags("application", "springapm");
}

這樣在Grafana裡才會出現可用的Application，否則只能自行手打instance。

測試

啟動Application後可以先打http://localhost:8080/actuator，應該可以看到類似下列的回應

{"_links":{
...
"health":{"href":"http://localhost:8080/actuator/health","templated":false},
...
"prometheus":{"href":"http://localhost:8080/actuator/prometheus","templated":false},
...
}}

再來可以依內容提供的url，再試試health及prometheus的回應

http://localhost:8080/actuator/health

{"status":"UP"}

http://localhost:8080/actuator/prometheus

# HELP process_start_time_seconds Start time of the process since unix epoch.
# TYPE process_start_time_seconds gauge
process_start_time_seconds{application="springapm",} 1.571121446021E9
# HELP jvm_gc_memory_promoted_bytes_total Count of positive increases in the size of the old generation memory pool before GC to after GC
# TYPE jvm_gc_memory_promoted_bytes_total counter
jvm_gc_memory_promoted_bytes_total{application="springapm",} 9744416.0
# HELP tomcat_sessions_active_max_sessions  
# TYPE tomcat_sessions_active_max_sessions gauge
tomcat_sessions_active_max_sessions{application="springapm",} 0.0

....

這部份就是做為prometheus顯示用

Docker Compose

為了方便測試，我將Springboot + Prometheus + Grafana包在同一個docker compose裡。
並且把prometheus跟grafana的設定都放在外部方便修改。

version: "3.3"

services:
  prometheus:
    image: prom/prometheus:latest
    ports:
      - '9090:9090'
    volumes:
      - ./config/prometheus.yml:/etc/prometheus/prometheus.yml
    depends_on:
      - app

  grafana:
    image: grafana/grafana:latest
    ports:
      - '3000:3000'
    volumes:
      - ./config/grafana.ini:/etc/grafana/grafana.ini
      - ./data/grafana/lib:/var/lib/grafana
      - ./data/grafana/log:/var/log/grafana
    depends_on:
      - prometheus

  app:
    image: elliot/21apm:1.0-SNAPSHOT
    ports:
      - '8080:8080'

Prometheus

重點要看一下prometheus.yml

# my global config
global:
  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
  # scrape_timeout is set to the global default (10s).

# Alertmanager configuration
alerting:
  alertmanagers:
  - static_configs:
    - targets:

# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
  # - "first_rules.yml"
  # - "second_rules.yml"

# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  - job_name: 'prometheus'
    static_configs:
    - targets: ['localhost:9090']
  - job_name: 'springboot_prometheus'
    scrape_interval: 5s
    metrics_path: '/actuator/prometheus'
    static_configs:
      - targets: ['app:8080']

其中有兩個job，springboot_prometheus就是用來擷取先前http://localhost:8080/actuator/prometheus的資料。用app做為host name原因是因為放在docker compose裡使用的名稱為app。

Grafana

這部份的設定都沒有特別需要修改的，Sample裡用的grafana.ini的內容都是註解掉的。要處理的都在畫面操作中。

整合

1. docker-compse up

第一步當然是啟動docker

2. Login to Grafana

登入url : http://localhost:3000/login

預設帳號 : admin

預設密碼 : admin

3. Add Data Source

按下Add data source

選擇Prometheus做為data source

在url填入http://prometheus:9090後按下Save & Test，host name會用prometheus也是為在docker compose裡設定的關係。

4. Add Dashboard

利用import的方式加入其他作者提供的dash board範本

在Dashboard裡填入範本id：10280

選擇Prometheus後按下Import

5. 完成

此時就有基本的畫面可用囉。

總結

不花什麼力氣就能有一個可展示的效能監控畫面，經過簡單的設定還可以針對各種情形發出告警，實在是…

相關原始檔可在github.com/ElliotChen裡找到。