> For the complete documentation index, see [llms.txt](https://docs.livestreamiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.livestreamiq.com/readme-1/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.
2. **Create Triggers** – Define when notifications should be sent by configuring alert conditions.
\
An alert is generated only when a configured trigger condition is satisfied, which then executes one or more associated actions.
### 2. Alerting Workflow
Create Action
↓
Create Trigger
↓
System Monitors Metrics
↓
Trigger Condition Met
↓
Associated Action Executed
↓
Notification Sent
The followiing steps to set and configure the Alerts are below:
Step 1: Create an Action\
\
Actions define the notification mechanism and recipients.
1. Navigate: **Administration → Alert Configuration → Actions**
2. Click **New Action**.
3. Configure the Action Fields.
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`\
`ops@company.com`\
`ops@company.com`
8. Enable Trigger: Enable or disable the action.
1. Checked:\
*Action is active*
2. Unchecked:\
*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 | |
| Enabled | Yes |
Step 2: Create a Trigger
Triggers define alert conditions.
1. Navigate: **Administration → Alert Configuration → Triggers**
2. then, Click **New Trigger.**
3. Configure the Trigger Fields.
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:
| 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:
1. Checked: Trigger actively monitors metrics
2. Unchecked: Trigger is disabled
10. Save Trigger
11. Click **Save.**
The trigger becomes active immediately.\
Example: **Trigger**
Field
Value
Rule Name
Broker Count Low
Cluster Name
KAFKA_CLUSTER3
Component Name
Broker
Severity
Critical
Metric Name
BROKER_COUNT
Operator
<
Threshold Value
3
Action
Critical Email Alert
Enabled
Yes
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.livestreamiq.com/readme-1/4.-administration/4.5.-alert-configuration.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)