@NonNullApi @NonNullFields public class JCacheMetrics extends CacheMeterBinder
Note that JSR-107 does not provide any insight into the size or estimated size of the cache, so the size metric of a JCache cache will always report 0.
Constructor and Description |
---|
JCacheMetrics(javax.cache.Cache<?,?> cache,
java.lang.Iterable<Tag> tags) |
Modifier and Type | Method and Description |
---|---|
protected void |
bindImplementationSpecificMetrics(MeterRegistry registry)
Bind detailed metrics that are particular to the cache implementation, e.g.
|
protected java.lang.Long |
evictionCount() |
protected long |
hitCount() |
protected long |
missCount() |
static <K,V,C extends javax.cache.Cache<K,V>> |
monitor(MeterRegistry registry,
C cache,
java.lang.Iterable<Tag> tags)
Record metrics on a JCache cache.
|
static <K,V,C extends javax.cache.Cache<K,V>> |
monitor(MeterRegistry registry,
C cache,
java.lang.String... tags)
Record metrics on a JCache cache.
|
protected long |
putCount()
The put mechanism is unimportant - this count applies to entries added to the cache according to a pre-defined
load function such as exists in Guava/Caffeine caches as well as manual puts.
|
protected java.lang.Long |
size()
MOST cache implementations provide a means of retrieving the number of entries.
|
bindTo, getTagsWithCacheName
public JCacheMetrics(javax.cache.Cache<?,?> cache, java.lang.Iterable<Tag> tags)
public static <K,V,C extends javax.cache.Cache<K,V>> C monitor(MeterRegistry registry, C cache, java.lang.String... tags)
C
- The cache type.K
- The cache key type.V
- The cache value type.registry
- The registry to bind metrics to.cache
- The cache to instrument.tags
- Tags to apply to all recorded metrics. Must be an even number of arguments representing key/value pairs of tags.CacheStats
public static <K,V,C extends javax.cache.Cache<K,V>> C monitor(MeterRegistry registry, C cache, java.lang.Iterable<Tag> tags)
C
- The cache type.K
- The cache key type.V
- The cache value type.registry
- The registry to bind metrics to.cache
- The cache to instrument.tags
- Tags to apply to all recorded metrics.CacheStats
protected java.lang.Long size()
CacheMeterBinder
size
in class CacheMeterBinder
null
if the cache implementation does not provide a way to track cache size.protected long hitCount()
hitCount
in class CacheMeterBinder
protected long missCount()
missCount
in class CacheMeterBinder
protected java.lang.Long evictionCount()
evictionCount
in class CacheMeterBinder
null
if the cache implementation does not support eviction, or does not provide a way to track
the eviction count.protected long putCount()
CacheMeterBinder
putCount
in class CacheMeterBinder
protected void bindImplementationSpecificMetrics(MeterRegistry registry)
CacheMeterBinder
bindImplementationSpecificMetrics
in class CacheMeterBinder
registry
- The registry to bind metrics to.