Skip to content

Commit 4cedc4c

Browse files
Revise formatting and content in Alerting.md
Updated the Apache NiFi Alerting System documentation to improve clarity and consistency in formatting.
1 parent 0711ba4 commit 4cedc4c

File tree

1 file changed

+46
-26
lines changed

1 file changed

+46
-26
lines changed

Alerting/Alerting.md

Lines changed: 46 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Apache NiFi Alerting System
22
The flow continuously monitors system and NiFi metrics (CPU, RAM, Threads, Disk usage, etc.), evaluates them against predefined thresholds, and triggers alerts via HTTP and Email when anomalies are detected.
3+
34
The alerting pipeline is built around the following logical stages:
4-
-**Flow Triggering**
5-
-**Metrics Collection**
6-
-**Metrics Extraction**
7-
-**Threshold Evaluation**
8-
-**Routing**
9-
-**Notification**
5+
6+
- **Flow Triggering**
7+
- **Metrics Collection**
8+
- **Metrics Extraction**
9+
- **Threshold Evaluation**
10+
- **Routing**
11+
- **Notification**
12+
1013
## Main Alerting Process Group
1114
![Main Alerting Process Group](../images/Principale_AlertingFlow.png)
1215
## Metrics System Alerting – Sub Process Group
@@ -15,32 +18,43 @@ The alerting pipeline is built around the following logical stages:
1518
![Metrics System Alerting Flow p1](../images/AlertinSystem_p1.png)
1619
![Metrics System Alerting Flow p2](../images/AlertingSystem_p2.png)
1720
## Processors Description
18-
-**GenerateFlowFile**
21+
- **GenerateFlowFile**
22+
1923
Acts as a scheduler to trigger the monitoring flow periodically.
2024
![GenerateFlowFile](../images/generatF.png)
21-
-**InvokeHTTP**
25+
- **InvokeHTTP**
26+
2227
Metrics Collection
2328
![InvokeHTTP](../images/inv_http_sys.png)
29+
2430
Calls a monitoring endpoint (NiFi API / system metrics API).
31+
2532
GET /nifi-api/system-diagnostics
33+
2634
![system metrics API](../images/API_SYS.png)
27-
-**EvaluateJsonPath**
35+
- **EvaluateJsonPath**
36+
2837
Extracts metrics from the JSON response.
2938
![EvaluateJsonPath](../images/Json_sys.png)
30-
-**UpdateAttribute**
39+
- **UpdateAttribute**
40+
3141
Normalizes metrics and defines the necessary attributes, such as metric thresholds for alerts.
3242
![UpdateAttribute](../images/Updat_atri.png)
33-
-**RouteOnAttribute**
43+
- **RouteOnAttribute**
44+
3445
Alert Detection : Compares metrics against thresholds and routes FlowFiles.
3546
![RouteOnAttribute](../images/onrot.png)
36-
-**ReplaceText**
47+
- **ReplaceText**
48+
3749
Alert Message Formatting : Builds a clean and readable alert message.
3850
![ReplaceText](../images/replace_text.png)
3951
## Notification Processors
40-
-**PutEmail**
52+
- **PutEmail**
53+
4154
Sends alert notifications via email.
4255
![PutEmail](../images/PUTEMAIL_CONFIG.png)
43-
-**InvokeHTTP (Webhook / API)**
56+
- **InvokeHTTP (Webhook / API)**
57+
4458
Sends alerts to external systems (Slack, Teams, Monitoring API, etc.).
4559
![InvokeHTTP (Webhook / API)](../images/inv_http_url.png)
4660

@@ -50,38 +64,44 @@ Sends alerts to external systems (Slack, Teams, Monitoring API, etc.).
5064
![Queue Alerting Flow](../images/Alerting_Que.png)
5165
## Processors Description
5266
In this sub-process group, we use the same processors; the only difference is the API endpoint used to extract different NiFi metrics.
53-
-**InvokeHTTP**
67+
- **InvokeHTTP**
68+
5469
Metrics Collection
5570
![InvokeHTTP2](../images/inv_http_que.png)
71+
5672
Calls a monitoring endpoint (NiFi API / system metrics API).
73+
5774
GET /nifi-api/flow/status
75+
5876
![system metrics API2](../images/API_QU.png)
59-
-**EvaluateJsonPath**
77+
- **EvaluateJsonPath**
78+
6079
Extracts metrics from the JSON response.
80+
6181
![EvaluateJsonPath2](../images/json_que.png)
6282

6383
## Results
6484
## Email Notification
65-
-**CPU metric alert**
85+
- **CPU metric alert**
6686
![CPU metric alert](../images/cpu_Em.png)
67-
-**Threads metric alert**
87+
- **Threads metric alert**
6888
![threads metric alert](../images/threads_Em.png)
69-
-**Que FlowFile metric alert**
89+
- **Que FlowFile metric alert**
7090
![Que FlowFile metric alert](../images/que_flofil_Em.png)
7191

7292
## Webhook / API Notification
73-
-**CPU metric alert**
93+
- **CPU metric alert**
7494
![CPU metric alert1](../images/cpu_urll.png)
75-
-**Threads metric alert**
95+
- **Threads metric alert**
7696
![Threads metric alert1](../images/THRED_urll.png)
77-
-**Que FlowFile metric alert**
97+
- **Que FlowFile metric alert**
7898
![Que FlowFile metric alert1](../images/quefil_urll.png)
7999

80100
## Requirements
81-
-Apache NiFi 1.22
82-
-Access to metrics endpoint
83-
-SMTP server (for email alerts)
84-
-Optional webhook endpoint
101+
- Apache NiFi 1.22
102+
- Access to metrics endpoint
103+
- SMTP server (for email alerts)
104+
- Optional webhook endpoint
85105

86106

87107

0 commit comments

Comments
 (0)