GigaSpaces XAP 9.7.2 API

org.openspaces.admin.alert.config
Class PhysicalMemoryUtilizationAlertConfigurer

java.lang.Object
  extended by org.openspaces.admin.alert.config.PhysicalMemoryUtilizationAlertConfigurer
All Implemented Interfaces:
AlertConfigurer, BeanConfigurer<AlertConfiguration>

public class PhysicalMemoryUtilizationAlertConfigurer
extends Object
implements AlertConfigurer

A physical memory 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 memory reading. The memory utilization alert is raised if any discovered machine is above the specified physical memory threshold for a period of time. The memory utilization alert is resolved if its physical memory reading goes below the specified memory threshold for a period of time.

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

Since:
8.0
Author:
Moran Avigdor
See Also:
PhysicalMemoryUtilizationAlertConfiguration

Constructor Summary
PhysicalMemoryUtilizationAlertConfigurer()
          Constructs an empty machine physical memory utilization alert configuration.
 
Method Summary
 PhysicalMemoryUtilizationAlertConfiguration create()
          Get a fully configured physical memory utilization configuration (after all properties have been set).
 PhysicalMemoryUtilizationAlertConfigurer enable(boolean enabled)
          Enable an alert using this configuration.
 PhysicalMemoryUtilizationAlertConfigurer measurementPeriod(long period, TimeUnit timeUnit)
          Set the period of time a physical memory alert should be triggered if it's reading is above/below the threshold setting.
 PhysicalMemoryUtilizationAlertConfigurer raiseAlertIfMemoryAbove(int highThreshold)
          Raise an alert if physical memory is above the specified threshold for a period of time.
 PhysicalMemoryUtilizationAlertConfigurer resolveAlertIfMemoryBelow(int lowThreshold)
          Resolve the previously raised alert if physical memory 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

PhysicalMemoryUtilizationAlertConfigurer

public PhysicalMemoryUtilizationAlertConfigurer()
Constructs an empty machine physical memory utilization alert configuration.

Method Detail

enable

public PhysicalMemoryUtilizationAlertConfigurer 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)

raiseAlertIfMemoryAbove

public PhysicalMemoryUtilizationAlertConfigurer raiseAlertIfMemoryAbove(int highThreshold)
Raise an alert if physical memory is 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:
PhysicalMemoryUtilizationAlertConfiguration.setHighThresholdPerc(int)

resolveAlertIfMemoryBelow

public PhysicalMemoryUtilizationAlertConfigurer resolveAlertIfMemoryBelow(int lowThreshold)
Resolve the previously raised alert if physical memory 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:
PhysicalMemoryUtilizationAlertConfiguration.setLowThresholdPerc(int)

measurementPeriod

public PhysicalMemoryUtilizationAlertConfigurer measurementPeriod(long period,
                                                                  TimeUnit timeUnit)
Set the period of time a physical 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 PhysicalMemoryUtilizationAlertConfiguration create()
Get a fully configured physical memory utilization configuration (after all properties have been set).

Specified by:
create in interface BeanConfigurer<AlertConfiguration>
Returns:
a fully configured alert bean configuration.

GigaSpaces XAP 9.7.2 API

Copyright © GigaSpaces.