应用示例:运维中心触发事件检查

更新时间:
复制 MD 格式

DataWorks开放平台中,成功注册、上线并启用扩展程序后,在该扩展程序所生效的工作空间中,使用页面部分功能(即触发扩展点事件)时,DataWorks会将事件消息发送至您的扩展程序,您可以查看扩展程序返回的结果。本文将为您介绍运维中心中支持的扩展点事件,以及使用扩展点触发扩展程序校验的操作过程。

前提条件

背景信息

DataWorks支持您对扩展点事件进行事件消息通知,此外,还支持您基于DataWorks支持的扩展点,通过开启对应扩展点事件的扩展程序来实现流程卡点,并通过实现扩展程序对扩展点事件的自定义逻辑处理。若要实现上述能力,您需要先在DataWorks管理控制台注册扩展程序,并在管理中心 > 扩展程序处启用该扩展程序。在DataWorks管理中心左侧导航栏单击扩展程序,进入扩展程序管理页面。在扩展程序生效范围区域选择类型为工作空间并选择目标工作空间,在扩展程序列表中打开目标扩展程序的启用开关。在弹出的扩展程序数据授权对话框中,确认授权内容(如文件变更事件对应的OpenAPI: UpdateIDEEventResult),勾选我已知晓并接受以上数据授权所可能产生的风险,然后单击同意授权

说明
  • 仅有空间管理员权限的用户可在管理中心 > 扩展程序启用扩展程序。

  • 扩展程序相关说明,详情请参见:扩展程序概述

  • 上述操作中显示的是空间级扩展程序,详情可参见:支持的扩展点事件列表

能力概述

运维中心模块支持您本地服务对以下扩展点事件消息接收,此外,还支持将本地程序注册为DataWorks扩展程序,通过扩展程序接收扩展点事件消息,实现扩展程序对扩展点事件的自定义逻辑处理,并通过回调APIUpdateWorkbenchEventResult将处理结果返回至平台,实现DataWorks上的流程管控。运维中心支持的扩展点如下:

事件名称

事件内容

节点变更事件

  • 下线节点前置事件。

  • 冻结节点前置事件。

  • 解冻节点前置事件。

说明

此处节点特指生产运维中心周期任务列表中的任务。

补数据操作事件

  • 对周期任务进行补当前节点的操作。

  • 对周期任务进行补当前节点及下游节点的操作。

  • 通过海量节点模式进行补数据。

  • 通过高级模式进行补数据。

说明

此处节点特指生产运维中心周期任务列表中的任务,即生产运维中心周期任务界面对任务进行上述操作,可触发扩展程序校验,开发环境运维中心对周期任务进行上述操作,不会触发扩展程序校验,实例界面进行实例的冻结与解冻操作,不会触发扩展程序校验。

支持的扩展点

运维中心-节点冻结、节点解冻

以节点冻结扩展点操作为例进行说明。在运维中心周期任务页面,右键单击目标节点(如 xc_demo_start),在弹出菜单中选择暂停(冻结)(此操作为扩展点),或通过工具栏快捷图标触发冻结。触发后右侧弹出操作检查详情面板(即扩展程序),显示节点名称、操作类型(暂停/冻结)以及检查点的校验状态(如"操作检查中"),可单击查看详情查看文档了解校验结果,也可单击重新检查重新触发校验或单击关闭退出面板。

运维中心-下线节点

在周期任务列表中右键单击目标任务(如test_select),从右键菜单中选择下线节点。执行下线操作后,任务行出现下线操作检查中提示及状态图标,表示扩展程序正在对下线操作进行校验。单击状态图标可打开操作检查详情弹窗,弹窗中展示任务名称、操作类型(下线)、检查点及其状态(操作检查中),操作列提供查看详情查看文档链接,底部有重新检查关闭按钮。

运维中心-补数据

在运维中心左侧导航栏选择周期任务,在右侧 DAG 图中右键单击目标任务节点,选择补数据(可选当前节点、当前节点及下游节点、海量节点模式或高级模式),此操作将触发扩展点的前置事件检查。提交后,在左侧导航栏选择补数据实例,可查看对应补数据任务的检查状态。单击检查状态可打开操作检查详情弹窗,查看扩展程序的校验结果,包括检查点名称及检查结果等信息。

相关文档