com.hazelcast.internal.diagnostics

Class DiagnosticsPlugin

java.lang.Object

com.hazelcast.internal.diagnostics.DiagnosticsPlugin

Direct Known Subclasses:

BuildInfoPlugin, ConfigPropertiesPlugin, EventQueuePlugin, InvocationPlugin, MemberHazelcastInstanceInfoPlugin, MemberHeartbeatPlugin, MetricsPlugin, NetworkingImbalancePlugin, OperationHeartbeatPlugin, OverloadedConnectionsPlugin, PendingInvocationsPlugin, SlowOperationPlugin, StoreLatencyPlugin, SystemLogPlugin, SystemPropertiesPlugin

public abstract class DiagnosticsPlugin
extends Object

Plugin for the Diagnostics.

The plugin will not be called concurrently, unless threads are introduced outside of the Diagnostics.

There is a happens before relation between onStart() and run(DiagnosticsLogWriter), and therefor there is no need to make variables volatile. The source of the happens-before relation is the scheduler.queue inside of the Diagnostics or the AtomicReference in case of static plugins.

Field Summary

Fields

Modifier and Type	Field and Description
protected ILogger	logger

Constructor Summary

Constructors

Constructor and Description
DiagnosticsPlugin(ILogger logger)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final ILogger logger

Constructor Detail

DiagnosticsPlugin

public DiagnosticsPlugin(ILogger logger)

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(DiagnosticsLogWriter writer)