org.openspaces.admin.alert.config

Class GarbageCollectionAlertConfiguration

java.lang.Object

org.openspaces.admin.alert.config.GarbageCollectionAlertConfiguration

All Implemented Interfaces:

AlertConfiguration, BeanConfig

public class GarbageCollectionAlertConfiguration
extends Object
implements AlertConfiguration

A Garbage Collection pause alert configuration. Specifies the thresholds for triggering an alert. There are two thresholds, long period and short period indicating how long a gc took. The garbage collection alert is raised if the gc took longer than the specified 'long' period. The garbage collection alert is resolved if gc took less than the specified 'short' period.

Since:

8.0

Author:

Moran Avigdor

See Also:

GarbageCollectionAlertConfigurer

Field Summary

Fields

Modifier and Type	Field and Description
static String	LONG_GC_PAUSE_PERIOD_MILLISECONDS_KEY Period of time (in milliseconds) the JVM has spent on garbage collection, for which to raise an alert.
static String	SHORT_GC_PAUSE_PERIOD_MILLISECONDS_KEY Period of time (in milliseconds) the JVM has spent on garbage collection, for which to resolve an alert.

Constructor Summary

Constructors

Constructor and Description
GarbageCollectionAlertConfiguration() Constructs an empty garbage collection pause alert configuration.

Method Summary

Modifier and Type	Method and Description
String	getBeanClassName() The Bean implementation class name corresponding to this BeanConfig.
Long	getLongGcPausePeriod()
Map<String,String>	getProperties() Get the String key-value pairs properties used to configure this bean.
Long	getShortGcPausePeriod()
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setLongGcPausePeriod(long period, TimeUnit timeUnit) Set the period of time a long GC pause alert should be raised for.
void	setProperties(Map<String,String> properties) Set with String key-value pairs to configure properties belonging to this bean.
void	setShortGcPausePeriod(long period, TimeUnit timeUnit) Set the period of time a GC pause alert should be resolved for.

Methods inherited from class java.lang.Object

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

Field Detail

LONG_GC_PAUSE_PERIOD_MILLISECONDS_KEY

public static final String LONG_GC_PAUSE_PERIOD_MILLISECONDS_KEY

Period of time (in milliseconds) the JVM has spent on garbage collection, for which to raise an alert.

See Also:

Constant Field Values

SHORT_GC_PAUSE_PERIOD_MILLISECONDS_KEY

public static final String SHORT_GC_PAUSE_PERIOD_MILLISECONDS_KEY

Period of time (in milliseconds) the JVM has spent on garbage collection, for which to resolve an alert.

See Also:

Constant Field Values

Constructor Detail

GarbageCollectionAlertConfiguration

public GarbageCollectionAlertConfiguration()

Constructs an empty garbage collection pause alert configuration.

Method Detail

setLongGcPausePeriod

public void setLongGcPausePeriod(long period,
                                 TimeUnit timeUnit)

Set the period of time a long GC pause alert should be raised for.

Parameters:

period - period of time spent on GC.

timeUnit - the time unit of the specified period.

getLongGcPausePeriod

public Long getLongGcPausePeriod()

Returns:

the long GC pause period in milliseconds.

setShortGcPausePeriod

public void setShortGcPausePeriod(long period,
                                  TimeUnit timeUnit)

Set the period of time a GC pause alert should be resolved for.

Parameters:

period - period of time spent on GC.

timeUnit - the time unit of the specified period.

getShortGcPausePeriod

public Long getShortGcPausePeriod()

Returns:

the low GC pause period in milliseconds.

setProperties

public void setProperties(Map<String,String> properties)

Set with String key-value pairs to configure properties belonging to this bean. Overrides all previously set properties.

Specified by:

setProperties in interface BeanConfig

Parameters:

properties - the properties to configure this bean object.

getProperties

public Map<String,String> getProperties()

Get the String key-value pairs properties used to configure this bean.

Specified by:

getProperties in interface BeanConfig

Returns:

the properties used to configure this bean object.

getBeanClassName

public String getBeanClassName()

The Bean implementation class name corresponding to this BeanConfig.

Specified by:

getBeanClassName in interface BeanConfig

Returns:

the name of the admin Bean implementation class.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface AlertConfiguration

Returns:

true if this alert is enabled; false if this alert is currently disabled.

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface AlertConfiguration

Parameters:

enabled - true if this alert should be enabled; false if this alert should be disabled.