com.hazelcast.internal.diagnostics

Class SystemLogPlugin

java.lang.Object

com.hazelcast.internal.diagnostics.DiagnosticsPlugin

com.hazelcast.internal.diagnostics.SystemLogPlugin

public class SystemLogPlugin
extends DiagnosticsPlugin

The SystemLogPlugin is responsible for:

1. Showing lifecycle changes like shutting down, merging etc.
2. Show connection creation and connection closing. Also the causes of closes are included.
3. Showing membership changes.
4. Optionally showing partition migration

This plugin is very useful to get an idea what is happening inside a cluster; especially when there are connection related problems.

This plugin has a low overhead and is meant to run in production.

Field Summary

Fields

Modifier and Type	Field and Description
static HazelcastProperty	ENABLED If this plugin is enabled.
static HazelcastProperty	LOG_PARTITIONS If logging partition migration is enabled.

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

logger

Constructor Summary

Constructors

Constructor and Description
SystemLogPlugin(HazelcastProperties properties, ConnectionListenable connectionObservable, HazelcastInstance hazelcastInstance, ILogger logger)
SystemLogPlugin(HazelcastProperties properties, ConnectionListenable connectionObservable, HazelcastInstance hazelcastInstance, ILogger logger, NodeExtension nodeExtension)
SystemLogPlugin(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

ENABLED

public static final HazelcastProperty ENABLED

If this plugin is enabled.

LOG_PARTITIONS

public static final HazelcastProperty LOG_PARTITIONS

If logging partition migration is enabled. Because there can be so many partitions, logging the partition migration can be very noisy.

Constructor Detail

SystemLogPlugin

public SystemLogPlugin(NodeEngineImpl nodeEngine)

SystemLogPlugin

public SystemLogPlugin(HazelcastProperties properties,
                       ConnectionListenable connectionObservable,
                       HazelcastInstance hazelcastInstance,
                       ILogger logger)

SystemLogPlugin

public SystemLogPlugin(HazelcastProperties properties,
                       ConnectionListenable connectionObservable,
                       HazelcastInstance hazelcastInstance,
                       ILogger logger,
                       NodeExtension nodeExtension)

Method Detail

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.

onStart

public void onStart()

Specified by:

onStart in class DiagnosticsPlugin

run

public void run(DiagnosticsLogWriter writer)

Specified by:

run in class DiagnosticsPlugin