org.openspaces.admin.alert.config

Class HeapMemoryUtilizationAlertConfiguration

java.lang.Object

org.openspaces.admin.alert.config.HeapMemoryUtilizationAlertConfiguration

All Implemented Interfaces:

AlertConfiguration, BeanConfig

public class HeapMemoryUtilizationAlertConfiguration
extends Object
implements AlertConfiguration

A heap utilization alert configuration. Specifies the thresholds for triggering an alert. There are two thresholds, high and low and a measurement period indicating a window for the heap reading. The heap utilization alert is raised if any discovered JVM is above the specified heap threshold for a period of time. The heap utilization alert is resolved if its heap goes below the specified heap threshold for a period of time.

Since:

8.0

Author:

Moran Avigdor

See Also:

HeapMemoryUtilizationAlertConfigurer

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIGH_THRESHOLD_PERC_KEY High threshold for which to trigger an alert which needs resolution.
static String	LOW_THRESHOLD_PERC_KEY Low threshold for which to resolve a previously triggered high heap memory alert.
static String	MEASUREMENT_PERIOD_MILLISECONDS_KEY Period of time (in milliseconds) the JVM heap memory is above/below a certain threshold to trigger an alert.

Constructor Summary

Constructors

Constructor and Description
HeapMemoryUtilizationAlertConfiguration() Constructs an empty heap memory utilization alert configuration.

Method Summary

Modifier and Type	Method and Description
String	getBeanClassName() The Bean implementation class name corresponding to this BeanConfig.
Integer	getHighThresholdPerc()
Integer	getLowThresholdPerc()
Long	getMeasurementPeriod()
Map<String,String>	getProperties() Get the String key-value pairs properties used to configure this bean.
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setHighThresholdPerc(int highThreshold) Set the heap memory high threshold percentage value.
void	setLowThresholdPerc(int lowThreshold) Set the heap memory low threshold percentage value.
void	setMeasurementPeriod(long period, TimeUnit timeUnit) Set the period of time a heap memory alert should be triggered if it's reading is above/below the threshold setting.
void	setProperties(Map<String,String> properties) Set with String key-value pairs to configure properties belonging to this bean.

Methods inherited from class java.lang.Object

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

Field Detail

MEASUREMENT_PERIOD_MILLISECONDS_KEY

public static final String MEASUREMENT_PERIOD_MILLISECONDS_KEY

Period of time (in milliseconds) the JVM heap memory is above/below a certain threshold to trigger an alert.

See Also:

Constant Field Values

LOW_THRESHOLD_PERC_KEY

public static final String LOW_THRESHOLD_PERC_KEY

Low threshold for which to resolve a previously triggered high heap memory alert. An alert will be triggered if heap memory goes below this threshold for a certain period of time.

See Also:

Constant Field Values

HIGH_THRESHOLD_PERC_KEY

public static final String HIGH_THRESHOLD_PERC_KEY

High threshold for which to trigger an alert which needs resolution. An alert will be triggered if heap memory goes above this threshold for a certain period of time.

See Also:

Constant Field Values

Constructor Detail

HeapMemoryUtilizationAlertConfiguration

public HeapMemoryUtilizationAlertConfiguration()

Constructs an empty heap memory utilization alert configuration.

Method Detail

setHighThresholdPerc

public void setHighThresholdPerc(int highThreshold)

Set the heap memory high threshold percentage value.

Parameters:

highThreshold - high threshold percentage.

getHighThresholdPerc

public Integer getHighThresholdPerc()

Returns:

the heap memory high threshold percentage.

setLowThresholdPerc

public void setLowThresholdPerc(int lowThreshold)

Set the heap memory low threshold percentage value.

Parameters:

lowThreshold - low threshold percentage.

getLowThresholdPerc

public Integer getLowThresholdPerc()

Returns:

the heap memory low threshold percentage.

setMeasurementPeriod

public void setMeasurementPeriod(long period,
                                 TimeUnit timeUnit)

Set the period of time a heap memory alert should be triggered if it's reading is above/below the threshold setting.

Parameters:

period - period of time.

timeUnit - the time unit of the specified period.

getMeasurementPeriod

public Long getMeasurementPeriod()

Returns:

the measurement 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.