GigaSpaces XAP 9.0 API

org.openspaces.admin.alert.config
Class CpuUtilizationAlertConfigurer

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

public class CpuUtilizationAlertConfigurer
extends Object
implements AlertConfigurer

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

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

Since:
8.0
Author:
Moran Avigdor
See Also:
CpuUtilizationAlertConfiguration

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

CpuUtilizationAlertConfigurer

public CpuUtilizationAlertConfigurer()
Constructs an empty machine CPU utilization alert configuration.

Method Detail

enable

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

raiseAlertIfCpuAbove

public CpuUtilizationAlertConfigurer raiseAlertIfCpuAbove(int highThreshold)
Raise an alert if the CPU reading 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:
CpuUtilizationAlertConfiguration.setHighThresholdPerc(int)

resolveAlertIfCpuBelow

public CpuUtilizationAlertConfigurer resolveAlertIfCpuBelow(int lowThreshold)
Resolve the previously raised alert if CPU is 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:
CpuUtilizationAlertConfiguration.setLowThresholdPerc(int)

measurementPeriod

public CpuUtilizationAlertConfigurer measurementPeriod(long period,
                                                       TimeUnit timeUnit)
Set the period of time a CPU 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 CpuUtilizationAlertConfiguration create()
Get a fully configured machine CPU 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.0 API

Copyright © GigaSpaces.