orangeqs.juice.alerting._alert#

Alert API module for OrangeQS Juice Alerting.

Module Contents#

Functions#

alert

Orchestrates the end-to-end alerting process for a given topic.

API#

async orangeqs.juice.alerting._alert.alert(topic: str, **context: str) → None#

Orchestrates the end-to-end alerting process for a given topic.

Parameters#

  • topic (str): The unique identifier for the alert type (e.g., “fridge_overheating”).

  • **context (str): Arbitrary keyword arguments used to satisfy the AlertDefinition and render the alert templates.

Raises#

  • (UnknownTopicException): If the topic does not exist in the Alert Definition layer.

  • (MissingContextException): If the provided context does not satisfy the Alert Definition requirements.

  • (RoutingException): If no senders are configured for the topic in the Routing Layer.

  • (SendingException): If one or more senders fail to deliver the alert.

  • (The following configurations are loaded from disk during runtime:)

  • (- Alert definitions from JuiceAlerts config)

  • (- Routing configuration from AlertRouting config)

  • (- Parameter Monitor Configuration from ParameterMonitorConfig config)