Skip to content

Commit b669d59

Browse files
pijiang3pijiang3
committed
add dingtalk alert docs
1 parent a2c8fdb commit b669d59

4 files changed

Lines changed: 168 additions & 0 deletions

File tree

‎flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.46 DingtalkAlert Integration.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "Dingtalk Alert Integration"
3+
description: "Generate a unique Dingtalk robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Dingtalk"
4+
date: "2025-05-19T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/en/flashduty/dingtalk-alert-integration-guide"
6+
---
7+
8+
Generate a unique Dingtalk robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Dingtalk.
9+
10+
<div class="hide">
11+
12+
## Operation Steps
13+
---
14+
15+
### Create Dingtalk Alert Integration
16+
17+
You can obtain a Dingtalk alert integration address through either of these two methods:
18+
19+
#### Using Dedicated Integration
20+
21+
Choose this method when you don't need to route alert events to different channels. It's simpler and recommended.
22+
23+
<details>
24+
<summary>Expand</summary>
25+
26+
1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
27+
2. Select the **Integration** tab, click **Add Integration** to enter the integration page
28+
3. Choose **Dingtalk Alert** integration and click **Save** to generate a card
29+
4. Click the generated card to view the **Dingtalk Alert Integration URL**, copy it for later use, and you're done
30+
31+
</details>
32+
33+
#### Using Shared Integration
34+
35+
Choose this method when you need to route alerts to different channels based on the alert event's payload information.
36+
37+
<details>
38+
<summary>Expand</summary>
39+
40+
1. Go to the Flashduty console, select **Integration Center => Alert Events** to enter the integration selection page
41+
2. Select **Dingtalk Alert** integration:
42+
- **Integration Name**: Define a name for the current integration
43+
- **Message Type**: Select Dingtalk alert message type, currently only Text and Markdown are supported
44+
- **Push Mode**: Choose when to trigger or recover alerts for Dingtalk notifications
45+
3. Copy the **Dingtalk Alert Integration URL** for later use
46+
4. Configure the default route and select the corresponding channel (after integration creation, you can go to `Routes` to configure more routing rules)
47+
5. Done
48+
49+
</details>
50+
</div>
51+
52+
### Customize Dingtalk Alert Integration
53+
54+
#### Dingtalk Alert Integration URL
55+
56+
The system will generate a unique Dingtalk alert integration URL for you. This URL is compatible with Dingtalk robot message protocol. When platforms only support Dingtalk robot channels, you can use this URL to receive corresponding messages.
57+
58+
#### Push Mode
59+
60+
By default, the system always creates new alerts for each message, but you can switch to these modes:
61+
62+
1. **Trigger or Update Alert Based on Message Title**: In this mode, when receiving a new message, the system searches for open alerts based on the message title. If an alert is found, it will be updated; otherwise, a new alert will be triggered.
63+
2. **Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.
64+
65+
- You need to fill in at least one **trigger** rule
66+
- You must set up regex extraction rules for Alert Key. The system uses this field to find historical alerts for updates or closure. **If regex extraction fails, the system will use the message title to generate an Alert Key** to ensure alerts won't be lost due to configuration errors
67+
- You can choose whether to discard messages when none of the rules match
68+
69+
Configuration example:
70+
71+
- Receive all messages, close the alert when the message content contains **RESOLVED**, otherwise trigger a new alert
72+
- Extract Alert Key from message title using the rule **/(.*)/**.
73+
74+
75+
### Notes
76+
- Dingtalk alert integration URL only supports Text and Markdown message types; other message types cannot be received
77+
- When Dingtalk message type is Text, Flashduty will generate a default alert title "Dingtalk Alert"
78+
79+
## Severity Mapping
80+
---
81+
82+
Currently, all alerts pushed to Flashduty through email integration are set to Warning severity.
83+

‎flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.46 钉钉告警集成指引.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "钉钉告警集成"
3+
description: "在 Flashduty 生成唯一的钉钉机器人地址，通过钉钉的方式将告警的发生与恢复同步到 Flashduty"
4+
date: "2025-05-19T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-alert-integration-guide"
6+
---
7+
8+
在 Flashduty 生成唯一的钉钉告警地址，通过钉钉告警地址将告警的发生与恢复同步到 Flashduty。
9+
10+
<div class="hide">
11+
12+
## 操作步骤
13+
---
14+
15+
### 创建钉钉告警集成
16+
17+
您可通过以下2种方式，获取一个钉钉告警集成地址，任选其一即可。
18+
19+
#### 使用专属集成
20+
21+
当您不需要将告警事件路由到不同的协作空间，优先选择此方式，更简单。
22+
23+
<details>
24+
<summary>展开</summary>
25+
26+
1. 进入 Flashduty 控制台，选择 **协作空间**，进入某个空间的详情页面
27+
2. 选择 **集成数据** tab，点击 **添加一个集成**，进入添加集成页面
28+
3. 选择 **钉钉告警** 集成，点击 **保存**，生成卡片。
29+
4. 点击生成的卡片，可以查看到 **钉钉告警集成地址**，复制备用，完成。
30+
31+
</details>
32+
33+
#### 使用共享集成
34+
35+
当您需要根据告警事件的 Payload 信息，将告警路由到不同的协作空间，优先选择此方式。
36+
37+
<details>
38+
<summary>展开</summary>
39+
40+
1. 进入 Flashduty 控制台，选择 **集成中心=>告警事件**，进入集成选择页面。
41+
2. 选择 **钉钉告警** 集成：
42+
- **集成名称**：为当前集成定义一个名称。
43+
- **消息类型**：选择钉钉告警消息类型，目前仅支持 Text、Markdown。
44+
- **推送模式**：选择钉钉告警在何种情况下触发或恢复告警。
45+
3. 复制当前页面的 **钉钉告警集成地址** 备用。
46+
4. 配置默认路由，并选择对应的协作空间（集成创建后可以前往 `路由` 进行更多路由规则的配置）。
47+
5. 完成。
48+
49+
</details>
50+
</div>
51+
52+
### 定制钉钉告警集成
53+
54+
#### 钉钉告警集成地址
55+
56+
系统会帮您生成一个唯一的钉钉告警集成地址，该地址兼容钉钉机器人消息的协议，在有的平台仅支持钉钉机器人通道时，您可以使用该地址来接收对应的消息。
57+
58+
#### 推送模式
59+
60+
默认系统总是为每一条消息创建新的告警，但您可以切换模式为：
61+
62+
1. **根据消息标题触发或更新告警**：该模式下，每当接收到新消息，系统会根据消息标题查找未关闭告警。如果找到告警则进行更新，否则系统会触发一条新的告警。
63+
2. **根据规则触发或关闭告警**：该模式下，每当接收到新消息，系统会根据您的规则进行消息匹配，匹配到的消息按照规则去触发新告警或关闭已有告警。
64+
65+
- 您至少需要填写一条**触发**规则；
66+
- 您必须设置 Alert Key 的正则提取规则。系统使用该字段来查找历史告警，以便对其进行更新或关闭；**如果正则提取失败，系统将使用消息标题来生成 Alert Key**，以确保告警不会因为配置错误而丢失；
67+
- 您可以选择，当所有的规则都不匹配时，是否丢弃消息。
68+
69+
配置示例：
70+
71+
- 接收所有消息，当消息内容中包含 **RESOVED** 字样时，关闭告警，否则触发新告警；
72+
- Alert Key 从消息标题中提取，规则为 **/(.\*)/**。
73+
74+
75+
### 注意事项
76+
- 钉钉告警集成地址仅支持接收 Text、Markdown 消息类型，其他消息无法接收。
77+
- 当钉钉消息类型是Text 时，Flashduty 会生成默认告警标题 “钉钉告警”。
78+
79+
## 严重程度映射关系
80+
---
81+
82+
当前邮件集成推送到 Flashduty 的告警等级均为Warning。
83+

‎src/en.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ import HuaweiyunAPM from "../flashduty/en/8. Integrations/8.1 Alerts integration
4545
import ZStack from "../flashduty/en/8. Integrations/8.1 Alerts integration/8.1.43 ZStack Integration.md?raw";
4646
import Keep from "../flashduty/en/8. Integrations/8.1 Alerts integration/8.1.44 Keep Integration.md?raw";
4747
import ElastAlert2 from "../flashduty/en/8. Integrations/8.1 Alerts integration/8.1.45 ElastAlert2 Integration.md?raw";
48+
import DingtalkAlert from "../flashduty/en/8. Integrations/8.1 Alerts integration/8.1.46 DingtalkAlert Integration.md?raw";
4849
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
4950

5051
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */

‎src/zh.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ import HuaweiyunAPM from "../flashduty/zh/8. 集成引导/8.1 告警集成/8.1.4
4545
import ZStack from "../flashduty/zh/8. 集成引导/8.1 告警集成/8.1.43 ZStack 告警集成指引.md?raw";
4646
import Keep from "../flashduty/zh/8. 集成引导/8.1 告警集成/8.1.44 Keep 集成指引.md?raw";
4747
import ElastAlert2 from "../flashduty/zh/8. 集成引导/8.1 告警集成/8.1.45 ElastAlert2 集成指引.md?raw";
48+
import DingtalkAlert from "../flashduty/zh/8. 集成引导/8.1 告警集成/8.1.46 钉钉告警集成指引.md?raw";
4849
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
4950

5051
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */

0 commit comments

Comments
 (0)