Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions home/docs/help/alert_notification_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: alert_notification_overview
title: Alert Notification Overview
sidebar_label: Alert Notification Overview
keywords: [open source monitoring tool, open source alerter, alert notification, notification channel, notification policy]
---

> After the threshold is triggered, in addition to being displayed in the alarm center, HertzBeat can notify the designated recipients through various channels such as Email, DingTalk, WeChat Work, FeiShu, Telegram, Slack, Discord, SMS, WebHook, and more.

## How it works

Alert notification requires two steps to take effect:

1. **Add a recipient** — configure a recipient and select a notification channel (Email, DingTalk robot, Telegram bot, etc.).
2. **Configure a notification strategy** — associate the recipient with a strategy that defines which alerts are routed to which recipients.

> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**

## Supported notification channels

| Channel | Doc |
|---|---|
| Email | [Configure Email Notification](alert_email) |
| SMS | [Configure SMS Notification](alert_sms) |
| WebHook | [Configure WebHook Notification](alert_webhook) |
| Discord Bot | [Configure Discord Notification](alert_discord) |
| Slack Webhook | [Configure Slack Notification](alert_slack) |
| Telegram Bot | [Configure Telegram Notification](alert_telegram) |
| WeChat Work Robot | [Configure WeChat Work Robot Notification](alert_wework) |
| Enterprise WeChat App | [Configure Enterprise WeChat App Notification](alert_enterprise_wechat_app) |
| DingTalk Robot | [Configure DingDing Robot Notification](alert_dingtalk) |
| FeiShu Robot | [Configure FeiShu Robot Notification](alert_feishu) |
| FeiShu App | [Configure FeiShu App Notification](alert_feishu_app) |
| Huawei Cloud SMN | [Configure Huawei Cloud SMN Notification](alert_smn) |

For customizing the content and format of notification messages, see [Notification Template](alert_notification_template).

## Operation steps

1. **【Alarm Notification】->【Add Recipient】->【Select notification method】->【Fill in channel configuration】->【Confirm】**

![email](/img/docs/help/alert-notice-1.png)

2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】->【Associate the recipient just set】->【Confirm】**

> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**

![email](/img/docs/help/alert-notice-policy.png)

### Alert notification common issues

1. Added a recipient but not receiving any alarm notifications.

> Please check whether there is any triggered alarm information in the alarm center.
> Please confirm that an alarm notification policy has been configured and is associated with the recipient.

2. Self-hosted HertzBeat cannot send email notifications.

> HertzBeat needs to configure its own mail server. Please confirm whether the mail server settings are configured in `application.yml`.

Other issues can be fed back through the communication group ISSUE!
11 changes: 8 additions & 3 deletions home/docs/help/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,20 @@ More details see&emsp;&#x1F449;&emsp;[Alarm grouping](alarm_group) <br />
> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification.
> After setting the receiver, you need to set the associated alarm notification strategy to configure which alarm information is sent to which receiver.

&emsp;&#x1F449;&emsp;[Notification Overview](alert_notification_overview) <br />
&emsp;&#x1F449;&emsp;[Configure Email Notification](alert_email) <br />
&emsp;&#x1F449;&emsp;[Configure Discord Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure Slack Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure Telegram Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure SMS Notification](alert_sms) <br />
&emsp;&#x1F449;&emsp;[Configure WebHook Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure Discord Notification](alert_discord) <br />
&emsp;&#x1F449;&emsp;[Configure Slack Notification](alert_slack) <br />
&emsp;&#x1F449;&emsp;[Configure Telegram Notification](alert_telegram) <br />
&emsp;&#x1F449;&emsp;[Configure enterprise WeChat Robot Notification](alert_wework) <br />
&emsp;&#x1F449;&emsp;[Configure enterprise WeChat App Notification](alert_enterprise_wechat_app) <br />
&emsp;&#x1F449;&emsp;[Configure DingDing Robot Notification](alert_dingtalk) <br />
&emsp;&#x1F449;&emsp;[Configure FeiShu Robot Notification](alert_feishu) <br />
&emsp;&#x1F449;&emsp;[Configure FeiShu App Notification](alert_feishu_app) <br />
&emsp;&#x1F449;&emsp;[Configure Huawei Cloud SMN Notification](alert_smn) <br />
&emsp;&#x1F449;&emsp;[Notification Template](alert_notification_template) <br />

### Plugins

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
id: alert_notification_overview
title: 告警通知概览
sidebar_label: 告警通知概览
keywords: [开源监控工具, 开源告警系统, 告警通知, 通知渠道, 通知策略]
---

> 阈值触发后,除在告警中心展示外,HertzBeat 还可通过邮件、钉钉、企业微信、飞书、Telegram、Slack、Discord、短信、WebHook 等多种渠道通知指定接收人。

## 工作原理

告警通知需完成以下两步才能生效:

1. **新增接收人** — 配置接收人并选择通知渠道(邮件、钉钉机器人、Telegram Bot 等)。
2. **配置通知策略** — 将接收人关联到通知策略,策略决定哪些告警发送给哪些接收人。

> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人。**

## 支持的通知渠道

| 渠道 | 文档 |
|---|---|
| 邮件 | [告警邮件通知](alert_email) |
| 短信 | [告警短信通知](alert_sms) |
| WebHook | [告警 WebHook 通知](alert_webhook) |
| Discord 机器人 | [告警 Discord 通知](alert_discord) |
| Slack Webhook | [告警 Slack 通知](alert_slack) |
| Telegram 机器人 | [告警 Telegram 通知](alert_telegram) |
| 企业微信机器人 | [告警企业微信机器人通知](alert_wework) |
| 企业微信应用 | [告警企业微信应用通知](alert_enterprise_wechat_app) |
| 钉钉机器人 | [告警钉钉机器人通知](alert_dingtalk) |
| 飞书机器人 | [告警飞书机器人通知](alert_feishu) |
| 飞书应用 | [告警飞书应用通知](alert_feishu_app) |
| 华为云 SMN | [告警华为云 SMN 通知](alert_smn) |

如需自定义告警消息的内容与格式,请参考 [通知模板](alert_notification_template)。

## 操作步骤

1. **【告警通知】->【新增接收人】->【选择通知方式】->【填写渠道配置】->【确定】**

![email](/img/docs/help/alert-notice-1.png)

2. **配置关联的告警通知策略⚠️ 【新增通知策略】->【将刚设置的接收人关联】->【确定】**

> **注意⚠️ 新增了接收人并不代表已经生效可以接收告警信息,还需配置关联的告警通知策略,即指定哪些消息发给哪些接收人。**

![email](/img/docs/help/alert-notice-policy.png)

### 告警通知常见问题

1. 新增了接收人,但未收到任何告警通知。

> 请排查在告警中心是否已有触发的告警信息。
> 请确认已配置告警通知策略,并将该接收人关联至策略中。

2. 自建 HertzBeat 无法发送邮件通知。

> HertzBeat 需要自己配置邮件服务器,请确认是否在 `application.yml` 中配置了邮件服务器相关参数。

其它问题可以通过交流群ISSUE反馈哦!
1 change: 1 addition & 0 deletions home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@
"type": "category",
"label": "notice",
"items": [
"help/alert_notification_overview",
"help/alert_email",
"help/alert_sms",
"help/alert_webhook",
Expand Down
Loading