com.hazelcast.internal.monitors

Class PerformanceMonitorPlugin

java.lang.Object

com.hazelcast.internal.monitors.PerformanceMonitorPlugin

Direct Known Subclasses:

BuildInfoPlugin, ConfigPropertiesPlugin, MetricsPlugin, OverloadedConnectionsPlugin, PendingInvocationsPlugin, SlowOperationPlugin, SystemPropertiesPlugin

public abstract class PerformanceMonitorPlugin
extends Object

A Plugin for the PerformanceMonitor. The plugin will not be called concurrently, unless threads are introduced outside of the PerformanceMonitor. There is a happens before relation between onStart() and run(PerformanceLogWriter), and therefor there is no need to make variables volatile. The source of the happens-before relation is the scheduler.queue inside of the PerformanceMonitor or the AtomicReference in case of static plugins.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	DISABLED Indicates that the plugin is disabled.
protected static long	STATIC Indicates that a plugin should be run once per performance log file.

Constructor Summary

Constructors

Constructor and Description
PerformanceMonitorPlugin()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

STATIC

protected static final long STATIC

Indicates that a plugin should be run once per performance log file.

See Also:

Constant Field Values

DISABLED

protected static final long DISABLED

Indicates that the plugin is disabled.

See Also:

Constant Field Values

Constructor Detail

PerformanceMonitorPlugin

public PerformanceMonitorPlugin()

Method Detail

getPeriodMillis

public abstract long getPeriodMillis()

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.

Returns:

the period in millis.

onStart

public abstract void onStart()

run

public abstract void run(PerformanceLogWriter writer)