使用Prometheus和Grafana監控Spring Boot應用

作者：學研妹 2023-12-27 18:05:13

本文介紹兩個開源工具：Grafana和Prometheus。Prometheus以時間序列格式收集和存儲指標數據，而Grafana使用Prometheus作為數據源，在儀表板上可視化這些數據。

1 簡介

每個部署到生產環境的應用程序都需要監控方式來評估其性能情況，這可以幫助開發人員判斷應用程序是否按預期運行，是否需要采取措施以達到期望的性能水平。這些數據被稱為應用程序性能指標（APM），現在有許多商業工具如Newrelic、Datadog APM等提供這些功能的SAAS服務。

本文介紹兩個開源工具：Grafana和Prometheus。Prometheus以時間序列格式收集和存儲指標數據，而Grafana使用Prometheus作為數據源，在儀表板上可視化這些數據。

我們從創建一個應用程序并使用Grafana進行監控開始。

2 創建Spring Boot應用程序

訪問https://start.spring.io，創建一個帶有以下依賴項的簡單應用程序。

Spring Boot Actuator（運維）
Prometheus（可觀測性）
Spring Web（可選：僅用于創建一個簡單的REST控制器。）

接下來，需要通過一個管理端點暴露出來，Prometheus將使用該端點以Prometheus可理解的格式收集指標數據。為此，添加以下屬性。

management:
  endpoints:
    web:
      exposure:
        include:
        - prometheus

然后，添加一個簡單的控制器，用于生成一些警告日志。將使用它來監控收到的警告數量。

@RestController
@SpringBootApplication
public class PrometheusIntegrationApplication {

    final static Logger logger = LoggerFactory.getLogger(PrometheusIntegrationApplication.class);

    public static void main(String[] args) {
        SpringApplication.run(PrometheusIntegrationApplication.class, args);
    }

    @GetMapping("/something")
    public ResponseEntity<String> createLogs() {
        logger.warn("Just checking");
        return ResponseEntity.ok().body("All Ok");
    }

有了這些，來啟動應用程序并打開以下URL。

http://localhost:8080/actuator/prometheus

3 理解指標數據

在打開上述端點后，會發現以下格式的一些指標數據：

jvm_memory_used_bytes{area="heap",id="G1 Survivor Space",} 1005592.0

第一部分jvm_memory_used_bytes被稱為標簽（label），而花括號內的字段被稱為屬性（attribute）。每個標簽代表一個特定的指標，屬性提供了一種查詢方式，以獲取值。

接下來，配置Prometheus來讀取這些數據。

4 配置Prometheus

為了啟動Prometheus，使用一個Prometheus Docker鏡像，并提供一些配置來從應用程序中收集指標數據。它通過創建作業來從端點抓取數據。因此，在prometheus.yaml配置文件中定義作業，如下所示。

scrape_configs:
  - job_name: 'Spring Boot Application input'
    metrics_path: '/actuator/prometheus'
    scrape_interval: 2s
    static_configs:
      - targets: ['localhost:8000']
        labels:
          application: "My Spring Boot Application"

在這里，定義了一個作業，每2秒調用應用程序上的管理端點以獲取指標數據。

接下來，創建一個docker-compose文件，用于啟動和運行Prometheus Docker鏡像。

services:
  prometheus:
      image: prom/prometheus:v2.35.0
      network_mode: host
      container_name: prometheus
      restart: unless-stopped
      volumes:
        - ./data/prometheus/config:/etc/prometheus/
      command:
        - "--config.file=/etc/prometheus/prometheus.yaml"

在這里，將配置文件掛載到/etc/prometheus位置，并將配置文件的位置作為命令的參數。為了簡單起見，使用了主機網絡模式，這樣Prometheus可以直接訪問應用程序端點。

有了這些，使用docker compose up啟動docker鏡像，并在瀏覽器上打開URL http://localhost:9090。

現在搜索標簽logback_events_total。

圖片

正如所看到的，可以看到Prometheus在特定時間收集的指標。

如果找不到該標簽，可以通過導航到“Status > Targets”來檢查作業是否正在運行。應該看到狀態為“UP”，如下所示。

圖片

因此，通過這種方式，數據每2秒就會被攝入到Prometheus中。

現在使用Grafana來可視化這些數據。

5 在Grafana中可視化指標

使用Grafana的Docker鏡像，將其添加到docker-compose文件中。

grafana:
    image: grafana/grafana-oss:8.5.2
    pull_policy: always
    network_mode: host
    container_name: grafana
    restart: unless-stopped
    links:
      - prometheus:prometheus
    volumes:
      - ./data/grafana:/var/lib/grafana
    environment:
      - GF_SECURITY_ADMIN_PASSWORD=admin
      - GF_SERVER_DOMAIN=localhost

在這里，也使用了主機網絡模式，以便和Grafana可以輕松訪問Prometheus端點。

接下來，打開URL http://localhost:3000，使用用戶名和密碼“admin”訪問Grafana。