org.openspaces.admin.alert.config

Class HeapMemoryUtilizationAlertConfigurer

java.lang.Object

org.openspaces.admin.alert.config.HeapMemoryUtilizationAlertConfigurer

All Implemented Interfaces:

AlertConfigurer, BeanConfigurer<AlertConfiguration>

public class HeapMemoryUtilizationAlertConfigurer
extends Object
implements AlertConfigurer

A heap utilization alert configurer. 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.

Use the call to create() to create a fully initialized HeapMemoryUtilizationAlertConfiguration configuration.

Since:

8.0

Author:

Moran Avigdor

See Also:

HeapMemoryUtilizationAlertConfiguration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HeapMemoryUtilizationAlertConfiguration	create() Get a fully configured heap memory utilization configuration (after all properties have been set).
HeapMemoryUtilizationAlertConfigurer	enable(boolean enabled) Enable an alert using this configuration.
HeapMemoryUtilizationAlertConfigurer	measurementPeriod(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.
HeapMemoryUtilizationAlertConfigurer	raiseAlertIfHeapAbove(int highThreshold) Raise an alert if heap utilization if above the specified threshold for a period of time.
HeapMemoryUtilizationAlertConfigurer	resolveAlertIfHeapBelow(int lowThreshold) Resolve the previously raised alert if heap utilization goes below the specified threshold for a period of time.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapMemoryUtilizationAlertConfigurer

public HeapMemoryUtilizationAlertConfigurer()

Constructs an empty heap memory utilization alert configuration.

Method Detail

enable

public HeapMemoryUtilizationAlertConfigurer enable(boolean enabled)

Description copied from interface: AlertConfigurer

Enable an alert using this configuration. By default an alert is disabled.

Specified by:

enable in interface AlertConfigurer

Parameters:

enabled - true to enable the alert using this configuration; false to disable the alert.

Returns:

this.

See Also:

AlertConfiguration.setEnabled(boolean)

raiseAlertIfHeapAbove

public HeapMemoryUtilizationAlertConfigurer raiseAlertIfHeapAbove(int highThreshold)

Raise an alert if heap utilization if above the specified threshold for a period of time. The period of time is configured using measurementPeriod(long, TimeUnit).

Parameters:

highThreshold - high threshold percentage.

Returns:

this.

See Also:

HeapMemoryUtilizationAlertConfiguration.setHighThresholdPerc(int)

resolveAlertIfHeapBelow

public HeapMemoryUtilizationAlertConfigurer resolveAlertIfHeapBelow(int lowThreshold)

Resolve the previously raised alert if heap utilization goes below the specified threshold for a period of time. The period of time is configured using measurementPeriod(long, TimeUnit).

Parameters:

lowThreshold - low threshold percentage.

Returns:

this.

See Also:

HeapMemoryUtilizationAlertConfiguration.setLowThresholdPerc(int)

measurementPeriod

public HeapMemoryUtilizationAlertConfigurer measurementPeriod(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.

Returns:

this.

create

public HeapMemoryUtilizationAlertConfiguration create()

Get a fully configured heap memory utilization configuration (after all properties have been set).

Specified by:

create in interface BeanConfigurer<AlertConfiguration>

Returns:

a fully configured alert bean configuration.