Class PrometheusRegistry

java.lang.Object

org.infinispan.metrics.impl.PrometheusRegistry

All Implemented Interfaces:

Constants, MetricsRegistry

public class PrometheusRegistry
extends Object

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 Constants

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

Constructor Summary

Constructors

Constructor	Description
PrometheusRegistry()

Method Summary

Modifier and Type	Method	Description
boolean	legacy()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	namesAsTags()	Deprecated, for removal: This API element is subject to removal in a future version.
Set<Object>	registerMetrics(Object instance, Collection<org.infinispan.commons.stat.MetricInfo> metricInfos, String namePrefix, Map<String,String> tags)	Register the MBeanMetadata.AttributeMetadata as metrics.
protected io.micrometer.core.instrument.MeterRegistry	registry()
String	scrape(String contentType)	Prometheus like scrapping of the registered metrics.
protected void	start()
protected void	stop()
boolean	supportScrape()	If this instance supports scraping.
void	unregisterMetric(Object metricId)	Unregisters a single metric.

Methods inherited from class Object

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

Methods inherited from interface MetricsRegistry

unregisterMetrics

Constructor Details

PrometheusRegistry

public PrometheusRegistry()

Method Details

start

protected void start()

stop

protected void stop()

registerMetrics

public Set<Object> registerMetrics(Object instance,
 Collection<org.infinispan.commons.stat.MetricInfo> metricInfos,
 String namePrefix,
 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.

namePrefix - 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).

legacy

@Deprecated(forRemoval=true,
            since="16.0")
public boolean legacy()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MetricsRegistry

Same as GlobalMetricsConfiguration.legacy().

Specified by:

legacy in interface MetricsRegistry

Returns:

true if legacy metrics should be exported.

namesAsTags

@Deprecated(forRemoval=true,
            since="16.0")
public boolean namesAsTags()

Deprecated, for removal: This API element is subject to removal in a future version.

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 scraping.

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

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