网站首页 > 厂商资讯 > deepflow >

如何在Actuator中添加自定义Prometheus指标度量？

在微服务架构中，Prometheus 是一个开源的监控和警报工具，而 Actuator 是 Spring Boot 提供的一个端点，用于提供关于应用程序运行状况的元数据。将 Prometheus 与 Actuator 结合使用，可以方便地监控 Spring Boot 应用程序。本文将详细介绍如何在 Actuator 中添加自定义 Prometheus 指标度量。

一、了解 Prometheus 和 Actuator

Prometheus 是一个开源监控系统，可以收集、存储和查询监控数据。它具有以下特点：

数据采集：通过内置的 HTTP 拉取和 Pushgateway 推送等方式采集数据。
数据存储：使用时间序列数据库存储监控数据。
数据查询：提供 PromQL（Prometheus 查询语言）进行数据查询。
可视化：与 Grafana 等可视化工具集成，方便展示监控数据。

Actuator 是 Spring Boot 提供的一个端点，用于提供关于应用程序运行状况的元数据。它提供了多种端点，如 health、info、metrics 等，可以方便地获取应用程序的健康状态、配置信息、性能指标等。

二、添加自定义 Prometheus 指标度量

在 Actuator 中添加自定义 Prometheus 指标度量，主要涉及以下步骤：

定义指标：使用 Prometheus 提供的指标类型（如 Counter、Gauge、Histogram、Summary）定义自定义指标。
注册指标：将自定义指标注册到 Actuator 的指标管理器中。
暴露指标：通过 Actuator 的 /metrics 端点暴露自定义指标。

以下是一个示例，演示如何在 Spring Boot 应用程序中添加一个自定义的 Counter 指标：

import io.micrometer.core.instrument.MeterRegistry;

import io.micrometer.core.instrument.binder.messaging.MessagingMetrics;

import org.springframework.boot.actuate.metrics.Counter;

import org.springframework.boot.actuate.metrics.CounterService;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;



@Configuration

public class PrometheusConfig {



    @Bean

    public CounterService counterService(MeterRegistry registry) {

        return new CounterService(registry);

    }



    @Bean

    public Counter myCustomCounter(CounterService counterService) {

        return counterService.counter("my.custom.counter");

    }

}

在上面的示例中，我们定义了一个名为 my.custom.counter 的 Counter 指标，并在 PrometheusConfig 配置类中将其注册到 Actuator 的指标管理器中。

三、配置 Prometheus 采集自定义指标

在 Prometheus 配置文件中，需要添加以下内容以采集自定义指标：

scrape_configs:

  - job_name: 'spring-boot'

    static_configs:

      - targets: ['localhost:9090']

        labels:

          app: 'my-spring-boot-app'

在上面的配置中，我们指定了 Spring Boot 应用程序的地址（localhost:9090）和标签（app: my-spring-boot-app）。Prometheus 将定期从该地址采集指标数据。

四、案例分析

以下是一个使用 Prometheus 和 Actuator 监控 Spring Boot 应用程序内存使用的案例分析：

添加自定义指标：在 Spring Boot 应用程序中添加一个自定义的 Gauge 指标，用于监控内存使用情况。

import io.micrometer.core.instrument.Gauge;

import io.micrometer.core.instrument.MeterRegistry;

import org.springframework.boot.actuate.metrics.MetricsEndpoint;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;



@Configuration

public class PrometheusConfig {



    @Bean

    public MetricsEndpoint metricsEndpoint(MeterRegistry registry) {

        return new MetricsEndpoint(registry);

    }



    @Bean

    public Gauge memoryUsageGauge(MeterRegistry registry) {

        return Gauge.builder("memory_usage", () -> Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory())

                .description("Memory usage of the application")

                .register(registry);

    }

}

配置 Prometheus 采集自定义指标：在 Prometheus 配置文件中添加以下内容：

scrape_configs:

  - job_name: 'spring-boot'

    static_configs:

      - targets: ['localhost:9090']

        labels:

          app: 'my-spring-boot-app'

可视化内存使用情况：使用 Grafana 将 Prometheus 采集到的内存使用情况可视化。

通过以上步骤，我们可以在 Prometheus 中监控 Spring Boot 应用程序的内存使用情况，从而及时发现和解决问题。