---
title: Set Up Alert Triggers
slug: edgemanager/lem-user-ui/product-features/alerts/set-up-alert-triggers
description: Learn how to set up alert triggers.
docTags: 
createdAt: 2022-10-05T21:11:22.000Z
---

:::hint{type="info"}
**Note**: The user interface below is for Litmus Edge Manager version 2.10.1 and later.&#x20;
:::

You can add an alert trigger for edge devices in the *Triggers* section in the *Alerts* module.&#x20;

Review the following guides for setting up alert triggers:

- [Create an Email-Alert Trigger for Connector Online Status](docId\:da-gvxuEPnYfpaTsSYhcq)
- [Create an Email-Alert Trigger for DeviceHub Device Data Quality](docId\:keO0ctAMmo949dTzLGw7V)

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/A38eHBYNP-fMkJ2HOT1cn_image.png" size="80" width="1298" height="760" position="center" caption="Add new trigger icon" showCaption="true"}

:::hint{type="warning"}
**Important**: Triggers require an action for notification implementation.
:::

Variables change depending on the **Source** selected.

# Before You Begin

Add an action to the *Action List* to receive a notification. See [Add new Action](docId\:BWq6oBkuTNZgIJBIgQPBE) for detail&#x73;*.*

# Step 1: Select and Set Up Source

Completing the *Source&#xA0;*&#x73;ection first avoids issues with the variables for th&#x65;***&#xA0;**&#x53;ubject***&#xA0;**&#x61;nd *Message***&#xA0;**&#x66;ields in th&#x65;*&#xA0;Trigger***&#xA0;**&#x73;ection. The source is the type of condition needed to trigger an alert.&#x20;

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/l92yK6RHiNucMJahWZOGn_image.png "New Trigger: Source section")

**To select a source**:

1. Select a **Source**.   &#x20;The options are:&#x20;
   - **Metrics:&#x20;**&#x54;he *Trigger&#x20;*&#x73;ection's *Subject* and *Message* fields will be hidden and disabled.**&#x20;&#x20;**
   - **Events:&#x20;**&#x54;he *Trigger&#x20;*&#x73;ection's *Subject* and *Message* fields will be revealed and enabled.
2. Click the **Add** link to add a new rule. The rule table drops down. The rule table is dependent on your source selection.

## Step 1a: Set Up Metrics Source

Select a metrics source to set up an alert that triggers based on metrics collected by Litmus Edge Manager, specifically when the value of a variable is a certain desired value or certain set/interval of values.  You may create only one metrics rule per alert.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/VAElv5pvijtNGYgxNSgv4_image.png" size="80" width="1905" height="400" position="center" caption="New Trigger : Source section : Metrics Source" showCaption="true"}

From the **Select Alert template** drop-down list, select an alert template and enter a value for each of the respective parameters. Refer to the following table for more information on each alert template:&#x20;

| **Metrics Name \| Source**                      | **Description / Purpose**                                                                                                                                                                     | **Parameters**                                         | **Trigger Condition (Create an Alert...)**                                                                                                                              |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Connector disk buffer \| Integration            | Monitor [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disk buffer, which is used when the connector’s throughput is insufficient to handle all defined tags coming from Edge devices. | - Target Value in MB
- Alert Delay in seconds          | When the usage of [Integration](docId\:Wpqo1fE02tmx3AsKewQU6) Connector disk buffer is above \_\_Target\_Value\_\_ MB for more than \_\_Alert\_Delay\_\_ seconds.<br /> |
| Connector online status \|<br />Integration     | Detect unplanned [Integration](docId\:Wpqo1fE02tmx3AsKewQU6)Connector disconnections.                                                                                                         | * Alert Delay in seconds                               | When the [Integration](docId\:Wpqo1fE02tmx3AsKewQU6)Connector is offline for more than \_\_Alert\_Delay\_\_ seconds.                                                    |
| DeviceHub (DH) online status \| DeviceHub       | Detect unplanned disconnections of DeviceHub (DH) devices.                                                                                                                                    | - Alert Delay in seconds                               | When the DeviceHub (DH) device is offline for more than \_\_Alert\_Delay\_\_ seconds.                                                                                   |
| DeviceHub (DH) device data quality \| DeviceHub | Monitor the rate of low-quality (i.e. error) messages. A high rate of low-quality messages indicate a problem with either the physical device or the device driver.                           | * Target Value in msgs/minute
* Alert Delay in seconds | The rate of low-quality messages for the DH device is above \_\_Target\_Value\_\_ for more than \_\_Alert\_Delay\_\_ seconds.                                           |
| Edge Device online status \| Edge Device        | Detect unexpected disconnections of edge Devices.                                                                                                                                             | - Alert Delay in seconds                               | The edge device is offline for more than \_\_Alert\_Delay\_\_ seconds.                                                                                                  |
| Edge Device license expiration \| Edge Device   | Detect when the license of an edge device has expired.                                                                                                                                        | * Target Value in days
* Alert Delay in seconds        | When the license for an edge device is going to be expired in \_\_Target\_Value\_\_ days for more than \_\_Alert\_Delay\_\_ seconds.                                    |
| Edge Device free disk space \| Edge Device      | Monitor the available disk space of an edge device.                                                                                                                                           | - Target Value in Percentage
- Alert Delay in seconds  | When the free disk space is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds.                                                         |
| Edge Device memory available \| Edge Device     | Monitor the available memory of an edge device                                                                                                                                                | * Target Value in Percentage
* Alert Delay in seconds  | When the Free RAM is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds.                                                                |
| Edge Device CPU Idle \| Edge Device             | Monitor the CPU usage of an edge device                                                                                                                                                       | - Target Value in Percentage
- Alert Delay in seconds  | When the CPU idle  is less than \_\_Target\_Value\_\_ percent for more than \_\_Alert\_Delay\_\_ seconds.                                                               |

## Step 1b: Set Up Events Source

Select an events source to set up an alert that triggers when a specific event occurs.&#x20;

:::hint{type="info"}
**Note:&#x20;**&#x54;he trigger for *Events* in Edge devices will only work if the *Forward Events&#x20;*&#x74;oggle is enabled. For more details on events, refer to the [Events](docId\:OnS8mKWpVtKc93cOoRAKm) documentation.&#x20;
:::

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/UWVqMEu_SNpoH0AUqV055_image.png" size="80" width="1908" height="496" position="center" caption="Source section: Events Source" showCaption="true"}

**To set up an events source**:

1. From the **Severity** drop-down list, select an option.&#x20;
   - All
   - Info
   - Warning
   - Alert
2. From the **Component** drop-down list, select an option.&#x20;
   - All
   - cc - Integrations
   - mp - Marketplace
   - dh - Device Hub
   - auth - Auth
   - dm - Device Management
3. From the **Event ID&#x20;**&#x64;rop-down list, select an option. Options are dependent on th&#x65;*&#x20;Component&#x20;*&#x73;elected. See [Event ID for User Alert Triggers](docId\:gvKc02F1g_KO9srUqXdYD).
4. (Optional) Click **Show Event Attributes...** For each of the event attributes, enter a value.
5. (Optional) In th&#x65;**&#x20;Info** field, enter a value.
6. Repeat with additional new rules by clicking the **Add new rule** button as needed.

# Step 2: Set Up Trigger

:::hint{type="info"}
**Note**: For Litmus Edge Manager version 2.14.0 and later, you can customize the subject and message of the trigger alert with your preferred text in addition to the variables.&#x20;
:::

You can customize the trigger's subject/message contents that will be sent to a recipient. The visibility of the *Subject***&#xA0;**&#x61;nd *Message***&#xA0;**&#x66;ields are dependent on the *Source***&#xA0;**&#x73;election from Step 1.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/-wqg7EtcE99kokzlSsW5H_image.png "Set up Trigger: Metrics version")

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/6GfWGzK92sYDZgCGzjU2-_image.png "Set up Trigger: Events version")

