Skip to content

Commit c1cf699

Browse files
authored
Merge pull request #410 from flashcatcloud/codex/aliyun-dataworks-op-console-steps
docs: fix DataWorks Operation Center console steps (test)
2 parents 1e9f0b3 + e32c4bb commit c1cf699

2 files changed

Lines changed: 31 additions & 73 deletions

File tree

‎en/on-call/integration/alert-integration/alert-sources/aliyun-dataworks-op.mdx‎

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,25 +47,16 @@ Choose this option when you need to route alerts to different collaboration spac
4747

4848
## In Alibaba Cloud DataWorks
4949
---
50-
**Step 1: Create a custom webhook**
51-
5250
<div className="md-block">
5351

5452
1. Log in to the Alibaba Cloud console and open the **DataWorks** product
55-
2. Go to **DataStudio** or **Operation Center** and open the **Intelligent Monitoring** page
56-
3. Open the alarm receiver configuration (the custom webhook entry) and create a new webhook
57-
4. Set the request URL to the Flashduty integration push URL copied above; the request method is POST
58-
5. After saving, you can click **Send test message**. DataWorks pushes a connectivity test message (`message.content`); Flashduty returns success without creating an alert event
59-
60-
</div>
61-
62-
**Step 2: Enable the webhook in monitoring rules**
63-
64-
<div className="md-block">
53+
2. Go to **Data Development and O&M => Operation Center**
54+
3. In the left navigation, choose **Monitoring and Alerting => Rule Management**
55+
4. Open an existing rule, or create a new one
56+
5. In the rule's **Alarm Behavior** section, select **WebHook** as the alarm method, and paste the Flashduty integration push URL copied above into the webhook address field
57+
6. Save the rule. Alerts triggered by this rule are pushed to Flashduty in real time
6558

66-
1. In **Intelligent Monitoring**, open the **custom rules** (instance status alerts, resource group alerts), **baseline management**, or **event management** page
67-
2. Create or edit a rule, and select the custom webhook created above as an alarm channel
68-
3. Save the rule. Alerts triggered by this rule are pushed to Flashduty in real time
59+
> After entering the URL, you can click **Send test message** to verify connectivity. The test message only verifies the push URL; Flashduty returns success without creating an alert event.
6960
7061
</div>
7162

‎zh/on-call/integration/alert-integration/alert-sources/aliyun-dataworks-op.mdx‎

