DataWorks的OpenEvent旨在將DataWorks的各類狀態變更情況以消息的方式觸達到用戶,便于用戶訂閱消息并做出個性化的響應。例如,您可以通過OpenEvent訂閱表變更,從而實現核心表的實時監控;通過OpenEvent訂閱任務變更,實現定制化開發實時任務大屏的數據監控。本文為您介紹OpenEvent支持訂閱的事件類型與配置流程。
前提條件
目前OpenEvent面向DataWorks企業版用戶,華北2(北京)、華東1(杭州)、華東2(上海)、華北3(張家口)、華南1(深圳)、西南1(成都)、美國(硅谷)、美國(弗吉尼亞)、德國(法蘭克福)、日本(東京)、中國(香港)、新加坡地域支持該功能。
OpenEvent通過EventBridge實現消息的訂閱與消費,所以您需要先開通EventBridge產品服務,關于EventBridge產品介紹詳情請參見:什么是事件總線EventBridge。
權限說明
開放平臺管理員和租戶管理員擁有開發者后臺的讀寫權限,其他租戶級角色、空間級角色僅擁有開發者后臺的只讀權限。詳情請參見全局級模塊權限控制。
僅支持阿里云主賬號或者擁有AliyunDataWorksFullAccess權限的RAM用戶進行界面相關配置,權限詳情請參見產品及控制臺權限控制詳情:RAM Policy。
背景信息
DataWorks已開放DataWorks側核心流程的狀態變更消息,并支持將消息推送至OpenEvent服務,您可通過DataWorks的OpenEvent模塊對空間消息進行推送管理,并結合事件總線EventBridge服務實現DataWorks事件消息的過濾與消費管理。
相關概念
DataWorks事件消息按照是否可在DataWorks形成流程卡點,分為普通事件和擴展點事件。
普通事件:您可以在本地開發程序用于接收該類型的事件消息,以便您基于自身業務進行個性化響應。
擴展點事件:兼容普通事件特性與能力,此外,該類型事件還支持將本地程序注冊為DataWorks擴展程序,以此實現通過擴展程序對DataWorks中的用戶操作行為進行自定義邏輯處理并實現攔截阻斷等行為管控。
DataWorks事件消息按照事件生效范圍,將事件劃分空間級事件和租戶級事件。
空間級事件:空間級模塊生成的事件為空間級事件,例如數據開發模塊中對節點運行產生的事件消息、運維中心模塊周期實例狀態變更產生的事件消息等。
租戶級事件:租戶級模塊生成的事件為租戶級事件,例如管控臺刪除空間所產生的事件消息。您可通過下文各模塊事件列表了解各個模塊支持的事件消息中,哪些為普通事件,哪些為擴展點事件,以及對應事件的發送的消息格式。
支持訂閱的事件類型
下表為空間級和租戶級分別支持的擴展點事件和普通事件。
空間級事件
數據開發消息格式詳情請參見:數據開發事件列表。
事件類型 | 事件 | 普通事件 | 擴展點事件 | 示例 |
節點相關 | 新增節點 | 新建節點發布生產 | ||
更新節點 |
| |||
文件相關
| 刪除文件 |
| ||
提交文件 | 在DataStudio提交某個節點、資源或函數。 | |||
發布文件 | 在DataS tudio發布某個已提交節點、資源或函數。 | |||
運行代碼 | 在DataStudio運行節點代碼。 | |||
節點代碼評審 | 在DataStudio團隊成員可以在代碼提交前對代碼進行評審,并提供評價和反饋。 | |||
表相關 | 表提交開發環境 | 表提交擴展點事件:例如在表管理中提交某個表。 | ||
表發布生產環境 | 表發布擴展點事件:例如在表管理中發布某個表。 說明 僅標準模式工作空間支持在表管理中發布表,因此表發布擴展點事件僅存在于標準模式下。 |
運維中心消息格式詳情請參見:運維中心事件列表。
事件類型 | 事件 | 普通事件 | 擴展點事件 | 示例 |
節點變更 | 刪除節點 |
| ||
下線節點 | 周期任務界面下線任務。 | |||
凍結節點 | 周期任務界面凍結任務。 | |||
解凍節點 | 周期任務界面解凍任務。 | |||
節點補數據 | 節點補數據 |
| ||
任務狀態變更 | 調度任務狀態變更 | 如下場景會觸發調度任務狀態變更事件:
| ||
實例運維 | 凍結實例 | 在運維中心對某個實例進行以下操作。
| ||
解凍實例 | ||||
終止實例 | ||||
重跑實例
| ||||
置成功實例 | ||||
工作流狀態變更 | 工作流狀態變更
|
| ||
監控告警 | 監控告警 |
|
安全中心消息格式詳情請參見:安全中心事件列表。
事件類型 | 事件 | 普通事件 | 擴展點事件 | 示例 |
申請單創建/審批 | 創建申請單 | 例如在安全中心內, 頁面對函數、表、資源,進行權限申請單的創建。 | ||
完成申請單 | 例如在安全中心內 頁面,審批所有項目下的表、資源和函數的權限。 | |||
表權限變更 | 表權限申請 | 例如用戶根據需求申請特定表的讀取、寫入、修改等權限。 |
數據質量消息格式詳情請參見:數據質量事件列表。
事件類型 | 事件 | 普通事件 | 擴展點事件 | 示例 |
數據質量校驗 | 校驗結果反饋 | 用戶對校驗結果的反饋。 例如,在數據治理的數據質量模塊,給某個表啟用了表行數大于0的規則,頁面上用戶可以對某次校驗結果進行反饋,當用戶執行了反饋操作,系統會把用戶反饋的內容(校驗規則ID、反饋內容等)發送給訂閱端。 | ||
校驗完成 | 規則校驗完畢發送規則校驗結果(是否通過、樣本等信息) 例如,在數據治理的數據質量模塊,給某個表啟用了表行數大于0的規則,觸發了規則并且規則校驗完畢,會把規則校驗結果(是否通過、樣本等信息)發送給訂閱端。 |
租戶級事件
管控臺消息格式詳情請參見:管控臺事件列表。
事件類型 (點擊查看消息格式) | 事件 | 普通事件 | 擴展點事件 | 示例 |
刪除項目空間 | 刪除空間前置 | 用戶在工作空間列表刪除某個工作空間前,將觸發該事件。同時,刪除項目空間前置事件還會觸發相應擴展程序進行流程卡點 | ||
刪除空間后置 |
上傳與下載消息格式詳情請參見:上傳與下載事件列表。
事件類型 (單擊查看消息格式) | 事件 | 普通事件 | 擴展點事件 | |
數據下載與上傳 | 數據下載前置-文件生成 | 當用戶在下載中心進行數據下載操作。 在實際的數據下載操作之前,會觸發數據下載前置事件,以獲取即將進行的下載操作的相關信息。 | ||
數據下載前置-文件下載 | ||||
數據上傳前置 |
應用優勢
DataWorks的OpenEvent具備以下優勢:
節省運維成本:
通過開啟DataWorks開放平臺的消息訂閱功能,您可以很方便地訂閱事件消息。
提升開發效能:
通過在DataWorks界面上創建相關配置,您無需再進行發送消息相關配置,僅需做好相關SDK開發的準備配置工作及訂閱消息配置,節省繁雜的手工操作。
實現個性化需求:
DataWorks提供豐富的事件類型,您可以通過訂閱不同事件類型的消息,快速感知業務狀態變化信息,及時做好個性化響應和決策。