使用 SpringBoot + Prometheus 实现高效监控系统-CFANZ编程社区

在微服务架构下，系统的运行状态和性能监控显得尤为重要。Prometheus 是一个强大的开源监控和告警系统，与 SpringBoot 的结合可以帮助开发者轻松构建高效的监控体系。本文将详细介绍如何使用 SpringBoot 和 Prometheus 搭建一个高效的监控系统，并提供代码示例。

一、什么是 Prometheus？

Prometheus 是一款开源的监控系统，特别适用于云原生环境。它提供了一种简单的方式来采集、存储和分析指标数据。

Prometheus 的核心功能

多维度数据模型：以指标为基础，支持标签（key-value）的多维度查询。
强大的查询语言：使用 PromQL 查询和分析数据。
自带存储：内置时间序列数据库，无需外部依赖。
告警功能：内置 AlertManager 支持复杂告警逻辑。
生态丰富：支持 Grafana、Kubernetes 等工具的集成。

二、SpringBoot 集成 Prometheus

1. 添加依赖

为了让 SpringBoot 应用暴露 Prometheus 监控指标，我们需要引入 Micrometer 和 Actuator：

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

2. 配置 Actuator 和 Prometheus

在 application.yml 中启用 Actuator 并配置 Prometheus 指标暴露端点：

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

3. 编写业务逻辑并记录指标

以一个简单的 RESTful API 为例，记录请求次数和耗时：

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MonitoringController {

    private final MeterRegistry meterRegistry;

    public MonitoringController(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
    }

    @GetMapping("/api/hello")
    public String hello() {
        Timer timer = meterRegistry.timer("api_hello_timer");
        return timer.record(() -> {
            simulateWorkload();
            return "Hello, Prometheus!";
        });
    }

    private void simulateWorkload() {
        try {
            Thread.sleep(200); // 模拟处理耗时
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
    }
}

在上述代码中：

使用 MeterRegistry 来记录自定义指标。
Timer 用于跟踪方法的执行时间。

三、运行 Prometheus 和 SpringBoot 应用

1. 下载和配置 Prometheus

从 Prometheus 官方网站

编辑 Prometheus 的配置文件 prometheus.yml，添加 SpringBoot 应用的指标采集目标：

scrape_configs:
  - job_name: 'springboot-app'
    static_configs:
      - targets: ['localhost:8080'] # SpringBoot 应用暴露指标的地址

2. 启动 Prometheus

运行以下命令启动 Prometheus：

./prometheus --config.file=prometheus.yml

Prometheus 默认运行在 http://localhost:9090。

3. 配置 Grafana（可选）

Prometheus 和 Grafana 是绝配！你可以将 Prometheus 配置为 Grafana 的数据源，用于可视化监控数据：

下载并安装 Grafana。
添加 Prometheus 数据源，URL 设置为 http://localhost:9090。
使用预定义的仪表盘或自定义创建图表。

四、告警功能

配置 AlertManager

在 Prometheus 中，告警规则由 alerting 配置定义。例如：

groups:
  - name: example-alert
    rules:
      - alert: HighRequestLatency
        expr: api_hello_timer_seconds_bucket{le="0.5"} < 0.9
        for: 1m
        labels:
          severity: warning
        annotations:
          summary: "请求延迟过高"
          description: "在过去1分钟，API响应时间超过0.5秒的比例低于90%。"

启动 AlertManager，并将其与 Prometheus 关联。

五、完整的目录结构

src
├── main
│   ├── java
│   │   ├── com.example.monitoring
│   │   │   ├── MonitoringController.java
│   │   │   ├── Application.java
│   ├── resources
│   │   ├── application.yml
│   │   ├── prometheus.yml