Class CacheMetricsRegistration

java.lang.Object

org.infinispan.metrics.impl.CacheMetricsRegistration

All Implemented Interfaces:

Constants

public final class CacheMetricsRegistration
extends Object

Creates and registers metrics for all components from a cache's component registry.

Since:

10.1.3

Author:

anistor@redhat.com

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
CacheMetricsRegistration()

Method Summary

Modifier and Type	Method	Description
protected String	initLegacyNamePrefix()	Deprecated, for removal: This API element is subject to removal in a future version.
protected Set<Object>	internalRegisterMetrics(Object instance, Collection<org.infinispan.commons.stat.MetricInfo> metrics, String metricPrefix)
boolean	metricsEnabled()
Set<Object>	registerExternalMetrics(Object instance, String prefix)	Register metrics for a component that was manually registered later, after component registry startup.
void	registerMetrics(Object instance, String type, String componentName)	Register metrics for a component that was manually registered later, after component registry startup.
protected void	start()
protected void	stop()
void	unregisterMetrics(Set<Object> metricIds)

Methods inherited from class Object

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

Constructor Details

CacheMetricsRegistration

public CacheMetricsRegistration()

Method Details

metricsEnabled

public boolean metricsEnabled()

initLegacyNamePrefix

@Deprecated(forRemoval=true,
            since="16.0")
protected String initLegacyNamePrefix()

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

Subclasses should override this and return the metric prefix to be used for registration. This is invoked only if metrics are enabled.

internalRegisterMetrics

protected Set<Object> internalRegisterMetrics(Object instance,
 Collection<org.infinispan.commons.stat.MetricInfo> metrics,
 String metricPrefix)

start

protected void start()

stop

protected void stop()

registerMetrics

public void registerMetrics(Object instance,
 String type,
 String componentName)

Register metrics for a component that was manually registered later, after component registry startup. The metric ids will be tracked and unregistration will be performed automatically on stop.

registerExternalMetrics

public Set<Object> registerExternalMetrics(Object instance,
 String prefix)

Register metrics for a component that was manually registered later, after component registry startup. The metric ids will NOT be tracked and unregistration will NOT be performed automatically on stop.

unregisterMetrics

public void unregisterMetrics(Set<Object> metricIds)