Alerting
Use alerts to receive a notification when data or performance has shifted.
Create an alert
Alerts can be created by clicking on Create Alert +
button from the Alerts page. Find the alerts page from the sidebar.
Alerts have a Metric
, Name
, Evaluation Window
, Delay Time
, and Range
. They are configured in the alert panel:
Metric
is what you’re alerting on, Evaluation Window
determines the timerange, and Range
sets the values used to determine whether the alert should trigger. In the following example, “Max loans”, will alert if the maximum inputs.loan_amount
is outside of the range 0 - 18,000 for longer than 5 minutes:
Evaluation Delay
refers to when an alert will evaluate. This value should not be adjusted to create real-time alerts. Use it if you intend to evaluate past or batch data.
Understanding when alerts evaluate
Since Gantry allows the ingestion of historical data, there are two parameters to configure for alerts: Evaluation window
and Evaluation delay
.
Evaluation window
determines the time window of data on which to compute the alert metric.
Evaluation delay
can be optionally configured to determine how long the system will wait for data to come in before evaluating a window. Evaluation delay
should not be adjusted to create real-time alerts. It is intended to evaluate past or batch data.
For example, if the Evaluation window
is 15 minutes and the Evaluation delay
is 30 minutes, then at 12 pm, the alert will evaluate data between 11:15am and 11:30am.
Alert notifications
Gantry can be configured to send alerts to a slack channel. This is currently the best way to receive alerts from Gantry. To receive Slack messages, you'll need to configure a Slack webhook. Slack gives instructions on how to do that here.
To send notifications, set up a notification channel from the alerts panel. This panel can be found by creating a new alert or editing an existing one.
Each notification has a daily notification time and webhook. For example, the following notification will use the alerts-max-loan-channel
webhook and send a daily notification at 5:00 PM UTC
:
Viewing and editing alerts
Alerts and their statuses can be viewed from the alert page:
To edit or delete an alert or its notifications, click the horizontal ellipsis ⋯
at the end of the row:
Deleting an alert will ask for confirmation.
Updated 3 days ago