Skip to content

Commit 30c7b22

Browse files
bigcyyyunfan24Aias00
authored
[doc] add help documentation for Alarms Center (#3181)
Co-authored-by: yunfan24 <[email protected]> Co-authored-by: aias00 <[email protected]>
1 parent 7a3e23e commit 30c7b22

File tree

6 files changed

+138
-70
lines changed

6 files changed

+138
-70
lines changed

home/docs/help/alarm_center.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
id: alarm_center
3+
title: Alarm Center
4+
sidebar_label: Alarm Center
5+
keywords:
6+
[open-source monitoring system, alarm center, alarm management, alarm display]
7+
---
8+
9+
> The Alarm Center serves as a comprehensive visualization platform that displays all alarms after undergoing grouping, consolidation, suppression, and silencing processes. It encompasses both internally triggered threshold-based alarms and integrated third-party notifications.
10+
11+
## Alarm Sources
12+
13+
The HertzBeat Alarm Center manages notifications from two primary sources:
14+
15+
1. Internal Threshold-Triggered Alarms
16+
- Generated when monitoring metrics exceed predefined thresholds
17+
- Directly correlated with monitoring tasks and threshold rules configured within the system
18+
- Manageable through adjustment of monitoring parameters and threshold configurations
19+
2. Third-Party Integrated Alarms
20+
- Received through API interfaces from external systems
21+
- Compatible with various monitoring systems and alarm platforms
22+
- Processed through identical workflow as internal alarms
23+
24+
## Alarm Processing Mechanism
25+
26+
Before appearing in the Alarm Center, all notifications undergo several processing stages:
27+
28+
1. Grouping
29+
- Categorizes related alarms based on source, type, severity, and other attributes (labels)
30+
- Facilitates efficient management of high-volume alarms
31+
- Supports customizable grouping rules for diverse scenarios
32+
2. Consolidation
33+
- Mitigates notification fatigue from multiple similar alarms within short intervals
34+
- Presents consolidated alarms in a streamlined format, eliminating redundancy
35+
3. Suppression
36+
- Manages alarm dependencies
37+
- Suppresses secondary alarms when primary alarms are triggered
38+
- Supports configurable suppression rules based on alarm dependencies
39+
4. Silencing
40+
- Temporarily mutes specific alarms during designated periods
41+
- Ideal for system maintenance windows and known issue handling
42+
- Enables time-based silence rule configuration
43+
44+
## Alarm Center Interface
45+
46+
![alarm_center](/img/docs/help/alarm-center-1.png)
47+
48+
The Alarm Center provides a comprehensive view of all system alarms:
49+
50+
1. Alarm Display
51+
- Lists all alarms with crucial information including status, source, labels, and timestamps
52+
- Offers detailed view functionality for comprehensive alarm information and context
53+
2. Search Functionality
54+
- Enables rapid alarm identification
55+
- Supports multiple search criteria (labels, annotations, alarm status)
56+
3. Alarm Management
57+
- Alarm Deletion: Removes alarms no longer requiring attention

home/docs/help/guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ sidebar_label: Help Center
107107

108108
> The triggered alarm information center provides query and filtering of alarm deletion, alarm processing, mark unprocessed, alarm level status, etc.
109109
110+
More details see&emsp;&#x1F449;&emsp;[Alarm center](alarm_center)
111+
110112
### Alarm configuration
111113

112114
> The Metric threshold configuration provides the Metric threshold configuration in the form of expression, which can set the alarm level, trigger times, alarm notification template and whether it is enabled, correlation monitoring and other functions.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
id: alarm_center
3+
title: 告警中心
4+
sidebar_label: 告警中心
5+
keywords: [开源监控系统, 告警中心, 告警管理,告警显示]
6+
---
7+
8+
> 告警中心是一个展示平台,用于显示所有经过分组、收敛、抑制、静默等处理的告警,包括由内部系统阈值触发的告警和第三方接入告警。
9+
10+
## 告警来源
11+
12+
HertzBeat 的告警中心管理来自两个主要来源的告警:
13+
14+
1. 系统内部阈值触发的告警
15+
- 当监控指标超过预定义阈值时生成
16+
- 与系统中配置的监控任务和阈值规则直接相关
17+
- 可以通过调整监控任务和阈值设置进行控制
18+
2. 第三方接入告警
19+
- 通过 API 接口从外部系统接收
20+
- 支持与其他监控系统或告警平台集成
21+
- 与内部告警一样经过相同的处理流程
22+
23+
## 告警处理机制
24+
25+
在显示到告警中心之前,所有告警都会经过几个处理步骤:
26+
27+
1. 分组
28+
- 基于来源、类型、严重程度和其他属性(标签)对相关告警进行分类
29+
- 帮助高效管理大量告警
30+
- 支持针对不同场景的自定义分组规则
31+
2. 收敛
32+
- 减少短时间内发生的多个类似告警产生的干扰
33+
- 以更简洁的方式呈现收敛后的告警,避免信息冗余
34+
3. 抑制
35+
- 处理告警之间的依赖关系
36+
- 当关键告警触发时,可以抑制相关的次要告警
37+
- 支持配置定义告警依赖关系的抑制规则
38+
4. 静默
39+
- 在特定时间段内暂时屏蔽某些告警
40+
- 适用于系统维护、已知问题处理等场景
41+
- 可以基于时间设置静默规则
42+
43+
## 告警中心界面
44+
45+
![alarm_center](/img/docs/help/alarm-center-1.png)
46+
47+
告警中心提供了系统所有告警的全面视图:
48+
49+
1. 告警显示
50+
- 列出所有告警,包含告警状态、来源、标签和时间等关键信息
51+
- 提供详细视图功能,显示完整的告警信息和上下文
52+
2. 搜索功能
53+
- 帮助快速定位特定告警
54+
- 支持多种搜索(标签、注解、告警状态等)
55+
3. 告警管理
56+
- 告警删除:移除不再需要关注的告警

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ sidebar_label: 帮助入门
107107

108108
> 已触发的告警信息中心,提供告警删除,告警处理,标记未处理,告警级别状态等查询过滤。
109109
110+
详见&emsp;&#x1F449;&emsp;[告警中心](alarm_center)
111+
110112
### 告警配置
111113

112114
> 指标阈值配置,提供表达式形式的指标阈值配置,可设置告警级别,触发次数,告警通知模版和是否启用,关联监控等功能。

home/sidebars.json

Lines changed: 21 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,19 @@
2323
{
2424
"type": "category",
2525
"label": "extern-deploy",
26-
"items": [
27-
"start/baota-deploy",
28-
"start/rainbond-deploy"
29-
]
26+
"items": ["start/baota-deploy", "start/rainbond-deploy"]
3027
}
3128
]
3229
},
3330
{
3431
"type": "category",
3532
"label": "upgrade",
36-
"items": [
37-
"start/1.6.0-update",
38-
"start/upgrade"
39-
]
33+
"items": ["start/1.6.0-update", "start/upgrade"]
4034
},
4135
{
4236
"type": "category",
4337
"label": "setting",
44-
"items": [
45-
"start/account-modify",
46-
"start/custom-config"
47-
]
38+
"items": ["start/account-modify", "start/custom-config"]
4839
},
4940
{
5041
"type": "category",
@@ -60,9 +51,7 @@
6051
{
6152
"type": "category",
6253
"label": "use-case",
63-
"items": [
64-
"start/ssl-cert-practice"
65-
]
54+
"items": ["start/ssl-cert-practice"]
6655
}
6756
]
6857
},
@@ -132,11 +121,7 @@
132121
{
133122
"type": "category",
134123
"label": "cache",
135-
"items": [
136-
"help/redis",
137-
"help/memcached",
138-
"help/valkey"
139-
]
124+
"items": ["help/redis", "help/memcached", "help/valkey"]
140125
},
141126
{
142127
"type": "category",
@@ -160,9 +145,7 @@
160145
{
161146
"type": "category",
162147
"label": "server",
163-
"items": [
164-
"help/ipmi"
165-
]
148+
"items": ["help/ipmi"]
166149
},
167150
{
168151
"type": "category",
@@ -212,55 +195,37 @@
212195
{
213196
"type": "category",
214197
"label": "webserver",
215-
"items": [
216-
"help/tomcat",
217-
"help/jetty"
218-
]
198+
"items": ["help/tomcat", "help/jetty"]
219199
},
220200
{
221201
"type": "category",
222202
"label": "cloud-native",
223-
"items": [
224-
"help/docker",
225-
"help/kubernetes"
226-
]
203+
"items": ["help/docker", "help/kubernetes"]
227204
},
228205
{
229206
"type": "category",
230207
"label": "llm",
231-
"items": [
232-
"help/openai"
233-
]
208+
"items": ["help/openai"]
234209
},
235210
{
236211
"type": "category",
237212
"label": "aiConfig",
238-
"items": [
239-
"help/aiConfig"
240-
]
213+
"items": ["help/aiConfig"]
241214
},
242215
{
243216
"type": "category",
244217
"label": "custom",
245-
"items": [
246-
"help/kafka_promql",
247-
"help/influxdb_promql"
248-
]
218+
"items": ["help/kafka_promql", "help/influxdb_promql"]
249219
},
250220
{
251221
"type": "category",
252222
"label": "network",
253-
"items": [
254-
"help/huawei_switch"
255-
]
223+
"items": ["help/huawei_switch"]
256224
},
257225
{
258226
"type": "category",
259227
"label": "threshold",
260-
"items": [
261-
"help/alert_threshold",
262-
"help/alert_threshold_expr"
263-
]
228+
"items": ["help/alert_threshold", "help/alert_threshold_expr"]
264229
},
265230
{
266231
"type": "category",
@@ -284,6 +249,7 @@
284249
"help/plugin",
285250
"help/time_expression",
286251
"help/grafana_dashboard",
252+
"help/alarm_center",
287253
"help/issue"
288254
]
289255
},
@@ -307,44 +273,32 @@
307273
{
308274
"type": "category",
309275
"label": "jdbc",
310-
"items": [
311-
"advanced/extend-jdbc"
312-
]
276+
"items": ["advanced/extend-jdbc"]
313277
},
314278
{
315279
"type": "category",
316280
"label": "ssh",
317-
"items": [
318-
"advanced/extend-ssh"
319-
]
281+
"items": ["advanced/extend-ssh"]
320282
},
321283
{
322284
"type": "category",
323285
"label": "telnet",
324-
"items": [
325-
"advanced/extend-telnet"
326-
]
286+
"items": ["advanced/extend-telnet"]
327287
},
328288
{
329289
"type": "category",
330290
"label": "jmx",
331-
"items": [
332-
"advanced/extend-jmx"
333-
]
291+
"items": ["advanced/extend-jmx"]
334292
},
335293
{
336294
"type": "category",
337295
"label": "snmp",
338-
"items": [
339-
"advanced/extend-snmp"
340-
]
296+
"items": ["advanced/extend-snmp"]
341297
},
342298
{
343299
"type": "category",
344300
"label": "NGQL",
345-
"items": [
346-
"advanced/extend-ngql"
347-
]
301+
"items": ["advanced/extend-ngql"]
348302
}
349303
]
350304
},
@@ -392,10 +346,7 @@
392346
{
393347
"type": "category",
394348
"label": "Others",
395-
"items": [
396-
"others/resource"
397-
]
349+
"items": ["others/resource"]
398350
}
399351
]
400352
}
401-
242 KB
Loading

0 commit comments

Comments
 (0)