org.openspaces.admin.alert

Interface Alert

All Superinterfaces:

Externalizable, Serializable

All Known Subinterfaces:

InternalAlert

All Known Implementing Classes:

AbstractAlert, CpuUtilizationAlert, DefaultAlert, ElasticAutoScalingAlert, ElasticGridServiceAgentProvisioningAlert, ElasticGridServiceContainerProvisioningAlert, ElasticMachineProvisioningAlert, GarbageCollectionAlert, HeapMemoryUtilizationAlert, MirrorPersistenceFailureAlert, PhysicalMemoryUtilizationAlert, ProcessingUnitInstanceMemberAliveIndicatorAlert, ProvisionFailureAlert, ReplicationChannelDisconnectedAlert, ReplicationRedoLogOverflowToDiskAlert, ReplicationRedoLogSizeAlert, SpacePartitionSplitBrainAlert

public interface Alert
extends Externalizable

An interface representing an alert issued by an alert bean or an alert provider.

An alert has a unique alert id (getAlertUid()) and is fired by one of the alert beans, and aggregated with other alerts of the same (getGroupUid()).

An unresolved alert is an alert that indicates a problematic situation that needs attention. An alert bean can trigger more than one unresolved alert if the problem persists (with the same alert group UID). A resolved alert (AlertStatus.RESOLVED) is an alert that indicates that the situation was resolved, or is no longer in need of attention.

Each alert has descriptive information of the alert (getDescription()), data and time of the alert (getTimestamp()), and configuration properties together with runtime properties the alert bean exposes (see getProperties()).

The source component for which the alert was triggered (see getComponentUid()) can be correlated to one of the components using the Admin.getGridComponentByUID(String) if this component has not yet been terminated.

Since:

8.0

Author:

Moran Avigdor

Method Summary

Modifier and Type	Method and Description
String	getAlertUid()
String	getComponentDescription() Description of the component: host - [Host IP] GSC - [GSC Name] on [Host IP] LUS - LUS on [Host IP] GSM - GSM on [Host IP] PU instance - [PU name] [Partition number] [Primary or backup] on [Host IP] Mirror - Mirror on [Host IP] EDS - EDS on [Host IP]
String	getComponentUid()
Map<String,String>	getConfig()
String	getDescription()
String	getGroupUid()
String	getName()
Map<String,String>	getProperties()
AlertSeverity	getSeverity()
AlertStatus	getStatus()
long	getTimestamp()

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getName

String getName()

Returns:

Alert Name - the name assigned to the alert.

getDescription

String getDescription()

Returns:

Description - a description of the alert.

getTimestamp

long getTimestamp()

Returns:

Timestamp - the date and time the alert occurred.

getSeverity

AlertSeverity getSeverity()

Returns:

Severity - the defined severity of the alert.

getStatus

AlertStatus getStatus()

Returns:

Status - the status of the alert.

getAlertUid

String getAlertUid()

Returns:

Alert UID - the unique identification for this alert.

getGroupUid

String getGroupUid()

Returns:

Group UID - the unique identification of the group this alert belongs to.

getComponentUid

String getComponentUid()

Returns:

Component UID - the unique identifier of the component associated with the alert.

getComponentDescription

String getComponentDescription()

Description of the component:

• host - [Host IP]
• GSC - [GSC Name] on [Host IP]
• LUS - LUS on [Host IP]
• GSM - GSM on [Host IP]
• PU instance - [PU name] [Partition number] [Primary or backup] on [Host IP]
• Mirror - Mirror on [Host IP]
• EDS - EDS on [Host IP]

Returns:

Component Description - the description of the component specified by the getComponentUid().

Since:

8.0.1

getConfig

Map<String,String> getConfig()

Returns:

A map of String key-value property pairs of the configuration properties used to configure the alert bean.

getProperties

Map<String,String> getProperties()

Returns:

A map of String key-value property pairs of any runtime properties exposed by the alert bean.