com.hazelcast.internal.diagnostics

Class MetricsPlugin

java.lang.Object

com.hazelcast.internal.diagnostics.DiagnosticsPlugin

com.hazelcast.internal.diagnostics.MetricsPlugin

public class MetricsPlugin
extends DiagnosticsPlugin

A DiagnosticsPlugin that displays the content of the MetricsRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
static HazelcastProperty	PERIOD_SECONDS The period in seconds the MetricsPlugin runs.

Fields inherited from class com.hazelcast.internal.diagnostics.DiagnosticsPlugin

logger

Constructor Summary

Constructors

Constructor and Description
MetricsPlugin(ILogger logger, MetricsRegistry metricsRegistry, HazelcastProperties properties)
MetricsPlugin(NodeEngineImpl nodeEngine)

Method Summary

Modifier and Type	Method and Description
long	getPeriodMillis() Returns the period of executing the monitor in millis.
void	onStart()
void	run(DiagnosticsLogWriter writer)

Methods inherited from class java.lang.Object

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

Field Detail

PERIOD_SECONDS

public static final HazelcastProperty PERIOD_SECONDS

The period in seconds the MetricsPlugin runs.

The MetricsPlugin periodically writes the contents of the MetricsRegistry to the logfile. For debugging purposes make sure the Diagnostics.METRICS_LEVEL is set to debug.

This plugin is very cheap to use.

If set to 0, the plugin is disabled.

Constructor Detail

MetricsPlugin

public MetricsPlugin(NodeEngineImpl nodeEngine)

MetricsPlugin

public MetricsPlugin(ILogger logger,
                     MetricsRegistry metricsRegistry,
                     HazelcastProperties properties)

Method Detail

onStart

public void onStart()

Specified by:

onStart in class DiagnosticsPlugin

getPeriodMillis

public long getPeriodMillis()

Description copied from class: DiagnosticsPlugin

Returns the period of executing the monitor in millis.

If a monitor is disabled, 0 is returned.

If a monitor should run only once, a negative value is returned. This is useful for 'static' monitors like the SystemPropertiesPlugin that run at the beginning of a log file but their contents will not change.

Specified by:

getPeriodMillis in class DiagnosticsPlugin

Returns:

the period in millis.

run

public void run(DiagnosticsLogWriter writer)

Specified by:

run in class DiagnosticsPlugin