GigaSpaces XAP 10.0.1 API

org.openspaces.admin.alert.alerts
Class HeapMemoryUtilizationAlert

java.lang.Object
  extended by org.openspaces.admin.alert.alerts.AbstractAlert
      extended by org.openspaces.admin.alert.alerts.HeapMemoryUtilizationAlert
All Implemented Interfaces:
Externalizable, Serializable, Alert

public class HeapMemoryUtilizationAlert
extends AbstractAlert

A heap memory utilization alert, fired upon triggered JVM heap-memory thresholds. The alert is raised when heap memory crosses a 'high' threshold for a specified period of time. The alert is resolved when heap-memory crosses a 'low' threshold for a specified period of time.

These thresholds can be configured by using the HeapMemoryUtilizationAlertConfigurer.

This alert will be received on the call to AlertTriggeredEventListener.alertTriggered(Alert) for registered listeners.

Since:
8.0
Author:
Moran Avigdor
See Also:
Serialized Form

Field Summary
static String COMPONENT_NAME
           
static String CPU_UTILIZATION
           
static String HEAP_UTILIZATION
           
static String HOST_ADDRESS
           
static String HOST_NAME
           
static String MAX_HEAP_IN_BYTES
           
static String PROCESS_ID
           
 
Constructor Summary
HeapMemoryUtilizationAlert()
          required by java.io.Externalizable
HeapMemoryUtilizationAlert(Alert alert)
           
 
Method Summary
 String getComponentName()
          The name of the component for which the alert was fired (e.g.
 String getComponentUid()
           The component UID is equivalent to VirtualMachine.getUid()
 Double getCpuUtilization()
          The CPU utilization reading when this alert was fired.
 Double getHeapUtilization()
          The Heap utilization reading when this alert was fired.
 String getHostAddress()
          The host address of the machine that this alert corresponds to.
 String getHostName()
          The host name of the machine that this alert corresponds to.
 Long getMaxHeapInBytes()
          The maximum amount of memory in bytes that can be used for memory management.
 String getProcessId()
          The process id of the component for which the alert was fired.
 
Methods inherited from class org.openspaces.admin.alert.alerts.AbstractAlert
getAlert, getAlertUid, getComponentDescription, getConfig, getDescription, getGroupUid, getName, getProperties, getSeverity, getStatus, getTimestamp, readExternal, toString, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

HOST_ADDRESS

public static final String HOST_ADDRESS
See Also:
Constant Field Values

HOST_NAME

public static final String HOST_NAME
See Also:
Constant Field Values

CPU_UTILIZATION

public static final String CPU_UTILIZATION
See Also:
Constant Field Values

PROCESS_ID

public static final String PROCESS_ID
See Also:
Constant Field Values

COMPONENT_NAME

public static final String COMPONENT_NAME
See Also:
Constant Field Values

HEAP_UTILIZATION

public static final String HEAP_UTILIZATION
See Also:
Constant Field Values

MAX_HEAP_IN_BYTES

public static final String MAX_HEAP_IN_BYTES
See Also:
Constant Field Values
Constructor Detail

HeapMemoryUtilizationAlert

public HeapMemoryUtilizationAlert()
required by java.io.Externalizable


HeapMemoryUtilizationAlert

public HeapMemoryUtilizationAlert(Alert alert)
Method Detail

getComponentUid

public String getComponentUid()
The component UID is equivalent to VirtualMachine.getUid()

Specified by:
getComponentUid in interface Alert
Overrides:
getComponentUid in class AbstractAlert
Returns:
Component UID - the unique identifier of the component associated with the alert.

getHostAddress

public String getHostAddress()
The host address of the machine that this alert corresponds to.

Returns:
the host address; may be null.

getHostName

public String getHostName()
The host name of the machine that this alert corresponds to.

Returns:
the host name; may be null.

getCpuUtilization

public Double getCpuUtilization()
The CPU utilization reading when this alert was fired.

Returns:
the CPU utilization; may be null.

getProcessId

public String getProcessId()
The process id of the component for which the alert was fired.

Returns:
the process id (pid); may be null.

getComponentName

public String getComponentName()
The name of the component for which the alert was fired (e.g. 'Grid Service Agent', 'Grid Service Manager', 'Grid Service Container', 'Lookup Service').

Returns:
the name of the component.

getHeapUtilization

public Double getHeapUtilization()
The Heap utilization reading when this alert was fired.

Returns:
the Heap utilization; may be null.

getMaxHeapInBytes

public Long getMaxHeapInBytes()
The maximum amount of memory in bytes that can be used for memory management. This method returns -1 if the maximum memory size (-Xmx) is undefined.

Returns:
the Heap utilization; may be null.

GigaSpaces XAP 10.0.1 API

Copyright © GigaSpaces.