如何使用 Spring Boot 和 Micrometer 创建自定义仪表？

Question

我写了一个 Spring 引导应用程序，我想使用 Micrometer 向 Prometheus 公开自定义指标。这是一个代码片段，我在其中递增一个计数器（有效）并尝试设置几个仪表（无效）：

@Scheduled(cron = "*/2 * * * * *") // run every 2 seconds
private void logTemperature() throws UnknownHostException {

    // get measurement
    SensorReader sensorReader = new SensorReader();
    SensorReading sensorReading = sensorReader.getSensorReading();

    Metrics.counter("measurements").increment();
    Metrics.gauge("fahrenheit", sensorReading.getFahrenheit());
    Metrics.gauge("humidity", sensorReading.getHumidity());

    // do stuff with measurement
    // ...

}

完整的源代码在这里：https://github.com/alexwoolford/htu21d_logger/tree/master/htu21d-logger-spring

sensorReading 对象中的 fahrenheit 字段是 float。仪表存在于输出中，但值为 NaN（即不是数字）：

# HELP measurements_total  
# TYPE measurements_total counter
measurements_total 82.0
...
# HELP humidity  
# TYPE humidity gauge
humidity NaN
...
# HELP fahrenheit  
# TYPE fahrenheit gauge
fahrenheit NaN
...

我看过类似的帖子，例如 and ，但我无法从这些答案中弄清楚我具体需要做什么。

我还尝试创建一个变量并使用 lambda 更新它，例如

Metrics.gauge("humidity", humidity, humidity -> sensorReading.getHumidity());

... 量表完全消失了（甚至没有 NaN）。

这个问题与其他问题略有不同，因为我没有使用缓存，而是尝试使用全局注册表，这大概是最简单的选择。

Answer 1

您正在使用的对象正在被垃圾回收，因为注释保留了这些值的引用。仪表默认使用弱引用。

如果您将其设置为使用强引用，则应避免使用 NaN。不幸的是，全局注册表助手不会公开仪表生成器，因此您需要以不同的方式创建仪表。

Gauge.builder("humidity", humidity, humidity -> sensorReading.getHumidity()).strongReference(true).register(Metrics.globalRegistry);

作为旁注，我建议放弃 @Scheduled 方法，除非传感器读数本身就很慢。如果 SensorReader 是线程安全的，您可以删除 @Scheduled 并直接使用 SensorReader：

SensorReader sensorReader = new SensorReader();

Gauge.builder("humidity", sensorReader, sensorReader -> 
  sensorReader.getSensorReading().getHumidity())
  .strongReference(true)
  .register(Metrics.globalRegistry);
Gauge.builder("fahrenheit", sensorReader, sensorReader -> 
  sensorReader.getSensorReading().getFahrenheit())
  .strongReference(true)
  .register(Metrics.globalRegistry);

这样您将只会查找传感器读数，即 Prometheus 抓取指标的速率。

如何使用 Spring Boot 和 Micrometer 创建自定义仪表？

how to create custom gauges with Spring Boot and Micrometer?

spring-boot

prometheus

micrometer