Core
IoT Platform v2.x
2

How to create an alert rule #

In this guide, we will create a new alert rule to create an alert when a condition is met.

Step 1: Navigate to the Rules Page #

  • Screenshot

    rules page

Step 2: Create a New Alert Rule #

  1. Click on the + button on the top right corner.
  2. Fill in the alert rule details:
    • Type: Select the type of alert rule (e.g., "Threshold").
    • Name: Enter a descriptive name for the alert rule.
    • Description: Provide a clear description explaining the purpose of the alert rule.
    • Collection: (If present) Choose the collection containing the data to monitor (e.g., "measures").
    • Asset(s) to follow: Configure filters to specify which assets to monitor and under what conditions.
    • Time range for alert activation: (Optional) Define when the alert rule should be active using planning settings.
    • Parameters for threshold exceedance detection: For threshold type rules, specify the monitoring conditions:
      • Field to monitor
      • Comparison operator
      • Threshold value
      • Debounce settings (delay before triggering/resolving alerts)
      • Alert severity levels and their timing
  • Screenshot

    new rule page

  1. In the "Linked Notification Rules" section, click on the "Link Notification Rule" button.
  2. Select the notification rules you want to link to this alert rule.
  3. Click "Link" to associate the selected notification rules with the alert rule.

Step 4: Save the Alert Rule #

  1. Review all alert rule settings to ensure they are correctly configured.
  2. Click on the "Save" button to create and activate the alert rule.

Example: Temperature Monitoring Alert #

Here's a practical example of creating a threshold alert rule for temperature monitoring:

  1. Basic Information:
    • Type: Threshold
    • Name: Temperature Alert
    • Description: Monitors container temperature and triggers alerts when exceeding 30°C
  • Screenshot

    general infos

  1. Asset(s) to follow:
    • Model: Container
    • Measures: Internal Temperature
    • References: Container-zulu, Container-tango (multiple references can be monitored)
  • Screenshot assets to follow
  1. Parameters for threshold exceedance detection:
    • Field: values.temperature
    • Operator: >
    • Value: 30
    • Timing of alert levels:
      • Level 1:
        • Initial triggering (in minutes): 2
        • Severity Level: Info
      • Level 2:
        • Trigger delay (in minutes): 5
        • Severity Level: High
    • Time to return to normal (in minutes): 10
  • Screenshot

    threshold