micrometer-metrics/micrometer

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

Open

#5,066 opened on May 11, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (935 forks)batch import
enhancementhelp wantedinstrumentationmodule: micrometer-core

Repository metrics

Stars
 (4,220 stars)
PR merge metrics
 (Avg merge 1d 21h) (100 merged PRs in 30d)

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

Contributor guide

Research direction
Examine the Caffeine cache instrumentation in micrometer to identify where stats recording is checked; add a log warning when the cache does not record stats.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65