com.hazelcast.internal.metrics.impl

Class MetricsRegistryImpl

java.lang.Object

com.hazelcast.internal.metrics.impl.MetricsRegistryImpl

All Implemented Interfaces:

MetricsRegistry

public class MetricsRegistryImpl
extends Object
implements MetricsRegistry

The MetricsRegistry implementation.

Constructor Summary

Constructors

Constructor and Description
MetricsRegistryImpl(ILogger logger, ProbeLevel minimumLevel) Creates a MetricsRegistryImpl instance.
MetricsRegistryImpl(String name, ILogger logger, ProbeLevel minimumLevel) Creates a MetricsRegistryImpl instance.

Method Summary

Modifier and Type	Method and Description
void	collectMetrics(Object... objects) For each object that implements MetricsProvider the MetricsProvider.provideMetrics(MetricsRegistry) is called.
<S> void	deregister(S source) Deregisters all probes for a given source object.
void	discardMetrics(Object... objects) For each object that implements DiscardableMetricsProvider the DiscardableMetricsProvider.discardMetrics(MetricsRegistry) is called.
Set<String>	getNames() Gets a set of all current probe names.
ProbeLevel	minimumLevel() Returns the minimum ProbeLevel this MetricsRegistry is recording.
DoubleGauge	newDoubleGauge(String name) Creates a DoubleGauge for a given metric name.
com.hazelcast.internal.metrics.impl.LongGaugeImpl	newLongGauge(String name) Creates a LongGauge for a given metric name.
ProbeBuilder	newProbeBuilder() Creates a new ProbeBuilder.
<S> void	register(S source, String name, ProbeLevel level, DoubleProbeFunction<S> function) Registers a probe.
<S> void	register(S source, String name, ProbeLevel level, LongProbeFunction<S> function) Registers a probe.
void	render(ProbeRenderer renderer) Renders the content of the MetricsRegistry.
<S> void	scanAndRegister(S source, String namePrefix) Scans the source object for any fields/methods that have been annotated with Probe annotation, and registers these fields/methods as probe instances.
void	scheduleAtFixedRate(Runnable publisher, long period, TimeUnit timeUnit, ProbeLevel probeLevel) Schedules a publisher to be executed at a fixed rate.
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsRegistryImpl

public MetricsRegistryImpl(ILogger logger,
                           ProbeLevel minimumLevel)

Creates a MetricsRegistryImpl instance.

Parameters:

logger - the ILogger used

minimumLevel - the minimum ProbeLevel. If a probe is registered with a ProbeLevel lower than the minimum ProbeLevel, then the registration is skipped.

Throws:

NullPointerException - if logger or minimumLevel is null

MetricsRegistryImpl

public MetricsRegistryImpl(String name,
                           ILogger logger,
                           ProbeLevel minimumLevel)

Creates a MetricsRegistryImpl instance.

Parameters:

name - Name of the registry

logger - the ILogger used

minimumLevel - the minimum ProbeLevel. If a probe is registered with a ProbeLevel lower than the minimum ProbeLevel, then the registration is skipped.

Throws:

NullPointerException - if logger or minimumLevel is null

Method Detail

minimumLevel

public ProbeLevel minimumLevel()

Description copied from interface: MetricsRegistry

Returns the minimum ProbeLevel this MetricsRegistry is recording.

Specified by:

minimumLevel in interface MetricsRegistry

getNames

public Set<String> getNames()

Description copied from interface: MetricsRegistry

Gets a set of all current probe names. The returned set is immutable and is a snapshot of the names. So the reader gets a stable view on the names.

Specified by:

getNames in interface MetricsRegistry

Returns:

set of all current names.

scanAndRegister

public <S> void scanAndRegister(S source,
                                String namePrefix)

Description copied from interface: MetricsRegistry

Scans the source object for any fields/methods that have been annotated with Probe annotation, and registers these fields/methods as probe instances.

If a probe is called 'queueSize' and the namePrefix is 'operations', then the name of the probe instance is 'operations.queueSize'.

If a probe with the same name already exists, then the probe is replaced.

If an object has no @Probe annotations, the call is ignored.

Specified by:

