Spring Boot项目中Prometheus自定义指标收集

Prometheus是一款强大的开源监控系统和时间序列数据库，广泛应用于微服务架构下的监控和报警系统。Spring Boot提供了与Prometheus的良好集成，允许开发者轻松地收集并导出应用的各种性能指标。本文将详细介绍如何在Spring Boot项目中实现Prometheus自定义指标的收集，以满足特定的监控需求。

一、引入依赖

在Spring Boot项目中集成Prometheus，首先需要添加相应的依赖。通常使用 micrometer库来实现与Prometheus的集成。

在 pom.xml文件中添加以下依赖：

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

解释：

micrometer-registry-prometheus：Micrometer的Prometheus注册表，实现了将应用程序指标导出到Prometheus。
spring-boot-starter-actuator：Spring Boot的Actuator模块，用于暴露应用的健康检查、指标等端点。

二、配置Prometheus端点

Spring Boot的Actuator默认提供了与Prometheus集成的端点，可以通过配置启用该功能。

在 application.yml或 application.properties中添加以下配置：

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

解释：

management.endpoints.web.exposure.include：指定要暴露的Actuator端点，这里包括Prometheus。
metrics.export.prometheus.enabled：启用Prometheus指标的导出功能。
endpoint.prometheus.enabled：确保Prometheus端点被启用。

在此配置下，Spring Boot会自动在 /actuator/prometheus路径下暴露应用的指标，供Prometheus服务器抓取。

三、自定义Prometheus指标

除了Spring Boot Actuator自动收集的指标外，开发者可以定义自定义指标来监控应用中特定的业务指标。Micrometer提供了多种类型的指标，如计数器（Counter）、计时器（Timer）、摘要（Summary）等。

1. 定义自定义计数器

计数器用于累计某一事件发生的次数，例如记录用户登录的次数。

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class CustomMetrics {

    private final Counter loginCounter;

    @Autowired
    public CustomMetrics(MeterRegistry registry) {
        this.loginCounter = registry.counter("custom_login_counter", "type", "login");
    }

    public void recordLogin() {
        loginCounter.increment();
    }
}

解释：

MeterRegistry：Micrometer的核心组件，用于注册和管理指标。
registry.counter：创建一个计数器并注册到MeterRegistry中。
increment()：每当用户登录时调用该方法，计数器的值会自动增加。

2. 定义自定义计时器

计时器用于测量某个操作的时间，例如记录某个服务请求的响应时间。

import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;

@Component
public class CustomMetrics {

    private final Timer requestTimer;

    @Autowired
    public CustomMetrics(MeterRegistry registry) {
        this.requestTimer = registry.timer("custom_request_timer", "service", "example");
    }

    public void recordRequest(Runnable request) {
        requestTimer.record(request);
    }

    public void recordRequestTime(long duration) {
        requestTimer.record(duration, TimeUnit.MILLISECONDS);
    }
}

解释：

registry.timer：创建一个计时器，用于记录某个操作的执行时间。
record(Runnable request)：自动测量传入操作的执行时间。
record(long duration, TimeUnit.MILLISECONDS)：手动记录操作执行的时间。

3. 定义自定义摘要

摘要用于采集一段时间内的数据分布情况，例如记录接口响应时间的百分位数。

import io.micrometer.core.instrument.DistributionSummary;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class CustomMetrics {

    private final DistributionSummary responseSizeSummary;

    @Autowired
    public CustomMetrics(MeterRegistry registry) {
        this.responseSizeSummary = registry.summary("custom_response_size_summary", "service", "example");
    }

    public void recordResponseSize(double size) {
        responseSizeSummary.record(size);
    }
}

解释：

registry.summary：创建一个摘要，记录数据的分布情况，如响应大小的分布。
record(double size)：记录每次请求的响应大小。

四、通过Prometheus抓取自定义指标

在定义并注册了自定义指标后，这些指标将被自动集成到Prometheus的指标端点中。Prometheus服务器可以定期抓取这些指标，并将其存储在时间序列数据库中。

1. 配置Prometheus抓取Spring Boot应用

在Prometheus的配置文件中，添加Spring Boot应用的抓取配置：

scrape_configs:
  - job_name: 'spring-boot-application'
    metrics_path: '/actuator/prometheus'
    static_configs:
      - targets: ['localhost:8080']

解释：

job_name：定义Prometheus任务的名称。
metrics_path：指定要抓取的指标路径，这里是Spring Boot Actuator的Prometheus端点。
targets：定义目标应用的地址和端口。

2. 验证指标抓取

启动Prometheus服务器后，可以通过Prometheus的Web界面或API查询自定义指标，验证其是否被成功抓取。

五、分析说明表

指标类型	用途
计数器（Counter）	累计事件发生次数，如用户登录次数、请求数量等。
计时器（Timer）	测量操作执行时间，如请求的响应时间、任务的处理时间。
摘要（Summary）	采集一段时间内的数据分布情况，如响应时间的百分位数、请求大小的分布等。

总结

通过在Spring Boot项目中集成Prometheus并定义自定义指标，开发者可以深入监控应用的运行状态，了解关键业务指标的变化情况。Prometheus强大的监控能力与Spring Boot的灵活集成，能够帮助团队及时发现问题并优化系统性能。本文介绍了如何通过Micrometer在Spring Boot中定义和收集自定义指标，并通过Prometheus进行抓取与分析。掌握这些技术，有助于构建健壮的微服务监控体系，确保系统的稳定运行。

Spring Boot项目中Prometheus自定义指标收集