Spring Boot 对接 Prometheus 指标监控使用详解
在现代微服务架构中，监控每个服务的健康状况和性能至关重要。Prometheus 是一种开源监控和警报系统，广泛应用于容器化环境中。Spring Boot 提供了对 Prometheus 的良好支持，使得用户能够方便地收集和展示应用程序的指标。本文将详细介绍如何在 Spring Boot 应用中集成 Prometheus 进行指标监控。
一、环境准备
在开始之前，确保你已经在项目中引入了相关依赖。在 pom.xml 中添加 Prometheus 的依赖：
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
此外，为了方便后续监控和展示，你可以将 Spring Boot Actuator 也加入到项目中：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
二、配置 Spring Boot 应用
在 application.properties 或 application.yml 中配置 Actuator 和 Prometheus：
management:
endpoints:
web:
exposure:
include: prometheus
metrics:
tags:
enabled: true
这段配置将暴露 Prometheus 端点，并启用标签。
三、编写示例代码
接下来，我们编写一个简单的 REST 控制器，并在其中增加一些指标的收集。在下面的示例中，我们创建了一个 HelloController，用于返回当前时间，并记录请求次数。
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Counter;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.time.LocalDateTime;
@RestController
public class HelloController {
private final Counter requestCounter;
public HelloController() {
// 创建一个计数器，用于统计请求次数
requestCounter = Counter.builder("hello_requests")
.description("Number of hello requests")
.register(Metrics.globalRegistry);
}
@GetMapping("/hello")
public String hello() {
// 增加计数
requestCounter.increment();
return "Hello, the current time is " + LocalDateTime.now();
}
}
在这个控制器中，我们创建了一个计数器 hello_requests，每当调用 /hello 接口时，该计数器就会自增。
四、启动应用并查看指标
完成以上代码后，启动 Spring Boot 应用。然后，你可以访问 http://localhost:8080/actuator/prometheus 来查看 Prometheus 指标。
示例输出：
# HELP hello_requests Number of hello requests
# TYPE hello_requests counter
hello_requests{uuid="some-unique-id",} 1.0
在这里，hello_requests 指标显示了被调用的次数。如果你多次调用 /hello 接口，你会看到计数器的值不断增加。
五、对接 Prometheus 服务
在 Prometheus 的配置文件中，增加以下配置以抓取你应用的指标：
scrape_configs:
- job_name: 'spring-boot-app'
metrics_path: '/actuator/prometheus'
static_configs:
- targets: ['localhost:8080']
确保将 localhost:8080 替换为实际运行你的 Spring Boot 应用的地址。
六、总结
通过上述步骤，我们成功地将 Spring Boot 应用与 Prometheus 指标监控进行集成。利用 Prometheus 的强大功能，能够有效地监控微服务的运行状态和性能指标。随后，你还可以利用 Grafana 等工具进行可视化分析，实现更全面的监控解决方案。希望这一教程能够帮助你更好地理解和使用 Spring Boot 的 Prometheus 集成。
