如何使用 Prometheus 添加自定义指标返回整数列表？

2024-03-21 03:03:28

在 Prometheus 中使用自定义指标返回整数列表

简介

Prometheus 是一种流行的指标监控系统，它允许用户收集和存储应用程序的性能指标。本文将指导你如何在 Java Spring 应用程序中使用 Prometheus 添加一个自定义指标，该指标返回整数列表。

1. 定义自定义 Collector

Prometheus 允许用户定义自定义 Collector 来收集指标数据。Collector 是一个接口，负责从应用程序中获取指标并将其格式化为 Prometheus 可识别的格式。以下代码段展示了如何创建一个自定义 Collector，名为 IntegerListCollector，它收集整数列表：

public class IntegerListCollector implements Collector {

    private List<Integer> integers = new ArrayList<>();

    @Override
    public void collect(List<MetricFamilySamples> samples) {
        MetricFamilySamples sample = new MetricFamilySamples("INVALID_IDS", MetricType.GAUGE);

        for (Integer integer : integers) {
            sample.addSample("INVALID_IDS", Collections.singletonList("CAUSE"), Collections.singletonList(integer));
        }

        samples.add(sample);
    }

    public void addInteger(Integer integer) {
        integers.add(integer);
    }
}

2. 注册自定义 Collector

定义自定义 Collector 后，需要在 Spring 应用程序中将其注册到 Prometheus。这可以通过使用 @Bean 注解来实现：

@Bean
public IntegerListCollector integerListCollector() {
    return new IntegerListCollector();
}

3. 使用自定义指标

自定义 Collector 注册后，就可以使用自定义指标了。使用 @Gauge 注解并指定 metricName 和 labelNames。例如：

@Gauge(name = "INVALID_IDS", labelNames = "CAUSE")
public List<Integer> getInvalidIds() {
    return integerListCollector.getIntegers();
}

4. 清除整数列表

每次获取指标后，你可能需要清除整数列表。为此，只需调用 clearIntegers() 方法：

public void clearIntegers() {
    integers.clear();
}

示例响应

按照上述步骤，你将能够添加一个自定义指标，该指标返回整数列表。以下是示例响应：

# HELP INVALID_IDS
INVALID_IDS{CAUSE="Timeout"} 978, 019, 100...
INVALID_IDS{CAUSE="Resource not exists"} 420, 510...
INVALID_IDS{CAUSE="Resource expired"} 291, 309...

每次调用指标后，所有列表都会被清除，新的 ID 也会被返回：

# HELP INVALID_IDS
INVALID_IDS{CAUSE="Timeout"} 4310,...
INVALID_IDS{CAUSE="Resource not exist"} 4512
INVALID_IDS{CAUSE="Resources expired"} 4620, 4900,...