Documentation

Create Chronograf alert rules

Chronograf provides a user interface for Kapacitor, InfluxData’s processing framework for creating alerts, ETL jobs (running extract, transform, load), and detecting anomalies in your data. Chronograf alert rules correspond to Kapacitor tasks that trigger alerts whenever certain conditions are met. Behind the scenes, these tasks are stored as TICKscripts that can be edited manually or through Chronograf. Common alerting use cases that can be managed using Chronograf include:

  • Thresholds with static ceilings, floors, and ranges.
  • Relative thresholds based on unit or percentage changes.
  • Deadman switches.

Complex alerts and other tasks can be defined directly in Kapacitor as TICKscripts, but can be viewed and managed within Chronograf. To learn about managing Kapacitor TICKscripts in Chronograf, see Manage Kapacitor TICKscripts.

Requirements

Get started with Chronograf offers step-by-step instructions for each of the following requirements:

Manage Chronograf alert rules

Chronograf lets you create and manage Kapacitor alert rules. To manage alert rules:

  1. Click on Alerting in the left navigation bar and select Alert Rules.
  2. Do one of the following:

To create and manage alert rules in Chronograf, click on Alerting in the left navigation bar and select Alert Rules. Do one of the following:

  • View alert rules.
  • Enable and disable alert rules.
  • Delete alert rules.
  • Create new alert rules using the Alert Rule Builder.

Create an alert rule

From the Alert Rules page in Chronograf:

  1. Click + Build Alert Rule.

  2. Name the alert rule.

  3. Choose the alert type:

    • Threshold - alert if data crosses a boundary.
    • Relative - alert if data changes relative to data in a different time range.
    • Deadman - alert if InfluxDB receives no relevant data for a specified time duration.
  4. Select the time series data to use in the alert rule.

    • Navigate through databases, measurements, tags, and fields to select all relevant data.
  5. Define the rule conditions. Condition options are determined by the alert type.

  6. Select and configure the alert handler.

    • The alert handler determines where the system sends the alert (the event handler).
    • Chronograf supports several event handlers and each handler has unique configurable options.
    • Multiple alert handlers can be added to send alerts to multiple endpoints.
  7. Configure the alert message.

    • The alert message is the text that accompanies an alert.
    • Alert messages are templates that have access to alert data.
    • Available templates appear below the message text field.
    • As you type your alert message, clicking the data templates will insert them at the end of whatever text has been entered.
  8. Click Save Rule.

Enable and disable alert rules

To enable and disable alerts, click on Alerting in the left navigation bar and select Alert Rules.

  • To enable an alert rule, locate the alert rule and click the box Task Enabled. A blue dot shows the task is enabled. A message appears to confirm the rule was successfully enabled.
  • To disable an alert rule, click the box Task Enabled. The blue dot disappears and a message confirms the alert was successfully disabled.

Delete alert rules

To delete an alert, click on Alerting in the left navigation bar and select Alert Rules.

  1. Locate the alert you want to delete, and then hover over the “Task Enabled” box. A Delete button appears to the right.
  2. Click Delete to delete the rule.

Note: Deleting a rule cannot be undone, and removes the rule permanently.

View alert history

Chronograf lets you view your alert history on the Alert History page.

To view a history of your alerts, click on Alerting in the left navigation bar and select Alert History. Do one of the following:

  • View a history of all triggered alerts.
  • Filter alert history by type.
  • View alert history for a specified time range.

Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.