> For the complete documentation index, see [llms.txt](https://ztrust.gitbook.io/livestreamiq/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ztrust.gitbook.io/livestreamiq/readme/4.-administration/4.5.-alert-configuration.md).

# 4.5. Alert Configuration

### 1. Overview

The Alert Management System enables administrators to monitor Kafka cluster health and automatically notify stakeholders when predefined conditions are met.

The alerting workflow consists of two major steps:

1. **Create Actions** – Define how and to whom notifications should be sent.<br>

   <figure><img src="/files/EWMxYmVuXs3FJTLLGupw" alt=""><figcaption></figcaption></figure>
2. **Create Triggers** – Define when notifications should be sent by configuring alert conditions.<br>

   <figure><img src="/files/vzZsBcxTR7uinVdRyV5h" alt=""><figcaption></figcaption></figure>

   \
   An alert is generated only when a configured trigger condition is satisfied, which then executes one or more associated actions.

### 2. Alerting Workflow

&#x20;                        Create Action

&#x20;                                ↓

&#x20;                        Create Trigger

&#x20;                                 ↓

&#x20;                System Monitors Metrics

&#x20;                                 ↓

&#x20;                 Trigger Condition Met

&#x20;                                 ↓

&#x20;             Associated Action Executed

&#x20;                                 ↓

&#x20;                     Notification Sent

The followiing steps to set and configure the Alerts are below:   &#x20;

Step 1: Create an Action\
\
Actions define the notification mechanism and recipients.

1. Navigate: **Administration → Alert Configuration → Actions**
2. Click **New Action**.<br>

   <figure><img src="/files/7PpDVYLwZYHNWUbMNbiv" alt=""><figcaption></figcaption></figure>
3. Configure the Action Fields.<br>

   <figure><img src="/files/dfR6LvGXmtV7N4K9gxrQ" alt=""><figcaption></figcaption></figure>

   1. Action Name: A unique and descriptive name for the action.\
      Example: Critical Email Alert
   2. Action Type: Select the notification mechanism.
   3. Supported values:
      1. SMTP (Email)
      2. Slack (Future Enhancement)
      3. Webhook (Future Enhancement)
      4. Microsoft Teams (Future Enhancement)\
         Example: `SMTP`
   4. Reaction: Defines the cooldown interval between alert notifications. \
      This prevents excessive notifications for the same issue. It taking as minute by default.\
      Examples:
      1. 5 Minutes
      2. 10 Minutes
      3. 30 Minutes
      4. 1 Hour
   5. Example behavior: If a trigger remains active and Reaction is set to 5 minutes, notifications will be sent at most once every 5 minutes.
   6. Action Config ID: Select an existing notification configuration.\
      For SMTP actions, this refers to a configured SMTP server.\
      Example: `SMTP_PRODUCTION`
   7. Recipients: Select users or email addresses that should receive notifications.\
      Example: `admin@company.com`\
      &#x20;                `ops@company.com`\
      &#x20;                `ops@company.com`
   8. Enable Trigger: Enable or disable the action.
      1. Checked:\
         \&#xNAN;*Action is active*
      2. Unchecked:\
         \&#xNAN;*Action will not execute*
   9. Save Action: Click **Save**.\
      The action will become available for selection while creating triggers.\
      \
      Example Action:

      | Field            | Value                |
      | ---------------- | -------------------- |
      | Action Name      | Critical Email Alert |
      | Action Type      | SMTP                 |
      | Reaction         | 5 Minutes            |
      | Action Config ID | SMTP\_PRODUCTION     |
      | Recipients       | <admin@company.com>  |
      | Enabled          | Yes                  |

&#x20;Step 2: Create a Trigger

Triggers define alert conditions.

1. Navigate: **Administration → Alert Configuration → Triggers**
2. then, Click **New Trigger.**<br>

   <figure><img src="/files/9xS6J4uQ7ygz9sdcF5ud" alt=""><figcaption></figcaption></figure>
3. Configure the Trigger Fields.<br>

   <figure><img src="/files/BOCKfkIhzWSYpeLElgE4" alt=""><figcaption></figcaption></figure>

   1. Rule Name: A unique name for the alert rule.\
      Example: Broker Count Low
   2. Cluster Name: Select the Kafka cluster to monitor.\
      Example: `KAFKA_CLUSTER3`
   3. Component Name: Select the component being monitored.\
      Examples:
      1. Broker
      2. Topic
      3. Consumer Group
      4. Kafka Connect
      5. Schema Registry
   4. Severity: Select the alert severity level.\
      Available values:
      1. Critical
      2. Warning
      3. Emergency
   5. Metric Name: Select the metric to monitor.\
      Examples:
      1. BROKER\_COUNT
      2. CONSUMER\_GROUP
      3. MEMORY\_USAGE\_PERCENT
      4. SYSTEM\_LOAD\_AVG\_PERCENT
      5. CPU\_LOAD\_PERCENT
      6. PROCESS\_CPU\_LOAD\_PERCENT
      7. SYSTEM\_CPU\_LOAD\_PERCENT
   6. Threshold Value: Enter the threshold value that determines when the alert should fire.
   7. Operator: Select the comparison operator.\
      Available operators:<br>

      | Operator | Meaning               |
      | -------- | --------------------- |
      | >        | Greater than          |
      | <        | Less than             |
      | >=       | Greater than or equal |
      | <=       | Less than or equal    |
      | ==       | Equal to              |
   8. Actions: Select one or more previously created actions.\
      Example: Critical Email Alert\
      \
      When the trigger condition is met, the selected actions will execute.
   9. Enable Trigger:&#x20;
      1. Checked: Trigger actively monitors metrics
      2. Unchecked: Trigger is disabled
   10. Save Trigger
   11. Click **Save.**<br>

   The trigger becomes active immediately.\
   Example: **Trigger**<br>

   <table data-search="false"><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td>Rule Name</td><td>Broker Count Low</td></tr><tr><td>Cluster Name</td><td>KAFKA_CLUSTER3</td></tr><tr><td>Component Name</td><td>Broker</td></tr><tr><td>Severity</td><td>Critical</td></tr><tr><td>Metric Name</td><td>BROKER_COUNT</td></tr><tr><td>Operator</td><td>&#x3C;</td></tr><tr><td>Threshold Value</td><td>3</td></tr><tr><td>Action</td><td>Critical Email Alert</td></tr><tr><td>Enabled</td><td>Yes</td></tr></tbody></table>
