AI 助理
文档备案控制台
官方文档
首页 大数据开发治理平台 DataWorks 用户指南 运维中心 任务监控 自定义Webhook与运维监控报警信息对接方案

自定义Webhook与运维监控报警信息对接方案

更新时间：
复制 MD 格式
产品详情
我的收藏

使用DataWorks监控报警功能的自定义Webhook服务时，DataWorks默认通过公网推送报警信息。您可根据Webhook服务的部署环境选择对接方式：公网方式需将DataWorks的公网出口IP地址加入到Webhook服务的白名单中；内网方式则需为自定义Webhook指定与该服务网络连通的资源组，由该资源组发送告警消息，以确保报警信息能够成功传送。

使用范围

  • 网络限制：默认通过公网方式推送。如果您的 Webhook 服务部署在内网环境，可在租户告警策略中为自定义 Webhook 指定与该服务网络连通的资源组，由该资源组发送告警消息。两种对接方式的配置详情，请分别参见公网方式和内网方式。

  • 版本限制：仅DataWorks企业版支持自定义WebHook。

网络配置

DataWorks 默认通过公网向 Webhook 服务推送报警信息。您可根据 Webhook 服务的部署环境选择公网方式或内网方式。

公网方式

DataWorks默认通过公网向您的Webhook服务推送报警信息，无需额外配置网络。

说明

如果您的Webhook服务未启用白名单访问控制，则可忽略该操作步骤。

如果您的Webhook服务启用了白名单访问控制，您需将以下的DataWorks公网IP地址添加至Webhook服务的IP白名单中。

地域名称

地域ID

IP地址

华北2（北京）

cn-beijing

47.93.5.9,47.93.60.157,47.94.111.106,59.110.166.34,60.205.184.153,60.205.227.157,60.205.223.44,123.56.217.46,123.57.155.168,123.57.243.71

华北3（张家口）

cn-zhangjiakou

39.100.0.109,39.100.9.117,39.100.9.121

华东1（杭州）

cn-hangzhou

47.96.30.97,47.97.175.135,116.62.247.242,120.27.233.168,121.40.70.19,121.199.31.66,121.199.41.143,121.199.61.16

华东2（上海）

cn-shanghai

47.100.10.242,47.101.166.155,47.101.179.29,47.101.196.116,101.132.179.94,106.14.1.102,106.15.197.122,106.15.202.114

华南1（深圳）

cn-shenzhen

47.107.81.9,47.112.11.104,47.112.21.108,47.112.22.239,47.112.23.85

马来西亚（吉隆坡）

ap-southeast-3

47.254.198.127,47.254.200.185

日本（东京）

ap-northeast-1

47.74.22.81,47.74.23.43

韩国（首尔）

ap-northeast-2

47.80.13.207,47.80.10.92

西南1（成都）

cn-chengdu

47.108.64.120,47.108.119.242

新加坡

ap-southeast-1

47.74.209.97,47.74.229.187,47.74.243.124

印度尼西亚（雅加达）

ap-southeast-5

149.129.253.151,149.129.253.185

中国香港

cn-hongkong

47.52.128.224,47.244.33.205

德国（法兰克福）

eu-central-1

47.91.89.154,47.254.153.91

美国（弗吉尼亚）

us-east-1

47.89.191.99,47.90.253.133

美国（硅谷）

us-west-1

47.88.4.25,47.88.6.226

英国（伦敦）

eu-west-1

8.208.12.7,8.208.15.6

华东2 金融云

cn-shanghai-finance-1

139.224.120.181,139.224.122.217,139.224.144.132,139.224.145.23,139.224.149.100

华南1 金融云

cn-shenzhen-finance-1

112.74.242.199,112.74.244.59,112.74.246.74,112.74.246.212

华北-金融云

cn-beijing-finance-1

8.141.252.42,8.141.252.231

政务云

cn-north-2-gov-1

39.107.177.30,39.107.177.140

沙特（利雅得）

me-central-1

8.213.30.84,8.213.30.232

内网方式

如果您的Webhook服务部署在内网环境，您可在租户告警策略中为自定义Webhook指定与该服务网络连通的资源组，由该资源组发送告警消息，使报警信息不出内网，信息传输更安全。

  1. 登录DataWorks控制台，进入运维中心后，在左侧导航栏单击监控报警 > 规则管理。

  2. 单击租户告警策略设置。

  3. 为自定义Webhook资源组选择与您的Webhook服务网络连通的资源组（仅支持Serverless资源组），完成配置。租户告警策略的更多说明，请参见租户告警策略设置。资源组网络配置请参见：配置网络连通。

说明

未选择资源组时，租户内的自定义Webhook沿用默认的公网方式发送。配置生效后，报警信息页面顶部会提示当前租户的自定义Webhook已启用资源组发送，您可单击提示中的修改配置调整该设置。

