org.hawkular.alerts.api.model.condition

Class RateCondition

java.lang.Object

org.hawkular.alerts.api.model.condition.Condition

org.hawkular.alerts.api.model.condition.RateCondition

All Implemented Interfaces:

Serializable

public class RateCondition
extends Condition

A threshold condition against rate of change over time. Typically used for "counter" metrics, that continuously increase or decrease. Given the last two datums for dataId:

   deltaTime   = datum.time - prevDatum.time
   deltaValue  = datum.value - prevData.value
   periods     = deltaTime / 
   rate        = deltaValue / periods
   match       = rate  
 

In other words, take the rate of change for the most recent datums and compare it to the threshold. For example, Let's say we have a metric, sessionCount, that increments for each new session. If the sessionCount increases too quickly, say more than 20 per minute, we want an alert. We'd want:

   RateCondition( 'SessionCount', INCREASING, MINUTE, GT, 20 )
 

By specifying the SessionCount data as increasing, we know to ignore/reset if the previous session count is less than the current session count. This indicates that maybe the counter was reset (maybe due to a restart).

Note that rate of change is always determined as an absolute value. So threshold values should be >= 0.

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateCondition.Direction Default: INCREASING
static class	RateCondition.Operator
static class	RateCondition.Period Default: MINUTE

Nested classes/interfaces inherited from class org.hawkular.alerts.api.model.condition.Condition

Condition.Type

Field Summary

Fields inherited from class org.hawkular.alerts.api.model.condition.Condition

conditionId, conditionSetIndex, conditionSetSize, context, tenantId, triggerId, triggerMode, type

Constructor Summary

Constructors

Constructor and Description
RateCondition() Used for JSON deserialization, not for general use.
RateCondition(String triggerId, Mode triggerMode, int conditionSetSize, int conditionSetIndex, String dataId, RateCondition.Direction direction, RateCondition.Period period, RateCondition.Operator operator, Double threshold) This constructor requires the tenantId be assigned prior to persistence.
RateCondition(String triggerId, Mode triggerMode, String dataId, RateCondition.Direction direction, RateCondition.Period period, RateCondition.Operator operator, Double threshold) This constructor requires the tenantId be assigned prior to persistence.
RateCondition(String tenantId, String triggerId, Mode triggerMode, int conditionSetSize, int conditionSetIndex, String dataId, RateCondition.Direction direction, RateCondition.Period period, RateCondition.Operator operator, Double threshold)
RateCondition(String tenantId, String triggerId, Mode triggerMode, String dataId, RateCondition.Direction direction, RateCondition.Period period, RateCondition.Operator operator, Double threshold)
RateCondition(String tenantId, String triggerId, String dataId, RateCondition.Direction direction, RateCondition.Period period, RateCondition.Operator operator, Double threshold)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDataId()
RateCondition.Direction	getDirection()
String	getLog(long time, double value, long previousTime, double previousValue)
RateCondition.Operator	getOperator()
RateCondition.Period	getPeriod()
double	getRate(long time, double value, long previousTime, double previousValue)
Double	getThreshold()
int	hashCode()
boolean	match(long time, double value, long previousTime, double previousValue)
void	setDataId(String dataId)
void	setDirection(RateCondition.Direction direction)
void	setOperator(RateCondition.Operator operator)
void	setPeriod(RateCondition.Period period)
void	setThreshold(Double threshold)
String	toString()

Methods inherited from class org.hawkular.alerts.api.model.condition.Condition

getConditionId, getConditionSetIndex, getConditionSetSize, getContext, getTenantId, getTriggerId, getTriggerMode, getType, setConditionSetIndex, setConditionSetSize, setContext, setTenantId, setTriggerId, setTriggerMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RateCondition

public RateCondition()

Used for JSON deserialization, not for general use.

RateCondition

public RateCondition(String tenantId,
                     String triggerId,
                     String dataId,
                     RateCondition.Direction direction,
                     RateCondition.Period period,
                     RateCondition.Operator operator,
                     Double threshold)

RateCondition

public RateCondition(String triggerId,
                     Mode triggerMode,
                     String dataId,
                     RateCondition.Direction direction,
                     RateCondition.Period period,
                     RateCondition.Operator operator,
                     Double threshold)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

RateCondition

public RateCondition(String tenantId,
                     String triggerId,
                     Mode triggerMode,
                     String dataId,
                     RateCondition.Direction direction,
                     RateCondition.Period period,
                     RateCondition.Operator operator,
                     Double threshold)

RateCondition

public RateCondition(String triggerId,
                     Mode triggerMode,
                     int conditionSetSize,
                     int conditionSetIndex,
                     String dataId,
                     RateCondition.Direction direction,
                     RateCondition.Period period,
                     RateCondition.Operator operator,
                     Double threshold)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

RateCondition

public RateCondition(String tenantId,
                     String triggerId,
                     Mode triggerMode,
                     int conditionSetSize,
                     int conditionSetIndex,
                     String dataId,
                     RateCondition.Direction direction,
                     RateCondition.Period period,
                     RateCondition.Operator operator,
                     Double threshold)

Method Detail

getDataId

public String getDataId()

Specified by:

getDataId in class Condition

Returns:

The dataId, can be null if the Condition has no relevant dataId.

setDataId

public void setDataId(String dataId)

getDirection

public RateCondition.Direction getDirection()

setDirection

public void setDirection(RateCondition.Direction direction)

getPeriod

public RateCondition.Period getPeriod()

setPeriod

public void setPeriod(RateCondition.Period period)

getOperator

public RateCondition.Operator getOperator()

setOperator

public void setOperator(RateCondition.Operator operator)

getThreshold

public Double getThreshold()

setThreshold

public void setThreshold(Double threshold)

getLog

public String getLog(long time,
                     double value,
                     long previousTime,
                     double previousValue)

match

public boolean match(long time,
                     double value,
                     long previousTime,
                     double previousValue)

getRate

public double getRate(long time,
                      double value,
                      long previousTime,
                      double previousValue)

hashCode

public int hashCode()

Overrides:

hashCode in class Condition

equals

public boolean equals(Object obj)

Overrides:

equals in class Condition

toString

public String toString()

Overrides:

toString in class Condition