Class CacheMetricsRegistrar

java.lang.Object
org.springframework.boot.cache.metrics.CacheMetricsRegistrar
public class CacheMetricsRegistrar extends Object
Register supported Cache to a MeterRegistry.
Since:
4.0.0
Author:
Stephane Nicoll

  • Constructor Details

    • CacheMetricsRegistrar

      public CacheMetricsRegistrar(io.micrometer.core.instrument.MeterRegistry registry, Collection<CacheMeterBinderProvider<?>> binderProviders)
      Creates a new registrar.
      Parameters:
      registry - the MeterRegistry to use
      binderProviders - the CacheMeterBinderProvider instances that should be used to detect compatible caches

  • Method Details

    • bindCacheToRegistry

      public boolean bindCacheToRegistry(Cache cache, io.micrometer.core.instrument.Tag... tags)
      Attempt to bind the specified Cache to the registry. Return true if the cache is supported and was bound to the registry, false otherwise.
      Parameters:
      cache - the cache to handle
      tags - the tags to associate with the metrics of that cache
      Returns:
      true if the cache is supported and was registered

    • getAdditionalTags

      protected Iterable<io.micrometer.core.instrument.Tag> getAdditionalTags(Cache cache)
      Return additional tags to be associated with the given Cache.
      Parameters:
      cache - the cache
      Returns:
      a list of additional tags to associate to that cache.