Lines changed: 25 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -47,25 +47,16 @@ keywords: ["告警集成", "阿里云 DataWorks 集成", "DataWorks 智能监控
4747

4848
## 在阿里云 DataWorks
4949
---
50-
**步骤 1:创建自定义 Webhook**
51-
5250
<div className="md-block">
5351

5452
1. 登录阿里云控制台,进入 **DataWorks** 产品
55-
2. 进入 **数据开发(DataStudio)** 或 **运维中心**,打开 **智能监控** 页面
56-
3. 进入 **报警接收配置**(或 **自定义 webhook** 配置入口),新建一个 Webhook
57-
4. `请求地址` 填写 Flashduty 集成的推送地址(上一步复制),`请求方法` 为 POST
58-
5. 保存后,可点击 **发送测试消息**,DataWorks 会推送一条连通性测试消息(`message.content`),Flashduty 收到后返回成功但不产生告警事件
59-
60-
</div>
61-
62-
**步骤 2:在监控规则中启用 Webhook**
63-
64-
<div className="md-block">
53+
2. 进入 **数据开发与运维 => 运维中心**
54+
3. 在左侧导航选择 **监控告警 => 规则管理**
55+
4. 打开一个已有规则,或新建规则
56+
5. 在规则的 **报警行为** 区域,报警方式勾选 **WebHook**,并在 **Webhook地址** 中填写 Flashduty 集成的推送地址(上一步复制)
57+
6. 保存规则,完成。此后该规则触发的告警会实时推送到 Flashduty
6558

66-
1. 进入 **智能监控** 的 **自定义规则**(周期实例状态告警、资源组告警)、**基线管理** 或 **事件管理** 页面
67-
2. 创建或编辑规则,在 **报警方式** 中勾选上一步创建的自定义 Webhook
68-
3. 保存规则,完成。此后该规则触发的告警会实时推送到 Flashduty
59+
> 填写地址后可点击 **发送测试消息** 验证连通性;测试消息仅用于验证推送地址,Flashduty 收到后返回成功但不产生告警事件。
6960
7061
</div>
7162

@@ -78,45 +69,45 @@ DataWorks 智能监控自定义 Webhook 推送的消息统一包裹在 `message`
7869
| message.title | 告警类型 | 说明 |
7970
| ------------- | -------- | ---- |
8071
| `DataWorks_Remind` | 自定义告警 | 周期实例状态告警(remind_unit 为 Task、Baseline、Project、BizProcess)与资源组告警(ScheduleResourceGroup、DiResourceGroup) |
81-
| `DataWorks_Baseline_Alert` | 基线告警 | 基线预警(dangerous)与破线(overSla) |
82-
| `DataWorks_Event_Remind` | 事件告警 | 任务出错(ERROR)与变慢(SLOW) |
72+
| `DataWorks_Baseline_Alert` | 基线告警 | 基线预警与破线 |
73+
| `DataWorks_Event_Remind` | 事件告警 | 任务出错与变慢 |
8374

84-
连通性测试消息(`message.content`)仅用于验证推送地址,不会产生告警事件。
75+
连通性测试消息仅用于验证推送地址,不会产生告警事件。
8576

8677
</div>
8778

8879
## 严重程度对照
8980
---
9081
<div className="md-block">
9182

92-
DataWorks 自定义告警 `remind_type` 到 Flashduty 告警等级(Severity)映射关系:
83+
DataWorks 自定义告警 `remind_type` 到 Flashduty 告警等级映射关系:
9384

9485
| DataWorks remind_type | Flashduty | 状态 |
9586
| --------------------- | --------- | ---- |
96-
| error(出错) | Critical | 严重 |
97-
| exhausted error(自动重跑仍出错) | Critical | 严重 |
98-
| uncompleted(未完成) | Warning | 警告 |
99-
| cycle uncompleted(周期未完成) | Warning | 警告 |
100-
| run over time(运行超时) | Warning | 警告 |
101-
| resGroup use ratio(资源组利用率) | Warning | 警告 |
102-
| the number of waiting task in resGroup(资源组等待资源实例数) | Warning | 警告 |
103-
| completed(完成) | Info | 提醒 |
87+
| error | Critical | 严重 |
88+
| exhausted error | Critical | 严重 |
89+
| uncompleted | Warning | 警告 |
90+
| cycle uncompleted | Warning | 警告 |
91+
| run over time | Warning | 警告 |
92+
| resGroup use ratio | Warning | 警告 |
93+
| the number of waiting task in resGroup | Warning | 警告 |
94+
| completed | Info | 提醒 |
10495
| 空值或未知值 | Warning | 警告 |
10596

10697
基线告警 `status` 映射关系:
10798

10899
| DataWorks status | Flashduty | 状态 |
109100
| ---------------- | --------- | ---- |
110-
| overSla(破线) | Critical | 严重 |
111-
| dangerous(预警) | Warning | 警告 |
101+
| overSla | Critical | 严重 |
102+
| dangerous | Warning | 警告 |
112103
| 空值或未知值 | Warning | 警告 |
113104

114105
事件告警 `event_type` 映射关系:
115106

116107
| DataWorks event_type | Flashduty | 状态 |
117108
| -------------------- | --------- | ---- |
118-
| ERROR(出错) | Critical | 严重 |
119-
| SLOW(变慢) | Warning | 警告 |
109+
| ERROR | Critical | 严重 |
110+
| SLOW | Warning | 警告 |
120111
| 空值或未知值 | Warning | 警告 |
121112

122113
</div>
@@ -125,46 +116,22 @@ DataWorks 自定义告警 `remind_type` 到 Flashduty 告警等级(Severity)
125116
---
126117
<div className="md-block">
127118

128-
DataWorks 智能监控 Webhook 属于**一次性事件**(one-shot):官方协议只定义告警通知,**不恢复**、无更新语义,也没有提供厂商级别的去重 ID 或指纹字段。因此本集成不会自动恢复(关闭)任何告警,所有事件均以触发状态投递。
119+
DataWorks 智能监控 Webhook 属于**一次性事件**:官方协议只定义告警通知,**不恢复**、无更新语义,也没有提供厂商级别的去重 ID 或指纹字段。因此本集成不会自动恢复(关闭)任何告警,所有事件均以触发状态投递。
129120

130121
每次 webhook 投递都会生成一个全新的随机 UUID 作为 Alert Key,即每条推送都会创建一条独立的告警事件,重复触发不会自动合并。如需降噪,请在 Flashduty 中配置告警聚合或收敛策略。
131122

132123
</div>
133124

134-
## 字段标签对照
135-
---
136-
<div className="md-block">
137-
138-
推送消息中的主要字段会以标签(Labels)形式保留在告警事件中,可用于路由、静默与模板渲染:
139-
140-
| 标签 | 来源字段 | 说明 |
141-
| ---- | -------- | ---- |
142-
| alert_type | title | 告警类型(DataWorks_Remind 等) |
143-
| remind_name | remind_name | 规则名称 |
144-
| remind_unit | remind_unit | 监控粒度(Task、ScheduleResourceGroup 等) |
145-
| remind_type | remind_type | 触发条件原始值 |
146-
| occur_time | occur_time | 发生时间原文 |
147-
| remind_founder | remind_founder | 规则创建人 |
148-
| more_information | more_information | 运维中心周期实例链接 |
149-
| task_size / number_of_alerts | 同名字段 | 任务数量 / 第几次告警 |
150-
| node_id_list / node_name_list / node_owner_list | 同名字段 | 节点 ID / 名称 / 责任人列表(英文逗号分隔,最多 5 个) |
151-
| resource_group_name / threshold / duration | 同名字段 | 资源组名 / 阈值 / 持续时间(分钟),资源组监控特有 |
152-
| baseline_name / baseline_owners | 同名字段 | 基线名 / 基线责任人 |
153-
| cycle_number / key_instance / sla_time / buffer / status | 同名字段 | 周期号 / 关键实例 / 承诺时间 / 余量(分钟)/ 基线状态 |
154-
| task_name / task_owner_name / event_type / event_name | 同名字段 | 任务名 / 责任人 / 事件类型 / 事件名称 |
155-
156-
</div>
157-
158125
## 常见问题
159126
---
160127
<div className="md-block">
161128

162129
**为什么告警不会自动恢复?**
163130

164-
DataWorks 智能监控 Webhook 协议没有定义恢复(resolve)消息,属于一次性通知。如需关闭告警,请在 Flashduty 控制台手动处理,或为规则配置告警收敛策略。
131+
DataWorks 智能监控 Webhook 协议没有定义恢复消息,属于一次性通知。如需关闭告警,请在 Flashduty 控制台手动处理,或为规则配置告警收敛策略。
165132

166133
**发送测试消息后为什么看不到告警?**
167134

168-
DataWorks 的连通性测试消息(`message.content`)仅用于验证推送地址可达,Flashduty 收到后返回成功但不生成告警事件。请通过真实触发规则来验证端到端链路。
135+
DataWorks 的连通性测试消息仅用于验证推送地址可达,Flashduty 收到后返回成功但不生成告警事件。请通过真实触发规则来验证端到端链路。
169136

170137
</div>

0 commit comments

Comments
 (0)