This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 46d609a95e [docs] add help documentation for alert integration (#3308)
46d609a95e is described below
commit 46d609a95eea34651859e89610c2c17da5ac1f0e
Author: Yang Chen <[email protected]>
AuthorDate: Wed Apr 30 16:05:59 2025 +0800
[docs] add help documentation for alert integration (#3308)
Co-authored-by: tomsun28 <[email protected]>
---
home/docs/help/alert_integration.md | 38 +++++++++++++++++++++
.../current/help/alert_integration.md | 32 +++++++++++++++++
home/sidebars.json | 15 ++++----
home/static/img/docs/help/alert_integration_cn.png | Bin 0 -> 260292 bytes
home/static/img/docs/help/alert_integration_en.png | Bin 0 -> 239576 bytes
5 files changed, 78 insertions(+), 7 deletions(-)
diff --git a/home/docs/help/alert_integration.md
b/home/docs/help/alert_integration.md
new file mode 100644
index 0000000000..ef3b605b35
--- /dev/null
+++ b/home/docs/help/alert_integration.md
@@ -0,0 +1,38 @@
+---
+id: alert_integration
+title: Alert Integration
+sidebar_label: Alert Integration
+keywords:
+ [
+ open-source monitoring,
+ alert integration,
+ alert management,
+ multi-source alerts,
+ ]
+---
+
+> The alert integration module of HertzBeat is designed to achieve unified
reception, standardized processing, and intelligent dispatching of alerts from
various third-party monitoring and observability platforms. As a centralized
"Alert Center," HertzBeat efficiently ingests external alert information and
applies flexible alert management strategies.
+
+### Core Capabilities
+
+- **Multi-Source Alert Ingestion**: Supports receiving alert messages from
major platforms such as Webhook, Prometheus, Alertmanager, SkyWalking, and
Tencent Cloud.
+- **Alert Format Standardization**: Converts alerts from different platforms
into a unified internal format within HertzBeat for easier processing.
+- **Comprehensive Alert Processing Mechanisms**, including:
+ - **Grouping and Convergence**: Manage alerts by grouping them based on
labels and deduplicate repeated alerts within a specific time window.
+ - **Inhibition**: Automatically suppresses secondary alerts when specific
conditions are met.
+ - **Silencing**: Temporarily disables alert notifications during system
maintenance or known issues to avoid unnecessary noise.
+
+### Supported Alert Sources
+
+HertzBeat currently supports alert integration from the following third-party
monitoring platforms:
+
+- **Webhook**: A generic integration method supporting customized alert format
push.
+- **Prometheus**: You can configure HertzBeat’s service address directly in
the Prometheus Server's Alertmanager configuration, allowing HertzBeat to
replace Alertmanager for receiving and handling Prometheus Server alerts.
+- **Alertmanager**: Supports forwarding alerts from Prometheus AlertManager to
the HertzBeat alert platform.
+- **SkyWalking**: Sends SkyWalking alerts to the HertzBeat alert platform via
Webhook.
+- **Tencent Cloud Monitoring**: Sends Tencent Cloud alerts to the HertzBeat
alert platform via Webhook.
+- **And more**：HertzBeat is actively expanding its integration support. If the
integration you need is not yet available, the community is actively
contributing and can assist in adding it.
+
+You can view the detailed integration methods and configuration examples
through the "Integration" interface in HertzBeat.
+
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_integration.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_integration.md
new file mode 100644
index 0000000000..498fb5bd35
--- /dev/null
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alert_integration.md
@@ -0,0 +1,32 @@
+---
+id: alert_integration
+title: 告警集成
+sidebar_label: 告警集成
+keywords: [开源监控, 告警集成, 告警管理, 多源告警]
+---
+
+> HertzBeat
的告警集成模块旨在实现对来自不同第三方监控与可观测性平台的告警进行统一接收、标准化处理与智能分发。作为一个集中式“告警中心”，HertzBeat
能够高效地接入外部系统的告警信息，并执行灵活的告警管理策略。
+
+### 核心能力
+
+- **多源告警接入**：支持从 Webhook、Prometheus、Alertmanager、SkyWalking、腾讯云等主流平台接收告警消息
+- **告警格式标准化**：将来自不同平台的告警数据转换为 HertzBeat 内部统一格式，便于后续处理
+- **丰富的告警处理机制**，包括：
+ - **分组收敛**：根据标签对告警进行分组管理，对时间段的相同重复告警去重收敛
+ - **抑制**：在满足特定条件时自动屏蔽次要告警
+ - **静默**：在系统维护或已知异常期间临时关闭告警通知，避免干扰
+
+### 已支持的告警来源
+
+HertzBeat 当前已支持以下第三方监控平台的告警接入：
+
+- **Webhook**：通用接入方式，支持自定义告警格式推送。
+- **Prometheus**：可以在 Prometheus Server 的 Alertmanager 配置中直接配置 HertzBeat
的服务地址，使用 HertzBeat 替换 Alertmanager 直接来接收处理 Prometheus Server 的告警信息。
+- **Alertmanager**：支持将 Prometheus AlertManager 的告警发送到 HertzBeat 告警平台。
+- **SkyWalking**：将 SkyWalking 的告警通过 Webhook 方式发送到 HertzBeat 告警平台。
+- **腾讯云监控**：将腾讯云的告警通过 Webhook 方式发送到 HertzBeat 告警平台。
+- **更多**：HertzBeat 正在积极扩展其集成支持。如果暂时没有找到你需要的集成，活跃的社区也可以协助你添加。
+
+你可以通过 HertzBeat 的“集成接入”界面查看具体的接入方式和配置示例。
+
+
diff --git a/home/sidebars.json b/home/sidebars.json
index e5edfc8472..f6e4482e89 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -30,7 +30,7 @@
{
"type": "category",
"label": "upgrade",
- "items": ["start/1.7.0-update","start/1.6.0-update", "start/upgrade"]
+ "items": ["start/1.7.0-update", "start/1.6.0-update",
"start/upgrade"]
},
{
"type": "category",
@@ -77,11 +77,12 @@
"label": "alert",
"items": [
"help/alarm_center",
- "help/alert_threshold",
+ "help/alert_threshold",
"help/alert_threshold_expr",
"help/alarm_group",
"help/alarm_inhibit",
- "help/alarm_silence"
+ "help/alarm_silence",
+ "help/alert_integration"
]
},
{
@@ -187,10 +188,10 @@
"type": "category",
"label": "server",
"items": [
- "help/ipmi",
- "help/hikvision_isapi",
- "help/dahua",
- "help/uniview"
+ "help/ipmi",
+ "help/hikvision_isapi",
+ "help/dahua",
+ "help/uniview"
]
},
{
diff --git a/home/static/img/docs/help/alert_integration_cn.png
b/home/static/img/docs/help/alert_integration_cn.png
new file mode 100644
index 0000000000..676394b1c3
Binary files /dev/null and b/home/static/img/docs/help/alert_integration_cn.png
differ
diff --git a/home/static/img/docs/help/alert_integration_en.png
b/home/static/img/docs/help/alert_integration_en.png
new file mode 100644
index 0000000000..0030ef015d
Binary files /dev/null and b/home/static/img/docs/help/alert_integration_en.png
differ
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
