com.neeve.stats

Interface IStatsAlert

public interface IStatsAlert

Represents a statistics alert. An IStatsAlert is raised either in response to a threshold being violated or the abatement of a previously violated threshold.

Threading:

A stats alert is safe for access by multiple threads, though the objects it returns may not be.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IStatsAlert.Type The type of the alert being raised.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getMetricAlertThreshold()
String	getMetricName()
Object	getMetricValue()
IStats	getSource()
IStatsAlert.Type	getType() The type of the alert either IStatsAlert.Type.Abated to indicate that the metric no longer violates the Threshold criteria or indicates that it is either IStatsAlert.Type.AboveThreshold or IStatsAlert.Type.BelowThreshold

Method Detail

getSource

IStats getSource()

Returns:

Gets the source of the alert.

getMetricName

String getMetricName()

Returns:

The name of the metric associated with the alert

getMetricValue

Object getMetricValue()

Returns:

The value of the metric.

getMetricAlertThreshold

Object getMetricAlertThreshold()

Returns:

The threshold for triggering the alert

getType

IStatsAlert.Type getType()

The type of the alert either IStatsAlert.Type.Abated to indicate that the metric no longer violates the Threshold criteria or indicates that it is either IStatsAlert.Type.AboveThreshold or IStatsAlert.Type.BelowThreshold

Returns:

The type of the alert