Class AlertDefaultMonitor

java.lang.Object

com.kingsrook.qqq.backend.core.alerts.AlertDefaultMonitor

All Implemented Interfaces:

Serializable

public class AlertDefaultMonitor
extends Object
implements Serializable

A monitor that an alert type ships with ("seeded"). An alerts implementation inserts it once; after that it belongs to the admin, who may tune or disable it. Without an implementation installed it does nothing. The definition's keys depend on the kind (e.g. HEARTBEAT takes heartbeatKey or processName, plus expectedEverySeconds and graceSeconds; TABLE_QUERY takes tableName and filter). Values must be JSON-friendly.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AlertDefaultMonitor()

Method Summary

Modifier and Type	Method	Description
Map<String,Serializable>	getDefinition()	Getter for definition
Integer	getForMinutes()	Getter for forMinutes
AlertMonitorKind	getKind()	Getter for kind
String	getName()	Getter for name
Boolean	getPerRecord()	Getter for perRecord
Integer	getScheduleSeconds()	Getter for scheduleSeconds
AlertSeverity	getSeverity()	Getter for severity
static AlertDefaultMonitor	heartbeat(String name, String heartbeatKey, int expectedEverySeconds, int graceSeconds)	A heartbeat monitor: raise when the key has not beat within the expected interval plus grace.
AlertDefaultMonitor	withDefinition(Map<String,Serializable> definition)	Fluent setter for definition
AlertDefaultMonitor	withDefinitionValue(String key, Serializable value)	Set one definition value.
AlertDefaultMonitor	withForMinutes(Integer forMinutes)	Fluent setter for forMinutes (how long a condition must hold before it fires)
AlertDefaultMonitor	withKind(AlertMonitorKind kind)	Fluent setter for kind
AlertDefaultMonitor	withName(String name)	Fluent setter for name
AlertDefaultMonitor	withPerRecord(Boolean perRecord)	Fluent setter for perRecord (one alert per matching record, instead of one aggregate alert)
AlertDefaultMonitor	withScheduleSeconds(Integer scheduleSeconds)	Fluent setter for scheduleSeconds (how often to evaluate)
AlertDefaultMonitor	withSeverity(AlertSeverity severity)	Fluent setter for severity (default: the type's severity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AlertDefaultMonitor

public AlertDefaultMonitor()

Method Details

heartbeat

public static AlertDefaultMonitor heartbeat(String name,
 String heartbeatKey,
 int expectedEverySeconds,
 int graceSeconds)

A heartbeat monitor: raise when the key has not beat within the expected interval plus grace.

getName

public String getName()

Getter for name

withName

public AlertDefaultMonitor withName(String name)

Fluent setter for name

getKind

public AlertMonitorKind getKind()

Getter for kind

withKind

public AlertDefaultMonitor withKind(AlertMonitorKind kind)

Fluent setter for kind

getDefinition

public Map<String,Serializable> getDefinition()

Getter for definition

withDefinition

public AlertDefaultMonitor withDefinition(Map<String,Serializable> definition)

Fluent setter for definition

withDefinitionValue

public AlertDefaultMonitor withDefinitionValue(String key,
 Serializable value)

Set one definition value.

getPerRecord

public Boolean getPerRecord()

Getter for perRecord

withPerRecord

public AlertDefaultMonitor withPerRecord(Boolean perRecord)

Fluent setter for perRecord (one alert per matching record, instead of one aggregate alert)

getSeverity

public AlertSeverity getSeverity()

Getter for severity

withSeverity

public AlertDefaultMonitor withSeverity(AlertSeverity severity)

Fluent setter for severity (default: the type's severity)

getScheduleSeconds

public Integer getScheduleSeconds()

Getter for scheduleSeconds

withScheduleSeconds

public AlertDefaultMonitor withScheduleSeconds(Integer scheduleSeconds)

Fluent setter for scheduleSeconds (how often to evaluate)

getForMinutes

public Integer getForMinutes()

Getter for forMinutes

withForMinutes

public AlertDefaultMonitor withForMinutes(Integer forMinutes)

Fluent setter for forMinutes (how long a condition must hold before it fires)