Class CacheMetricsRegistrar
java.lang.Object
org.springframework.boot.actuate.metrics.cache.CacheMetricsRegistrar
Register supported
Cache
to a MeterRegistry
.- Since:
- 2.0.0
- Author:
- Stephane Nicoll
-
Constructor Summary
ConstructorDescriptionCacheMetricsRegistrar
(io.micrometer.core.instrument.MeterRegistry registry, Collection<CacheMeterBinderProvider<?>> binderProviders) Creates a new registrar. -
Method Summary
Modifier and TypeMethodDescriptionboolean
bindCacheToRegistry
(Cache cache, io.micrometer.core.instrument.Tag... tags) Attempt to bind the specifiedCache
to the registry.protected Iterable<io.micrometer.core.instrument.Tag>
getAdditionalTags
(Cache cache) Return additionaltags
to be associated with the givenCache
.
-
Constructor Details
-
CacheMetricsRegistrar
public CacheMetricsRegistrar(io.micrometer.core.instrument.MeterRegistry registry, Collection<CacheMeterBinderProvider<?>> binderProviders) Creates a new registrar.- Parameters:
registry
- theMeterRegistry
to usebinderProviders
- theCacheMeterBinderProvider
instances that should be used to detect compatible caches
-
-
Method Details
-
bindCacheToRegistry
Attempt to bind the specifiedCache
to the registry. Returntrue
if the cache is supported and was bound to the registry,false
otherwise.- Parameters:
cache
- the cache to handletags
- the tags to associate with the metrics of that cache- Returns:
true
if thecache
is supported and was registered
-
getAdditionalTags
Return additionaltags
to be associated with the givenCache
.- Parameters:
cache
- the cache- Returns:
- a list of additional tags to associate to that
cache
.
-