This is an automated email from the ASF dual-hosted git repository. shushengzhou pushed a commit to branch alerting-silence in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
commit 02199d35ac874931e125a79db6eda1cdcb6f8319 Author: a-little-fool <[email protected]> AuthorDate: Thu Apr 10 17:47:05 2025 +0800 [doc] add alerting silence doc. --- home/docs/help/alarm_silence.md | 30 +++++++++++++++++++++ .../current/help/alarm_silence.md | 30 +++++++++++++++++++++ home/sidebars.json | 1 + home/static/img/docs/help/alert-silence-1.png | Bin 0 -> 62971 bytes home/static/img/docs/help/alert-silence-2.png | Bin 0 -> 40029 bytes 5 files changed, 61 insertions(+) diff --git a/home/docs/help/alarm_silence.md b/home/docs/help/alarm_silence.md new file mode 100644 index 0000000000..f37c0bb589 --- /dev/null +++ b/home/docs/help/alarm_silence.md @@ -0,0 +1,30 @@ +--- +id: alarm_silence +title: Alert Silence +sidebar_label: Alert Silence +keywords: [ Open Source Monitoring System, Alert Silence ] +--- + +> The alert silence management allows you to configure silence policies to suppress alert notifications during specified time periods, such as during system maintenance or when you don’t want to be disturbed by alerts at night or on weekends. Alert silence rules support both one-time and periodic time periods, and can match specific alerts using labels and alert levels. + + +## One-Time Time Period Silence Configuration + +- Silence Strategy Name: A unique name to identify the silence policy; +- Match All: Whether to enable this silence policy for all alerts; +- Label Match: When "Apply to All" is disabled, you can match alerts to be silenced based on specified labels; +- Silence Type: Select "One Time Silence"; +- Silence Period: After selecting "One Time Silence", the silence period configuration is shown in the following image, which can be configured as needed +  +- Enable: Enable or disable the silence policy. + +## Periodic Time Period Silence Configuration + +- Silence Strategy Name: A unique name to identify the silence policy; +- Match All: Whether to enable this silence policy for all alerts; +- Label Match: When "Apply to All" is disabled, you can match alerts to be silenced based on specified labels; +- Silence Type: Select "Periodic Silence"; +- Choose Date: After selecting "Periodic Silence", you can configure the dates when alerts should be silenced; +- Silence Period: After selecting "Periodic Silence", the silence period configuration is shown in the following image, which can be configured as needed (e.g., silencing alerts during weekends) +  +- Enable: Enable or disable the silence policy. \ No newline at end of file diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alarm_silence.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alarm_silence.md new file mode 100644 index 0000000000..1d23ba666d --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/alarm_silence.md @@ -0,0 +1,30 @@ +--- +id: alarm_silence +title: 告警静默 +sidebar_label: 告警静默 +keywords: [ 开源监控系统, 告警静默 ] +--- + +> 告警静默管理用于您在系统维护期间或夜晚周末不想受到告警打扰时，可以配置系统静默策略，设置指定时间段内屏蔽告警通知。告警静默规则支持一次性时间段或周期性时间段，支持标签匹配和告警级别匹配部分告警。 + + +## 一次性时间段静默配置 + +- 策略名称：唯一标识静默策略的名称； +- 应用所有：是否对所有告警启用该静默策略； +- 匹配标签：当 `应用所有` 配置关闭时，可根据匹配标签匹配需要静默的告警； +- 静默类型：选择 `一次性静默` ; +- 静默时段：选择 `一次性静默` 类型后，静默时段设置如下图所示，可自行配置 +  +- 启用状态：启用或禁用该静默策略。 + +## 周期性时间段静默配置 + +- 策略名称：唯一标识静默策略的名称； +- 应用所有：是否对所有告警启用该静默策略； +- 匹配标签：当 `应用所有` 配置关闭时，可根据匹配标签匹配需要静默的告警； +- 静默类型：选择 `周期性静默` ; +- 选择日期: 选择 `周期性静默` 类型后，可以配置需要静默的日期; +- 静默时段：选择 `周期性静默` 类型后，静默时段设置如下图所示，可自行配置，比如在周末时间静默 +  +- 启用状态：启用或禁用该静默策略。 \ No newline at end of file diff --git a/home/sidebars.json b/home/sidebars.json index faa7f18ded..14e57cbe42 100755 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -237,6 +237,7 @@ "label": "reduce", "items": ["help/alarm_group","help/alarm_inhibit"] }, + "help/alarm_silence", { "type": "category", "label": "notice", diff --git a/home/static/img/docs/help/alert-silence-1.png b/home/static/img/docs/help/alert-silence-1.png new file mode 100644 index 0000000000..502c2a7b31 Binary files /dev/null and b/home/static/img/docs/help/alert-silence-1.png differ diff --git a/home/static/img/docs/help/alert-silence-2.png b/home/static/img/docs/help/alert-silence-2.png new file mode 100644 index 0000000000..7a82d2f007 Binary files /dev/null and b/home/static/img/docs/help/alert-silence-2.png differ --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
