Package com.kingsrook.qqq.backend.core.alerts
package com.kingsrook.qqq.backend.core.alerts
-
ClassDescriptionA monitor that an alert type ships with ("seeded").A link from an alert to where a person fixes it: a record, a table with a filter, an app or widget path, or an absolute URL.The kinds of monitor an alerts implementation evaluates.Turns process lifecycle events into alerts, for processes that carry AlertProcessMetaData (registered automatically by its enrichment): - a failed run raises process."Tell me when this process fails" and "tell me when it didn't run", by meta-data alone: process.withSupplementalMetaData(new AlertProcessMetaData() .withAlertOnFailure(AlertSeverity.ERROR) .withExpectedEvery(Duration.ofHours(24))); At enrichment this declares the alert types process.A record that an alert is about.A producer's "this problem is gone", passed to QAlerts.resolve.How urgent an alert is.One "this is a problem" signal from a producer, passed to QAlerts.raise.Where QAlerts sends signals.Instance-level alerts meta-data: the sink that QAlerts sends signals to (default: LoggingAlertSink) and every declared QAlertTypeMetaData.How much of an alert an external channel (email, chat, paging, webhook) may include.The default alert sink, used when no alerts implementation is installed: it logs.Who a user notification is for.The kinds of audience.What a user notification is about.How a user notification is presented (its icon and color).One user notification from a producer, passed to QAlerts.notify: "tell these people this".The producer API for alerts ("manage by exception").Declares a kind of problem a qbit or app can report (e.g. cdn.purge.dead), so the system "knows about" every alert source.How an open alert of a type is closed automatically.