io.micronaut.configuration.metrics.binder.cache

Class MicronautCaffeineCacheMetrics

java.lang.Object

io.micrometer.core.instrument.binder.cache.CacheMeterBinder

io.micronaut.configuration.metrics.binder.cache.MicronautCaffeineCacheMetrics

All Implemented Interfaces:

io.micrometer.core.instrument.binder.MeterBinder

@NonNullApi
 @NonNullFields
public class MicronautCaffeineCacheMetrics
extends io.micrometer.core.instrument.binder.cache.CacheMeterBinder

Collect metrics from Caffeine's com.github.benmanes.caffeine.cache.Cache.

Note that `recordStats()` is required to gather non-zero statistics:

 Cache<String, String> cache = Caffeine.newBuilder().recordStats().build();
 CaffeineCacheMetrics.monitor(registry, cache, "mycache", "region", "test");
 

NOTE: This is a fork of https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/instrument/binder/cache/CaffeineCacheMetrics.java The reason for the fork is because Micronaut repackages caffeine under a different package

Author:

Clint Checketts, graemerocher

Constructor Summary

Constructors

Constructor and Description
MicronautCaffeineCacheMetrics(com.github.benmanes.caffeine.cache.Cache<?,?> cache, String cacheName, Iterable<io.micrometer.core.instrument.Tag> tags) Creates a new MicronautCaffeineCacheMetrics instance.

Method Summary

Modifier and Type	Method and Description
protected void	bindImplementationSpecificMetrics(io.micrometer.core.instrument.MeterRegistry registry)
protected Long	evictionCount()
protected long	hitCount()
protected Long	missCount()
static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C	monitor(io.micrometer.core.instrument.MeterRegistry registry, C cache, String cacheName, Iterable<io.micrometer.core.instrument.Tag> tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.Cache> C	monitor(io.micrometer.core.instrument.MeterRegistry registry, C cache, String cacheName, Iterable<io.micrometer.core.instrument.Tag> tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C	monitor(io.micrometer.core.instrument.MeterRegistry registry, C cache, String cacheName, String... tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.Cache> C	monitor(io.micrometer.core.instrument.MeterRegistry registry, C cache, String cacheName, String... tags) Record metrics on a Caffeine cache.
protected long	putCount()
protected Long	size()

Methods inherited from class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

bindTo, getTagsWithCacheName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicronautCaffeineCacheMetrics

public MicronautCaffeineCacheMetrics(com.github.benmanes.caffeine.cache.Cache<?,?> cache,
                                     String cacheName,
                                     Iterable<io.micrometer.core.instrument.Tag> tags)

Creates a new MicronautCaffeineCacheMetrics instance.

Parameters:

cache - The cache to be instrumented. You must call Caffeine.recordStats() prior to building the cache for metrics to be recorded.

cacheName - Will be used to tag metrics with "cache".

tags - tags to apply to all recorded metrics.

Method Detail

monitor

public static <C extends com.github.benmanes.caffeine.cache.Cache> C monitor(io.micrometer.core.instrument.MeterRegistry registry,
                                                                             C cache,
                                                                             String cacheName,
                                                                             String... tags)

Record metrics on a Caffeine cache. You must call Caffeine.recordStats() prior to building the cache for metrics to be recorded.

Type Parameters:

C - The cache type.

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

cacheName - Will be used to tag metrics with "cache".

tags - Tags to apply to all recorded metrics. Must be an even number of arguments representing key/value pairs of tags.

Returns:

The instrumented cache, unchanged. The original cache is not wrapped or proxied in any way.

monitor

public static <C extends com.github.benmanes.caffeine.cache.Cache> C monitor(io.micrometer.core.instrument.MeterRegistry registry,
                                                                             C cache,
                                                                             String cacheName,
                                                                             Iterable<io.micrometer.core.instrument.Tag> tags)

Record metrics on a Caffeine cache. You must call Caffeine.recordStats() prior to building the cache for metrics to be recorded.

Type Parameters:

C - The cache type.

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

cacheName - Will be used to tag metrics with "cache".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented cache, unchanged. The original cache is not wrapped or proxied in any way.

See Also:

CacheStats

monitor

public static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C monitor(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                         C cache,
                                                                                         String cacheName,
                                                                                         String... tags)

Record metrics on a Caffeine cache. You must call Caffeine.recordStats() prior to building the cache for metrics to be recorded.

Type Parameters:

C - The cache type.

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

cacheName - Will be used to tag metrics with "cache".

tags - Tags to apply to all recorded metrics. Must be an even number of arguments representing key/value pairs of tags.

Returns:

The instrumented cache, unchanged. The original cache is not wrapped or proxied in any way.

monitor

public static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C monitor(io.micrometer.core.instrument.MeterRegistry registry,
                                                                                         C cache,
                                                                                         String cacheName,
                                                                                         Iterable<io.micrometer.core.instrument.Tag> tags)

Record metrics on a Caffeine cache. You must call Caffeine.recordStats() prior to building the cache for metrics to be recorded.

Type Parameters:

C - The cache type.

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

cacheName - Will be used to tag metrics with "cache".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented cache, unchanged. The original cache is not wrapped or proxied in any way.

See Also:

CacheStats

size

protected Long size()

Specified by:

size in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

hitCount

protected long hitCount()

Specified by:

hitCount in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

missCount

protected Long missCount()

Specified by:

missCount in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

evictionCount

protected Long evictionCount()

Specified by:

evictionCount in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

putCount

protected long putCount()

Specified by:

putCount in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder

bindImplementationSpecificMetrics

protected void bindImplementationSpecificMetrics(io.micrometer.core.instrument.MeterRegistry registry)

Specified by:

bindImplementationSpecificMetrics in class io.micrometer.core.instrument.binder.cache.CacheMeterBinder