scanAndRegister in interface MetricsRegistry

Parameters:

source - the object to scan.

namePrefix - the name prefix.

register

public <S> void register(S source,
                         String name,
                         ProbeLevel level,
                         LongProbeFunction<S> function)

Description copied from interface: MetricsRegistry

Registers a probe. If a probe for the given name exists, it will be overwritten.

Specified by:

register in interface MetricsRegistry

name - the name of the probe.

level - the ProbeLevel

function - the probe

register

public <S> void register(S source,
                         String name,
                         ProbeLevel level,
                         DoubleProbeFunction<S> function)

Description copied from interface: MetricsRegistry

Registers a probe. If a probe for the given name exists, it will be overwritten.

Specified by:

register in interface MetricsRegistry

name - the name of the probe

level - the ProbeLevel

function - the probe

newLongGauge

public com.hazelcast.internal.metrics.impl.LongGaugeImpl newLongGauge(String name)

Description copied from interface: MetricsRegistry

Creates a LongGauge for a given metric name. If no gauge exists for the name, it will be created but no probe is set. The reason to do so is that you don't want to depend on the order of registration. Perhaps you want to read out e.g. operations.count gauge, but the OperationService has not started yet and the metric is not yet available. Another cause is that perhaps a probe is not registered, but the metric is created. For example when experimenting with a new implementation, e.g. a new OperationService implementation, that doesn't provide the operation.count probe. Multiple calls with the same name return different Gauge instances; so the Gauge instance is not cached. This is done to prevent memory leaks.

Specified by:

newLongGauge in interface MetricsRegistry

Parameters:

name - the name of the metric.

Returns:

the created LongGauge.

newDoubleGauge

public DoubleGauge newDoubleGauge(String name)

Description copied from interface: MetricsRegistry

Creates a DoubleGauge for a given metric name.

Specified by:

newDoubleGauge in interface MetricsRegistry

Parameters:

name - name of the metric

Returns:

the create DoubleGauge

See Also:

MetricsRegistry.newLongGauge(String)

deregister

public <S> void deregister(S source)

Description copied from interface: MetricsRegistry

Deregisters all probes for a given source object. If the object already is deregistered, the call is ignored. If the object was never registered, the call is ignored.

Specified by:

deregister in interface MetricsRegistry

Parameters:

source - the object to deregister. If called with null, then ignored.

render

public void render(ProbeRenderer renderer)

Description copied from interface: MetricsRegistry

Renders the content of the MetricsRegistry.

Specified by:

render in interface MetricsRegistry

Parameters:

renderer - the ProbeRenderer

collectMetrics

public void collectMetrics(Object... objects)

Description copied from interface: MetricsRegistry

For each object that implements MetricsProvider the MetricsProvider.provideMetrics(MetricsRegistry) is called.

Specified by:

collectMetrics in interface MetricsRegistry

Parameters:

objects - the array of objects to initialize.

discardMetrics

public void discardMetrics(Object... objects)

Description copied from interface: MetricsRegistry

For each object that implements DiscardableMetricsProvider the DiscardableMetricsProvider.discardMetrics(MetricsRegistry) is called.

Specified by:

discardMetrics in interface MetricsRegistry

Parameters:

objects - the array of objects to check.

scheduleAtFixedRate

public void scheduleAtFixedRate(Runnable publisher,
                                long period,
                                TimeUnit timeUnit,
                                ProbeLevel probeLevel)

Description copied from interface: MetricsRegistry

Schedules a publisher to be executed at a fixed rate. Probably this method will be removed in the future, but we need a mechanism for complex gauges that require some calculation to provide their values.

Specified by:

scheduleAtFixedRate in interface MetricsRegistry

Parameters:

publisher - the published task that needs to be executed

period - the time between executions

timeUnit - the time unit for period

probeLevel - the ProbeLevel publisher it publishing on. This is needed to prevent scheduling publishers if their probe level isn't sufficient.

shutdown

public void shutdown()

newProbeBuilder

public ProbeBuilder newProbeBuilder()

Description copied from interface: MetricsRegistry

Creates a new ProbeBuilder.

Specified by:

newProbeBuilder in interface MetricsRegistry