## Subject and Message Variables

You can select from the following variables in the trigger subject and message:

- **$devicename**: The name of the associated edge device . (For example: Litmus Edge (08:00:23:18\:r5:32).
- **$name**: The name of the associated connector or DeviceHub device. (For example: PLC\_2)
- **$alertDelay**: The alert delay parameter configured for the trigger.&#x20;
- **$value**: The current value associated with the connector or DeviceHub device that is being monitored. (For example: connector disk buffer of 98MB)
- **$company**: The company associated with the edge device for the trigger.&#x20;
- **$deviceid**: The associated edge device ID. (For example: 9udklweoidslsdd0lksdjfslkd)
- **$project**: The project associated with the edge device for the trigger.&#x20;
- **$targetValue**: The target value configured for the trigger. (For example: 50MB for Connector disk buffer)
- **$componentid**: The associated component for the event trigger: cc - Integrations, mp - Marketplace, dh - Device Hub, or auth - Auth.&#x20;
- **$message**: The associated event message for the trigger.&#x20;
- **$triggerid**: The associated trigger ID.&#x20;
- **$hostname**: The associated host name for the trigger.&#x20;
- **$tags**: The associated tags for the trigger.&#x20;
- **$severity**: The severity level selected for the trigger: Info, Warning, or Alert.&#x20;
- **$triggername**: The name configured for the trigger.&#x20;
- **$type**: The associated event type for the trigger.&#x20;
- **$eventid**: The event ID associated with the trigger.&#x20;

**To set up the trigger**:

1. In th&#x65;**&#x20;Name** field, enter a name for the trigger.&#x20;
2. (Optional) Click the **Active&#x20;**&#x63;heckbox to set an active trigger flag.
3. (Optional) Click the **Dashboard&#x20;**&#x63;heck box to show trigger alerts on the dashboard.
4.   In the **Description** field, enter a description for the trigger.&#x20;
5. In the **Subject&#x20;**&#x66;ield, select one or more variables. For Litmus Edge Manager version 2.14.0 and later, you can enter your preferred text in addition to selected variables.&#x20;
6. In the **Message&#x20;**&#x66;ield, select one or more variables. For Litmus Edge Manager version 2.14.0 and later, you can enter your preferred text in addition to selected variables.&#x20;

# Step 3: Set Up Scope

You can customize the scope of the user triggers. This will determine the applicable edge device(s) that will receive this alert trigger.&#x20;

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TlZN2XYt9OyMQdwoeyVu0_image.png "New Trigger: Set up Scope")

To set up the scope, select an option from the *Scope&#x20;*&#x73;ection.&#x20;

- **All edge devices**
- **Edge Device**. From the **Edge Device** drop-down list, select an edge device.

# Step 4: Set Up Action

You must create an action to use this section. You can select the response action that will immediately occur after the alert is triggered.&#x20;

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/HlNTd3OwtjixPUqHfnivs_image.png "New Trigger: Set up Action")

**To set up the action**:

1. Select an option from the **Action List** drop-down list.
2. (Optional) Select the **Continuously&#x20;**&#x63;heck box.
   - If you have checked **Continuously**, enter a value in the **Notification Period** field in minutes.
3. Click **Save**.   &#x20;The alert trigger appears in the Trigger List.

:::hint{type="info"}
**Important:&#x20;**&#x54;o continue receiving incident notifications for the same condition, you must resolve the current incident first. After clicking *Resolve Incident*, a notification will be sent confirming the resolution.
:::

