Class LoggingAlertSink

java.lang.Object

com.kingsrook.qqq.backend.core.alerts.LoggingAlertSink

All Implemented Interfaces:

AlertSinkInterface

public class LoggingAlertSink
extends Object
implements AlertSinkInterface

The default alert sink, used when no alerts implementation is installed: it logs. INFO signals log at INFO, WARNING and above at WARN. Logging is rate-limited per (type, dedupKey), so a producer that raises the same alert every few seconds writes one line per window, not thousands. Heartbeats are not logged (they are expected, frequent and not a problem). Notifications log at INFO (WARN for ERROR and CRITICAL), rate-limited per (category, sourceKey or title). With this sink, producer code paths are identical with and without an alerts implementation - which is the point.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	RATE_LIMIT_WINDOW	how long to stay quiet about a key after logging it.

Constructor Summary

Constructors

Constructor	Description
LoggingAlertSink()

Method Summary

Modifier and Type	Method	Description
void	heartbeat(String heartbeatKey, Instant at)	Heartbeats are expected and frequent, so they are not logged.
void	notify(NotificationSignal signal)	Log a user notification (there is no inbox without an implementation).
void	raise(AlertSignal signal)	Record (or refresh) an alert.
void	resolve(AlertResolution resolution)	Resolve an open alert, if there is one.

Methods inherited from class java.lang.Object

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

Field Details

RATE_LIMIT_WINDOW

public static final Duration RATE_LIMIT_WINDOW

how long to stay quiet about a key after logging it.

Constructor Details

LoggingAlertSink

public LoggingAlertSink()

Method Details

raise

public void raise(AlertSignal signal)

Description copied from interface: AlertSinkInterface

Record (or refresh) an alert. The signal's occurredAt is always set.

Specified by:

raise in interface AlertSinkInterface

resolve

public void resolve(AlertResolution resolution)

Description copied from interface: AlertSinkInterface

Resolve an open alert, if there is one. resolvedAt is always set.

Specified by:

resolve in interface AlertSinkInterface

heartbeat

public void heartbeat(String heartbeatKey,
 Instant at)

Heartbeats are expected and frequent, so they are not logged.

Specified by:

heartbeat in interface AlertSinkInterface

notify

public void notify(NotificationSignal signal)

Log a user notification (there is no inbox without an implementation).

Specified by:

notify in interface AlertSinkInterface