DataWorks の OpenEvent は、ステータス変更メッセージを EventBridge にプッシュし、リアルタイムでのサブスクライブと応答を可能にします。たとえば、テーブルの変更をサブスクライブしてコアテーブルを監視したり、タスクの変更をサブスクライブしてカスタムモニタリングダッシュボードを構築したりできます。
概要
DataWorks は、そのコアプロセスからのステータス変更メッセージを OpenEvent にプッシュします。OpenEvent モジュールを使用してワークスペースのメッセージプッシュを管理し、EventBridge を使用してイベントメッセージをフィルターおよび消費します。
利点:
-
低い運用保守コスト:DataWorks オープンプラットフォームでメッセージサブスクリプションを有効にすることで、イベントメッセージをサブスクライブできます。
-
開発の迅速化:手動でのメッセージ送信設定なしで、DataWorks コンソールでサブスクリプションを設定できます。SDK を準備してサブスクライブします。
-
カスタマイズ可能な応答:特定のイベントタイプをサブスクライブしてビジネスの変更を検出し、パーソナライズされた応答をトリガーします。
注意事項
-
エディション:DataWorks Enterprise Edition のみでサポートされています。
-
リージョン:中国 (北京)、中国 (杭州)、中国 (深セン)、中国 (上海)、中国 (張家口)、中国 (成都)、米国 (シリコンバレー)、米国 (バージニア)、ドイツ (フランクフルト)、日本 (東京)、中国 (香港)、シンガポールでサポートされています。
-
アクセス制御: 開発者コンソールの読み取りおよび書き込み権限を持つのは、[オープンプラットフォーム管理者]、[テナント管理者]、Alibaba Cloud アカウント、または [Aliyundataworksfullaccess] を持つ RAM ユーザーのみです。オープンプラットフォーム管理者。RAM ユーザーに AliyunDataWorksFullAccess 権限を付与する。
-
依存関係:OpenEvent は、メッセージのサブスクリプションと消費に EventBridge を使用します。開始する前に EventBridge をアクティブ化してください。
関連概念
DataWorks は、プロセスチェックポイントを作成するかどうかに基づいて、イベントメッセージを通常イベントと拡張ポイントイベントに分類します。
-
通常イベント:ローカルプログラムを開発してこれらのメッセージを受信し、カスタム応答を作成します。
-
拡張ポイントイベント:これらのイベントは、すべての通常イベントの機能をサポートします。また、ローカルプログラムを DataWorks 拡張として登録し、ユーザー操作のインターセプトやブロックなどのカスタムロジックや動作制御を実装することもできます。
イベントは、範囲によってワークスペースレベルのイベントとテナントレベルのイベントにも分類されます。
-
ワークスペースレベルのイベント:Data Studio (ノード実行) やオペレーションセンター (定期インスタンスのステータス変更) などのワークスペースレベルのモジュールによって生成されます。
-
テナントレベルのイベント:コンソールからのワークスペース削除など、テナントレベルのモジュールによって生成されます。以下のイベントテーブルには、各モジュールのタイプ、カテゴリ、メッセージフォーマットが記載されています。
サポートされるイベントタイプ
以下のテーブルは、ワークスペースレベルとテナントレベルの拡張ポイントイベントと通常イベントを一覧表示します。
テナントレベルのイベント
コンソール
コンソールのメッセージフォーマット:詳細については、「コンソールイベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
ワークスペースの削除 |
ワークスペース削除前イベント |
|
|
ユーザーがワークスペースを削除する前に、このイベントがトリガーされます。[ワークスペース削除前イベント] によって対応する拡張がトリガーされ、プロセスチェックポイントが作成されます。 |
|
ワークスペース削除後 |
|
|
データのアップロードとダウンロード
メッセージフォーマット:詳細については、「データのアップロードとダウンロードのイベントメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
データのダウンロードとアップロード |
データダウンロード前イベント - ファイル生成 |
|
|
ユーザーがダウンロードセンターからデータをダウンロードします。 ダウンロードの前に、データダウンロード前イベント が操作に関する情報をキャプチャします。 |
|
データダウンロード前イベント - ファイルダウンロード |
|
|
||
|
データアップロード前イベント |
|
|
ワークスペースレベルのイベント
Data Studio
メッセージフォーマット:詳細については、「Data Studio イベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
ノードの変更 |
ノードの追加 |
|
|
ノードを作成し、本番環境にデプロイします |
|
ノードの更新 |
|
|
|
|
|
ファイルの変更
|
ファイル削除前イベント |
|
|
開発環境でファイルを削除します。削除されたファイルはゴミ箱に移動されます。 |
|
ファイル送信前イベント |
|
|
Data Studio でノード、リソース、または関数を送信します。 |
|
|
ファイルデプロイ前イベント |
|
|
Data Studio で送信されたノード、リソース、または関数をデプロイします。 |
|
|
コード実行前イベント |
|
|
Data Studio でノードコードを実行します。 |
|
|
テーブルの変更 |
開発環境へのテーブル送信前イベント |
|
|
テーブル送信拡張ポイントイベント:たとえば、テーブル管理でテーブルを送信します。 |
|
本番環境へのテーブル送信前イベント |
|
|
テーブルデプロイ拡張ポイントイベント:たとえば、テーブル管理でテーブルをデプロイします。 説明
標準モードのワークスペースのみがテーブル管理でのテーブルのデプロイをサポートします。したがって、テーブルデプロイ拡張ポイントイベントは標準モードにのみ存在します。 |
データ統合
メッセージフォーマット:詳細については、「データ統合イベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
ノード変更イベント |
リアルタイムタスクの開始 |
|
|
データ統合でリアルタイムタスクを開始します。 |
|
リアルタイムタスクの一括開始 |
|
|
データ統合でリアルタイムタスクを一括開始します。 |
オペレーションセンター
メッセージフォーマット:詳細については、「オペレーションセンターイベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
ノードの変更 |
ノードの削除 |
|
|
|
|
ノードデプロイ解除前イベント |
|
|
本番環境の定期タスクからノードを直接デプロイ解除します。 説明
この操作は Data Studio のノードも削除し、ゴミ箱に移動します。 |
|
|
ノードフリーズ前イベント |
|
|
定期タスクページでタスクをフリーズします。 |
|
|
ノードフリーズ解除前イベント |
|
|
定期タスクページでタスクのフリーズを解除します。 |
|
|
ノードデータのバックフィル |
データバックフィル前イベント |
|
|
|
|
タスクステータスの変更 |
定期タスクのステータス変更 |
|
|
以下のシナリオで定期タスクのステータス変更イベントがトリガーされます:
|
|
インスタンスの変更 |
インスタンスのフリーズ |
|
|
オペレーションセンターの定期インスタンスリストでインスタンスに対してこれらの操作を実行すると、以下のイベントがトリガーされます。
|
|
インスタンスのフリーズ解除 |
|
|
||
|
インスタンスの終了 |
|
|
||
|
インスタンスの再実行
|
|
|
||
|
インスタンスを成功としてマーク |
|
|
||
|
インスタンスの指定された上流依存関係の削除 |
|
|
||
|
インスタンスフリーズ前イベント |
|
|
オペレーションセンターの定期インスタンスリストでインスタンスに対して操作を実行すると、対応する事前イベントがトリガーされます。
|
|
|
インスタンスフリーズ解除前イベント |
|
|
||
|
インスタンス再実行前イベント |
|
|
||
|
インスタンスを成功としてマークする前のイベント |
|
|
||
|
インスタンス終了前イベント |
|
|
||
|
期限切れインスタンスの削除 |
|
|
||
|
ワークフローステータスの変更 |
ワークフローステータスの変更
|
|
|
|
|
監視アラート |
監視アラート |
|
|
|
セキュリティセンター
メッセージフォーマット:詳細については、「セキュリティセンターイベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
権限リクエストの作成/承認 |
権限リクエスト作成前イベント |
|
|
例えば、[セキュリティセンター] の ページに移動して、[関数]、[テーブル]、[リソース] の権限リクエストを作成します。 |
|
リクエストの完了 |
|
|
例えば、[セキュリティセンター]で ページに移動し、すべてのプロジェクトのテーブル、リソース、および関数に対する権限を承認します。 |
|
|
テーブル権限の変更 |
テーブル権限リクエスト |
|
|
たとえば、ユーザーはニーズに基づいて特定のテーブルに対する読み取り、書き込み、または変更の権限をリクエストします。 |
Data Quality
メッセージフォーマット:詳細については、「Data Quality イベントのメッセージフォーマット」をご参照ください。
|
イベントタイプ |
イベント |
通常イベント |
拡張ポイントイベント |
例 (イベントメッセージを生成する操作) |
|
データ品質検証 |
検証結果のフィードバック |
|
|
検証結果に関するフィードバック。 たとえば、Data Quality で、テーブルの行数が 0 より大きいことを要求するルールを有効にします。ユーザーが検証結果に関するフィードバックを送信すると、システムはそのフィードバック (ルール ID、内容、その他の情報) をサブスクライバーに送信します。 |
|
検証完了 |
|
|
ルール検証が完了すると、結果 (合格/不合格のステータス、サンプル、その他の情報) が送信されます。 たとえば、Data Quality で、テーブルの行数が 0 より大きいことを要求するルールを有効にします。検証が完了すると、結果がサブスクライバーに送信されます。 |
|
|
データ品質ルール事前イベント |
データ品質ルールの一括作成前イベント |
|
|
たとえば、[Data Quality] で ページに移動し、特定のテーブルの詳細ページを開きます。[ルール管理] タブでの以下の操作により、対応する事前イベントがトリガーされます。
|
|
データ品質ルールの一括更新前イベント |
|
|
||
|
データ品質ルールの一括削除前イベント |
|
|
||
|
データ品質ルール更新前イベント |
|
|
||
|
データ品質モニタリング事前イベント |
データ品質モニタリング作成前イベント |
|
|
例えば、[Data Quality] で、 ページに移動し、特定のテーブルの詳細ページを開きます。[品質モニタリング] タブでの以下の操作が、対応する事前イベントをトリガーします。
|
|
データ品質モニタリング更新前イベント |
|
|
||
|
データ品質モニタリングクローン前イベント |
|
|
||
|
データ品質モニタリングの一括削除前イベント |
|
|
||
|
データ品質モニタリングアラートサブスクリプション事前イベント |
データ品質モニタリングアラートサブスクリプション作成前イベント |
|
|
たとえば、[Data Quality] で、 ページに移動し、特定のテーブルの詳細ページを開きます。[品質モニタリング] タブで、特定の品質モニタリング構成のアラートをサブスクライブします。 |
|
データ品質モニタリングアラートサブスクリプション更新前イベント |
|
|
例えば、[Data Quality] でページに移動し、特定のテーブルの詳細ページを開きます。 [品質モニタリング] タブで、特定の品質モニタリング構成のアラートサブスクリプション情報を変更します。 |
|
|
データ品質モニタリングアラートサブスクリプション削除前イベント |
|
|
例えば、[Data Quality] で、 ページに移動し、特定のテーブルの詳細ページを開きます。[品質モニタリング] タブで、特定の品質モニタリング構成のアラートサブスクリプション情報を削除します。 |