io.micrometer.core.instrument.binder.cache

Class CaffeineCacheMetrics

java.lang.Object

io.micrometer.core.instrument.binder.cache.CaffeineCacheMetrics

All Implemented Interfaces:

MeterBinder

@NonNullApi
 @NonNullFields
public class CaffeineCacheMetrics
extends java.lang.Object
implements MeterBinder

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");
 

Constructor Summary

Constructors

Constructor and Description
CaffeineCacheMetrics(com.github.benmanes.caffeine.cache.Cache<?,?> cache, java.lang.String name, java.lang.Iterable<Tag> tags) Creates a new CaffeineCacheMetrics instance.

Method Summary

Modifier and Type	Method and Description
void	bindTo(MeterRegistry registry)
static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C	monitor(MeterRegistry registry, C cache, java.lang.String name, java.lang.Iterable<Tag> tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.Cache> C	monitor(MeterRegistry registry, C cache, java.lang.String name, java.lang.Iterable<Tag> tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.AsyncLoadingCache> C	monitor(MeterRegistry registry, C cache, java.lang.String name, java.lang.String... tags) Record metrics on a Caffeine cache.
static <C extends com.github.benmanes.caffeine.cache.Cache> C	monitor(MeterRegistry registry, C cache, java.lang.String name, java.lang.String... tags) Record metrics on a Caffeine cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaffeineCacheMetrics

public CaffeineCacheMetrics(com.github.benmanes.caffeine.cache.Cache<?,?> cache,
                            java.lang.String name,
                            java.lang.Iterable<Tag> tags)

Creates a new CaffeineCacheMetrics instance.

Parameters:

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

name - The metric name prefix

tags - tags to apply to all recorded metrics

Method Detail

monitor

public static <C extends com.github.benmanes.caffeine.cache.Cache> C monitor(MeterRegistry registry,
                                                                             C cache,
                                                                             java.lang.String name,
                                                                             java.lang.String... tags)

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

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

name - The name prefix of the metrics.

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(MeterRegistry registry,
                                                                             C cache,
                                                                             java.lang.String name,
                                                                             java.lang.Iterable<Tag> tags)

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

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

name - The name prefix of the metrics.

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(MeterRegistry registry,
                                                                                         C cache,
                                                                                         java.lang.String name,
                                                                                         java.lang.String... tags)

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

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

name - The name prefix of the metrics.

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(MeterRegistry registry,
                                                                                         C cache,
                                                                                         java.lang.String name,
                                                                                         java.lang.Iterable<Tag> tags)

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

Parameters:

registry - The registry to bind metrics to.

cache - The cache to instrument.

name - The name prefix of the metrics.

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

bindTo

public void bindTo(MeterRegistry registry)

Specified by:

bindTo in interface MeterBinder