com.hazelcast.internal.diagnostics

Class Diagnostics

java.lang.Object

com.hazelcast.internal.diagnostics.Diagnostics

public class Diagnostics
extends Object

The Diagnostics is a debugging tool that provides insight in all kinds of potential performance and stability issues. The actual logic to provide such insights, is placed in the DiagnosticsPlugin.

Field Summary

Fields

Modifier and Type	Field and Description
static HazelcastProperty	DIRECTORY Configures the output directory of the performance log files.
static HazelcastProperty	ENABLED Use the Diagnostics to see internal performance metrics and cluster related information.
static HazelcastProperty	FILENAME_PREFIX Configures the prefix for the diagnostics file.
static HazelcastProperty	INCLUDE_EPOCH_TIME Configures if the epoch time should be included in the 'top' section.
static HazelcastProperty	MAX_ROLLED_FILE_COUNT The DiagnosticsLogFile uses a rolling file approach to prevent eating too much disk space.
static HazelcastProperty	MAX_ROLLED_FILE_SIZE_MB The DiagnosticsLogFile uses a rolling file approach to prevent eating too much disk space.
static HazelcastProperty	METRICS_DISTRIBUTED_DATASTRUCTURES If metrics should be tracked on distributed data structures like IMap, IQueue etc.
static HazelcastProperty	METRICS_LEVEL The minimum level for probes is MANDATORY, but it can be changed to INFO or DEBUG.
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
Diagnostics(String baseFileName, ILogger logger, String hzName, HazelcastProperties properties)

Method Summary

Modifier and Type	Method and Description
File	currentFile()
<P extends DiagnosticsPlugin> P	getPlugin(Class<P> pluginClass) Gets the plugin for a given plugin class.
void	register(DiagnosticsPlugin plugin) Registers a DiagnosticsPlugin.
void	shutdown()
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

METRICS_LEVEL

public static final HazelcastProperty METRICS_LEVEL

The minimum level for probes is MANDATORY, but it can be changed to INFO or DEBUG. A lower level will increase memory usage (probably just a few 100KB) and provides much greater detail on what is going on inside a HazelcastInstance.

By default only mandatory probes are being tracked

METRICS_DISTRIBUTED_DATASTRUCTURES

public static final HazelcastProperty METRICS_DISTRIBUTED_DATASTRUCTURES

If metrics should be tracked on distributed data structures like IMap, IQueue etc.

By default, these data structures are not tracked, but in a future release this will probably be changed to true.

ENABLED

public static final HazelcastProperty ENABLED

Use the Diagnostics to see internal performance metrics and cluster related information.

The performance monitor logs all metrics into the log file.

For more detailed information, please check the METRICS_LEVEL.

The default is false.

MAX_ROLLED_FILE_SIZE_MB

public static final HazelcastProperty MAX_ROLLED_FILE_SIZE_MB

The DiagnosticsLogFile uses a rolling file approach to prevent eating too much disk space.

This property sets the maximum size in MB for a single file.

Every HazelcastInstance will get its own history of log files.

The default is 50.

MAX_ROLLED_FILE_COUNT

public static final HazelcastProperty MAX_ROLLED_FILE_COUNT

The DiagnosticsLogFile uses a rolling file approach to prevent eating too much disk space.

This property sets the maximum number of rolling files to keep on disk.

The default is 10.

INCLUDE_EPOCH_TIME

public static final HazelcastProperty INCLUDE_EPOCH_TIME

Configures if the epoch time should be included in the 'top' section. This makes it easy to determine the time in epoch format and prevents needing to parse the date-format section. The default is false since it will cause more noise.

DIRECTORY

public static final HazelcastProperty DIRECTORY

Configures the output directory of the performance log files.

Defaults to the 'user.dir'.

FILENAME_PREFIX

public static final HazelcastProperty FILENAME_PREFIX

Configures the prefix for the diagnostics file.

So instead of having e.g. 'diagnostics-...log' you get 'foobar-diagnostics-...log'.

Constructor Detail

Diagnostics

public Diagnostics(String baseFileName,
                   ILogger logger,
                   String hzName,
                   HazelcastProperties properties)

Method Detail

currentFile

public File currentFile()

getPlugin

public <P extends DiagnosticsPlugin> P getPlugin(Class<P> pluginClass)

Gets the plugin for a given plugin class. This method should be used if the plugin instance is required within some data-structure outside of the Diagnostics.

Type Parameters:

P - type of the plugin

Parameters:

pluginClass - the class of the DiagnosticsPlugin

Returns:

the DiagnosticsPlugin found, or null if not active

register

public void register(DiagnosticsPlugin plugin)

Registers a DiagnosticsPlugin.

This method is thread-safe.

There is no checking for duplicate registration.

If the Diagnostics is disabled, the call is ignored.

Parameters:

plugin - the plugin to register

Throws:

NullPointerException - if plugin is null

start

public void start()

shutdown

public void shutdown()