micrometer-metrics/micrometer

Log a warning when instrumenting a cache that is not recording stats

Open

#5,066 建立於 2024年5月11日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Java (4,220 star) (935 fork)batch import
enhancementhelp wantedinstrumentationmodule: micrometer-core

描述

Please describe the feature request. It would be nice if a warning were logged (or the user was informed in some way) when a cache is instrumented that is not recording stats.

Rationale For some Cache implementations like Caffeine recording stats is optional. When instrumenting a cache that is not recording stats the meters will constantly report 0 which could be misleading. This is probably not what the user desires.

Additional context

apache/accumulo#4552

貢獻者指南

技術棧
java
領域
observabilitybackend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaMicrometer cache instrumentation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Look at the cache instrumentation code in Micrometer, likely in the `micrometer core` module under `io.micrometer.core.instrument.binder.cache`. Identify where the cache is instrumented (e.g., in `CacheMeterBinder` or similar). For Caffeine caches, check if `CacheStats` are enabled via `Caffeine.recordStats()`. If stats are not enabled, add a warning log using standard `Logger` before creating meters. The issue suggests that when instruments are created, they will report zero, so the warning should be emitted during instrumentation setup.
Log a warning when instrumenting a cache that is not recording stats · micrometer-metrics/micrometer#5066 | Good First Issue