micrometer-metrics/micrometer

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

Open

#5 066 ouverte le 11 mai 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Java (4 220 stars) (935 forks)batch import
enhancementhelp wantedinstrumentationmodule: micrometer-core

Description

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

Guide contributeur

Stack technique
java
Domaine
observabilitybackend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
JavaMicrometer cache instrumentation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.