micrometer-metrics/micrometer

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

Open

#5.066 geöffnet am 11. Mai 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.220 Stars) (935 Forks)batch import
enhancementhelp wantedinstrumentationmodule: micrometer-core

Beschreibung

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

Contributor Guide

Tech Stack
java
Domain
observabilitybackend
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaMicrometer cache instrumentation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.