升级到 Spring Boot 2 后，如何向 prometheus 公开缓存指标？

Question

我最近将一个 Spring Boot 应用程序从 1.5 升级到了 2.0.1。我还将 prometheus 集成迁移到使用千分尺的新执行器方法。大多数事情现在都可以正常工作 - 包括一些自定义计数器和仪表。

我注意到新的 prometheus 端点 /actuator/prometheus 不再发布 Spring 缓存指标（大小和命中率）。

我唯一能找到的是this 问题及其相关的commit。

我仍然无法获取 prometheus 导出的缓存指标。我尝试设置一些属性：

management.metrics.cache.instrument-cache=true
spring.cache.cache-names=cache1Name,cache2Name...

但没有什么真正有效。我可以看到 Hazelcast 缓存管理器启动，注册缓存管理器 bean 等等 - 但/metrics 和 /prometheus 都没有显示任何统计信息。使用@Cacheable 注释填充缓存。这适用于 Spring Boot 1.5 - 我认为通过 Hazelcast 通过 JMX 公开其指标，prometheus 导出器从那里获取它？

现在不确定如何将它们连接在一起。欢迎任何提示！

Answer 1

既然你已经回答了我的问题，我可以提供一个答案。

我的缓存稍后会通过计划任务创建

那么文档的这一部分适用于您：

只有启动时可用的缓存才绑定到注册表。对于在启动阶段之后即时或以编程方式创建的缓存，需要显式注册。可以使用 CacheMetricsRegistrar bean 来简化该过程。

所以你必须自己注册这样的缓存，希望这很容易，比如：

public class MyComponent {

    private final CacheMetricsRegistrar cacheMetricsRegistrar;
    private final CacheManager cacheManager

    public MyComponent(CacheMetricsRegistrar cacheMetricsRegistrar,
                CacheManager cacheManager) { ... }

    public void register() {
         // you have just registered cache "xyz"
         Cache xyz = this.cacheManager.getCache("xyz");
         this.cacheMetricsRegistrar.bindCacheToRegistry(xyz);
    }

}

您可以在现有代码中包含此代码。如果您不想这样做，那么您需要在现有代码之后运行其他东西来将这些缓存注册到注册表。