Package org.infinispan.metrics.impl

Class MetricsRegistryImpl

java.lang.Object

org.infinispan.metrics.impl.MetricsRegistryImpl

All Implemented Interfaces:

Constants, MetricsRegistry

public class MetricsRegistryImpl
extends Object
implements MetricsRegistry

Concrete implementation of MetricsRegistry.

It uses MeterRegistry from micrometer. It can use the instance configured from MicrometerMeterRegistryConfiguration.meterRegistry() or, if not configured, it instantiates PrometheusMeterRegistry.

Field Summary

Fields inherited from interface org.infinispan.metrics.Constants

CACHE_MANAGER_TAG_NAME, CACHE_TAG_NAME, JGROUPS_CLUSTER_TAG_NAME, JGROUPS_PREFIX, NODE_TAG_NAME, SITE_TAG_NAME, TARGET_NODE

Constructor Summary

Constructors

Constructor	Description
MetricsRegistryImpl()

Method Summary

Modifier and Type	Method	Description
boolean	namesAsTags()	Same as GlobalMetricsConfiguration.namesAsTags().
Set<Object>	registerMetrics(Object instance, Collection<org.infinispan.commons.stat.MetricInfo> metricInfos, String prefix, Map<String,String> tags)	Register the MBeanMetadata.AttributeMetadata as metrics.
io.micrometer.core.instrument.MeterRegistry	registry()
String	scrape(String contentType)	Prometheus like scrapping of the registered metrics.
void	start()
void	stop()
boolean	supportScrape()	If this instance supports scrapping.
void	unregisterMetric(Object metricId)	Unregisters a single metric.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.metrics.impl.MetricsRegistry

unregisterMetrics

Constructor Details

MetricsRegistryImpl

public MetricsRegistryImpl()

Method Details

start

public void start()

stop

public void stop()

registerMetrics

public Set<Object> registerMetrics(Object instance,
 Collection<org.infinispan.commons.stat.MetricInfo> metricInfos,
 String prefix,
 Map<String,String> tags)

Description copied from interface: MetricsRegistry

Register the MBeanMetadata.AttributeMetadata as metrics.

Specified by:

registerMetrics in interface MetricsRegistry

Parameters:

instance - The instance from where metrics are collected.

metricInfos - The attribute (metrics) to be registered, if valid.

prefix - The prefix or the component name.

tags - Extra tags to be attached to the metrics.

Returns:

A set of ids that can be used by MetricsRegistry.unregisterMetric(Object) or MetricsRegistry.unregisterMetrics(Collection).

unregisterMetric

public void unregisterMetric(Object metricId)

Description copied from interface: MetricsRegistry

Unregisters a single metric.

If the metricId is not a valid id, this method does nothing.

Specified by:

unregisterMetric in interface MetricsRegistry

Parameters:

metricId - The metric id as returned by MetricsRegistry.registerMetrics(Object, Collection, String, Map).

namesAsTags

public boolean namesAsTags()

Description copied from interface: MetricsRegistry

Same as GlobalMetricsConfiguration.namesAsTags().

Specified by:

namesAsTags in interface MetricsRegistry

Returns:

true if it should use tags to identify the cluster, site or cache manager name.

supportScrape

public boolean supportScrape()

Description copied from interface: MetricsRegistry

If this instance supports scrapping.

Specified by:

supportScrape in interface MetricsRegistry

Returns:

true if it supports Prometheus scrapping.

See Also:

• MetricsRegistry.scrape(String)

scrape

public String scrape(String contentType)

Description copied from interface: MetricsRegistry

Prometheus like scrapping of the registered metrics.

It returns null if MetricsRegistry.supportScrape() returns false.

Specified by:

scrape in interface MetricsRegistry

Parameters:

contentType - A valid content-type.

Returns:

A String with the metrics values.

registry

public io.micrometer.core.instrument.MeterRegistry registry()