DataWorks的OpenEvent旨在将DataWorks的各类状态变更情况以消息的方式触达到用户,便于用户订阅消息并做出个性化的响应。例如,您可以通过OpenEvent订阅表变更,从而实现核心表的实时监控;通过OpenEvent订阅任务变更,实现定制化开发实时任务大屏的数据监控。本文为您介绍OpenEvent支持订阅的事件类型与配置流程。
权限说明
开放平台管理员和租户管理员拥有开发者后台的读写权限,其他租户级角色、空间级角色仅拥有开发者后台的只读权限。详情请参见全局级模块权限控制。
仅支持阿里云主账号或者拥有AliyunDataWorksFullAccess权限的RAM用户进行界面相关配置,权限详情请参见产品及控制台权限控制详情:RAM Policy。
注意事项
目前OpenEvent面向DataWorks企业版用户公测,华北2(北京)、华东1(杭州)、华南1(深圳)、华东2(上海)、华北3(张家口)、华南1(深圳)、西南1(成都)、美国(硅谷)、美国(弗吉尼亚)、德国(法兰克福)、日本(东京)、中国(香港)、新加坡地域支持该功能。
OpenEvent通过EventBridge实现消息的订阅与消费,所以您需要先开通EventBridge产品服务,关于EventBridge产品介绍详情请参见:什么是事件总线EventBridge。
扩展点事件分为租户级和空间级,注册扩展程序时,仅支持选择某一类型的扩展点事件。DataWorks支持的扩展点事件所属的类型,详情请参见支持的扩展点事件列表。
支持订阅的事件类型
DataWorks支持订阅的事件从事件类型上可以分为普通事件和扩展点事件。
普通事件:支持用户订阅此类事件的消息。
扩展点事件:用户订阅此类事件的消息后,还可联合DataWorks的扩展程序功能,在收到事件消息后实现自定义响应。
DataWorks当前支持订阅的事件覆盖了运维中心、DataStudio和数据治理三个功能模块中的事件,详情如下表所示。
应用范围 | 所属模块 | 事件细分 | 事件描述与类型 | 事件示例 |
空间级 | 运维中心 | 实例操作事件 |
| 例如,在运维中心对某个实例进行以下操作。
|
调度任务状态变更事件 |
| 如下场景会触发调度任务状态变更事件:
| ||
工作流状态变更事件 |
|
| ||
节点变更事件 | 在运维中心(生产环境)的节点变更事件,包括普通事件和扩展点事件。 |
说明 此处节点特指生产运维中心周期任务列表中的任务。 | ||
补数据操作事件 |
| 事件示例如下。
| ||
运维中心告警事件 |
| 事件例如下。
| ||
监控告警 | 监控告警事件 |
| 事件示例如下。
| |
DataStudio | 文件变更事件 |
| 事件示例如下。
| |
表变更事件 |
| 事件示例如下。
| ||
代码评审事件 |
| 例如,团队成员可以在代码提交前对代码进行评审,并提供评价和反馈。 | ||
安全中心 | 审批中心事件 |
| 事件示例如下。
| |
数据质量 | 数据质量校验结果反馈事件 |
| 例如,在数据治理的数据质量模块,给某个表启用了表行数大于0的规则,页面上用户可以对某次校验结果进行反馈,当用户执行了反馈操作,系统会把用户反馈的内容(校验规则ID、反馈内容等)发送给订阅端。 | |
数据质量校验完成事件 |
| 例如,在数据治理的数据质量模块,给某个表启用了表行数大于0的规则,触发了规则并且规则校验完毕,会把规则校验结果(是否通过、样本等信息)发送给订阅端。 | ||
租户级 | 管理控制台 | 删除项目空间前置事件 |
| 例如,用户在工作空间列表删除某个工作空间前,将触发该事件。同时,删除项目空间前置事件还会触发相应扩展程序进行流程卡点。 |
删除项目空间后置事件 |
| 例如,用户在工作空间列表删除某个工作空间后,触发该事件。 | ||
下载中心 | 数据下载前置事件 |
| 例如,当用户在下载中心进行数据下载操作。 |
由于网络时延问题,OpenEvent的消息发送可能存在一定延迟。
配置流程
了解上述原理后,您可根据实际情况规划并应用DataWorks的OpenEvent功能,实现关键事件的消息订阅,应用流程与配置要点如下。
在事件总线 EventBridge 控制台开通事件总线EventBridge,创建自定义总线。
在DataWorks端添加事件分发通道。
在事件总线 EventBridge 控制台配置事件总线。
在事件总线 EventBridge 控制台发布事件,详情请参见发布事件。
应用优势
DataWorks的OpenEvent具备以下优势:
节省运维成本:
通过开启DataWorks开放平台的消息订阅功能,您可以很方便的订阅事件消息。
提升开发效能:
通过在DataWorks界面上创建相关配置,您无需再进行发送消息相关配置,仅需做好相关SDK开发的准备配置工作及订阅消息配置,节省繁杂的手工操作。
实现个性化需求:
DataWorks提供丰富的事件类型,您可以通过订阅不同事件类型的消息,快速感知业务状态变化信息,及时做好个性化响应和决策。
- 本页导读 (1)