Package io.prometheus.client.guava.cache

Class CacheMetricsCollector

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.guava.cache.CacheMetricsCollector

public class CacheMetricsCollector
extends Collector

Collect metrics from Guava's com.google.common.cache.Cache.

 // Note that `recordStats()` is required to gather non-zero statistics
 Cache<String, String> cache = CacheBuilder.newBuilder().recordStats().build();
 CacheMetricsCollector cacheMetrics = new CacheMetricsCollector().register();
 cacheMetrics.addCache("mycache", cache);

 

Exposed metrics are labeled with the provided cache name. With the example above, sample metric names would be:

     guava_cache_hit_total{cache="mycache"} 10.0
     guava_cache_miss_total{cache="mycache"} 3.0
     guava_cache_requests_total{cache="mycache"} 13.0
     guava_cache_eviction_total{cache="mycache"} 1.0
     guava_cache_size{cache="mycache"} 5.0
 

Additionally if the cache includes a loader, the following metrics would be provided:

     guava_cache_load_failure_total{cache="mycache"} 2.0
     guava_cache_loads_total{cache="mycache"} 7.0
     guava_cache_load_duration_seconds_count{cache="mycache"} 7.0
     guava_cache_load_duration_seconds_sum{cache="mycache"} 0.0034
 

Nested Class Summary

Nested classes/interfaces inherited from class io.prometheus.client.Collector

Collector.Describable, Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConcurrentMap<String,com.google.common.cache.Cache>	children

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
CacheMetricsCollector()

Method Summary

Modifier and Type	Method	Description
void	addCache(String cacheName, com.google.common.cache.Cache cache)	Add or replace the cache with the given name.
void	clear()	Remove all caches.
List<Collector.MetricFamilySamples>	collect()	Return all metrics of this Collector.
com.google.common.cache.Cache	removeCache(String cacheName)	Remove the cache with the given name.

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, collect, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class java.lang.Object

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

Field Details

children

protected final ConcurrentMap<String,com.google.common.cache.Cache> children

Constructor Details

CacheMetricsCollector

public CacheMetricsCollector()

Method Details

addCache

public void addCache(String cacheName,
 com.google.common.cache.Cache cache)

Add or replace the cache with the given name.

Any references any previous cache with this name is invalidated.

Parameters:

cacheName - The name of the cache, will be the metrics label value

cache - The cache being monitored

removeCache

public com.google.common.cache.Cache removeCache(String cacheName)

Remove the cache with the given name.

Any references to the cache are invalidated.

Parameters:

cacheName - cache to be removed

clear

public void clear()

Remove all caches.

Any references to all caches are invalidated.

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all metrics of this Collector.

Specified by:

collect in class Collector