Merge pull request #79 from emqx/alarm

update doc for alarms

ecp/zh_CN/monitor/alarm_rules.md

@@ -15,6 +15,17 @@ ECP 统一告警通过设置告警相关规则实现对异常或故障的通知
 
 您同样可以通过 ECP 的过滤和筛选功能，从告警类型、告警消息、边缘服务名称、告警级别和告警时间等方面快速定位某条告警。
 
+### 历史告警删除
+
+ECP 支持对历史告警的清理，在**历史告警**选项卡中点击 **历史告警删除** 按钮，可选择按时间，或按条数删除历史告警记录。
+
+- 按时间删除：告警发生时间超出指定时间范围的所有历史告警记录将被删除。
+- 按条数删除：按告警发生时间，从最早的开始删除指定条数的历史告警记录。按条数删除单次操作删除上限为5万条。
+
+![delete](./_assets/alarms-delete.png)
+
+
+
 ## 告警基础设置
 
 以系统/组织/项目管理员的身份登录 ECP，在告警页面的**告警规则及推送设置**选项卡中，您可以对告警状态、通知范围、通知沉默时效进行设置。
@@ -113,3 +124,38 @@ ECP 支持设置一个或多个告警推送，不同的告警推送通过指定
 告警风暴发生后，将在**告警**页面突出显示以提醒用户。您在完成排除告警原因解决系统问题后，点击 **清除告警风暴** 按钮，当前项目的告警功能将恢复正常。
 
 ![alarm-storm](./_assets/alarm-storm.png)
+
+## 自定义告警
+
+如果您的边缘服务希望在业务处理过程中将其他的告警信息推送至 ECP，可以通过集成自定义告警 API 来实现。以系统/组织/项目管理员的身份登录 ECP，在告警页面的**告警规则及推送设置**选项卡中，您可以查看并复制自定义告警的 API 信息，包括请求 URL 及请求头部需要指定的 secret。如果需要重置 secret，请通过“刷新”按钮重新生成。
+
+ ![custom-alarm](./_assets/custom-alarm.png)
+
+### 示例
+
+*POST* {自定义告警 URL}
+
+请求头部：
+
+```
+X-ECP-Alarm-Token: {自定义告警 Secret}
+Content-Type: application/json
+```
+
+请求内容：
+
+- `message` 字段必须指定，类型为字符串，表示告警的具体内容，将展示在页面上当前告警/历史告警列表中。
+- `timestamp` 字段必须指定，类型为字符串，表示告警发生的时间戳（以秒为单位）。超过 10 分钟的告警信息将不会被接收。
+- `severity` 字段值需为 0 或 1，0 表示该条告警级别为一般，1表示告警级别为严重，默认值为 0。`severity` 字段值将影响告警的通知范围，请参考上文“**告警基础设置 > 通知范围**”部分。
+- `tag` 字段为可选字段，类型为字符串，表示标签名称。如果指定 `tag` 字段，将使用该标签名称对应的推送设置进行告警推送，请参考上文“**告警推送设置**”部分。如果未指定 `tag` 字段或指定的标签名称不存在，则该告警只显示在页面当前告警/历史告警列表中，不会进行邮件或 Webhook 的推送。
+- `uuid` 字段为可选字段，类型为字符串，表示该条告警的唯一标识。如果多条自定义告警使用了相同的 UUID，则这些告警将被视为同一条告警，受到沉默时效的控制，请参考上文“**告警基础设置 > 通知沉默时效**”部分。如果未指定 `uuid` 字段，ECP 将为每条自定义告警随机生成唯一标识。
+
+```json
+{
+    "message": "message details for custom alarm",
+    "timestamp": "1711433603",
+    "severity": 1,
+    "tag": "customTag",
+    "uuid": "of9MHKAj",
+}
+```