消息格式适配

DataWorks 向自定义 Webhook 服务推送的报警消息为 JSON 格式。以下为各类告警的连通性测试报文、消息体示例及字段含义说明。

连通性测试

{
 "message":{
 "content": "DataWorks Workbench Alarm Connectivity Test"
 }
}

自定义告警

消息体

周期实例状态告警

{
 "message": {
 "title": "DataWorks_Remind",
 "remind_name": "webhookTest",
 "remind_unit": "Task"
 "occur_time": "2021-07-13 16:16:20",
 "remind_type": "uncompleted",
 "task_size": 1,
 "node_id_list": "220167523",
 "node_name_list": "nodeName",
 "node_owner_list": "123123123",
 "remind_founder": "jingyan20182222",
 "number_of_alerts": 3,
 "more_information": "http://..."
 }
}

资源组告警

{
 "message": {
 "title": "DataWorks_Remind",
 "remind_name": "规则名",
 "remind_unit": "ScheduleResourceGroup",
 "occur_time": "2021-07-13 16:16:20",
 "remind_type": "resGroup use ratio",
 "resource_group_name": "资源组名",
 "threshold": 99,
 "duration": 30,
 "remind_founder": "jingyan20182222"
 }
}

字段含义

字段

描述

示例

title

告警标题。

DataWorks_Remind

task_size

任务数量。

1

remind_name

规则名称。

webhookTest

occur_time

发生时间。

2021-07-13 16:16:20

remind_type

触发条件。

取值如下：

  • completed：完成

  • uncompleted：未完成

  • error：出错

  • cycle uncompleted：周期未完成

  • run over time：运行超时

  • exhausted error：自动重跑仍出错

  • resGroup use ratio：资源组利用率

  • the number of waiting task in resGroup：资源组等待资源实例数

completed

node_id_list

节点ID，英文逗号分割，最多5个。

220167523

node_name_list

节点名，英文逗号分割，最多5个。

nodeName

node_owner_list

责任人列表，英文逗号分割，最多5个。

123123

remind_founder

规则创建人。

jingyan20182222

remind_unit

规则监控粒度。

取值如下：

  • Task：任务

  • Baseline：基线

  • Project：项目

  • BizProcess：业务流程

  • ScheduleResourceGroup：调度资源组

  • DiResourceGroup：数据集成资源组

Task

number_of_alerts

第几次告警。

3

more_information

DataWorks运维中心周期实例的URL。

http://XXXX

threshold

资源组监控特有，阈值。

  • remind_type为resGroup use ratio时是使用率。

  • remind_type为the number of waiting task in resGroup时是等待资源实例数量。

99

duration

资源组监控特有。持续时间，单位为分钟。

30

基线告警

消息体

{
 "message": {
 "cycle_number": 1,
 "occur_time": "2024-07-31 11:29:43",
 "baseline_owners": "dp3base",
 "baseline_name": "基线测试",
 "key_instance": 10590018690,
 "sla_time": "2024-07-30 17:30:00",
 "buffer": -1081,
 "title": "DataWorks_Baseline_Alert",
 "status": "overSla"
 }
}

字段含义

字段

描述

示例

cycle_number

周期号，天基线为1。

1

occur_time

发生时间。

2024-07-31 11:29:43

baseline_owners

基线责任人。

dp3base

baseline_name

基线名。

baseline_test

key_instance

当前关键实例。

10590018690

sla_time

承诺时间。

2024-07-30 17:30:00

buffer

基线余量，单位为分钟。

-1081

title

标题（类型）。

DataWorks_Baseline_Alert

status

状态。

  • dangerous：预警

  • overSla：破线

overSla

事件告警

消息体

{
 "message": {
 "task_name": "失败任务名",
 "event_type": "ERROR",
 "task_owner_name": "dp3base",
 "occur_time": "2024-07-30 23:06:06",
 "event_name": "20240729-10000213793(⼩时失败基线)(24)-[project:lwt_test_hongkong]出错",
 "title": "DataWorks_Event_Remind"
 }
}

字段含义

字段

描述

示例

task_name

异常任务名。

失败任务

event_type

事件类型。

  • ERROR：出错

  • SLOW：变慢

ERROR

task_owner_name

任务责任人。

dp3base

occur_time

发生时间。

2024-07-30 23:06:06

event_name

事件名称，格式：

业务⽇期-节点ID(节点名)(周期ID)-[project:项⽬空间名]

20240729-10000213793(失败任务)(1)-[project:lwt_test_hongkong]出错

title

标题（类型）。

DataWorks_Event_Remind

上一篇：任务监控常见问题下一篇：附件