DataWorks Open Platform で拡張を登録、公開、有効化すると、ワークスペース内の操作が拡張ポイントイベントをトリガーした際に、DataWorks から拡張にイベントメッセージが送信されます。その後、拡張が返す結果を確認できます。本トピックでは、オペレーションセンターがサポートする拡張ポイントイベントと、それらを利用してカスタム検証をトリガーする方法について説明します。
前提条件
-
メッセージサブスクリプションを有効化していること。詳細については、「メッセージサブスクリプションの有効化」をご参照ください。
-
拡張を開発およびデプロイしていること。詳細については、「Function Compute を使用した拡張の開発とデプロイ」をご参照ください。
背景情報
DataWorksは、拡張ポイントイベントの通知を送信できます。また、拡張機能を使用して、サポートされている拡張ポイントに基づいてプロセスチェックポイントを作成することもできます。これにより、特定の操作に対してカスタムロジックを実行できます。この機能を使用するには、まず DataWorks コンソールで拡張機能を登録し、次に [管理] > Extensions で有効化する必要があります。DataWorks 管理のナビゲーションペインで、[拡張機能] をクリックして拡張機能管理ページを開きます。[拡張範囲] セクションで、タイプとして [ワークスペース] を選択し、ターゲットワークスペースを選択してから、拡張機能の [有効化] スイッチをオンにします。表示される [拡張機能データ承認] ダイアログボックスで、ファイル変更イベントの OpenAPI (例: UpdateIDEEventResult) など、承認の詳細を確認します。[前述のデータ承認に関連するリスクを読み、同意します。] を選択し、[同意して承認] をクリックします。
-
ワークスペース管理者のみが、[管理] > Extensions で拡張機能を有効にできます。
-
拡張の詳細については、「拡張の概要」をご参照ください。
-
上記の手順は、ワークスペースレベルの拡張向けです。詳細については、「サポートされている拡張ポイントイベント」をご参照ください。
概要
オペレーションセンターモジュールを使用すると、サービスは以下の拡張ポイントイベントのメッセージを受信できます。また、ローカルプログラムを DataWorks 拡張として登録し、これらのイベントメッセージを受信し、カスタムロジックで処理してから、UpdateWorkbenchEventResult API を呼び出して結果をプラットフォームに返すことも可能です。このメカニズムにより、DataWorks でプロセス制御を実装できます。オペレーションセンターは、以下の拡張ポイントをサポートしています。
|
イベント |
説明 |
|
[ノード変更イベント] |
説明
ここでのノードとは、本番環境のオペレーションセンターの [スケジュールされたタスク] リスト内のタスクを指します。 |
|
[データバックフィルイベント] |
|
ここでのノードとは、本番環境のオペレーションセンターの [スケジュールされたタスク] リスト内のタスクを指します。本番環境の [スケジュールされたタスク] ページでタスクに対して上記の操作を実行すると、拡張検証がトリガーされます。開発環境でスケジュールされたタスクに対してこれらの操作を実行しても、拡張検証はトリガーされません。同様に、インスタンスページでインスタンスをフリーズまたはフリーズ解除しても、拡張検証はトリガーされません。
サポートされている拡張ポイント
オペレーションセンター：ノードのフリーズとフリーズ解除
この例では、ノードをフリーズする際に拡張をトリガーする方法を示します。オペレーションセンターの [スケジュールされたタスク] ページで、xc_demo_start などの対象ノードを右クリックし、ショートカットメニューから [一時停止 (フリーズ)] を選択します。この操作が拡張ポイントです。ツールバーのフリーズアイコンをクリックしても、この操作をトリガーできます。操作がトリガーされると、右側に [操作チェックの詳細] パネル (拡張) が表示されます。このパネルには、ノード名、操作タイプ (一時停止/フリーズ)、および検証チェックポイントのステータス (「操作チェック進行中」など) が表示されます。[詳細を表示] または [ドキュメントを表示] をクリックして検証結果を確認したり、[再チェック] をクリックして検証を再度トリガーしたり、[閉じる] をクリックしてパネルを終了したりできます。
オペレーションセンター：ノードのデプロイ解除
[スケジュールされたタスク] リストで、test_select などの対象タスクを右クリックし、ショートカットメニューから [ノードのデプロイ解除] を選択します。デプロイ解除を開始すると、タスク行に [デプロイ解除チェック進行中] というメッセージとステータスアイコンが表示され、拡張が操作を検証していることを示します。ステータスアイコンをクリックして、[操作チェックの詳細] ダイアログボックスを開きます。このダイアログボックスには、タスク名、操作タイプ (デプロイ解除)、チェックポイントとそのステータスが表示されます。[操作] 列には、[詳細を表示] および [ドキュメントを表示] へのリンクが表示されます。ダイアログボックスの下部には、[再チェック] および [閉じる] ボタンがあります。
オペレーションセンター：データバックフィル
オペレーションセンターの左側メニューで、[スケジュールされたタスク] を選択します。右側の DAG で、対象タスクノードを右クリックし、現在のノード、現在のノードと下流ノード、大量ノードモード、または高度モードなどのデータバックフィルオプションを選択します。この操作により、事前チェック拡張ポイントイベントがトリガーされます。タスクを送信した後、左側メニューで [バックフィルインスタンス] を選択して、データバックフィルタスクのチェックステータスを確認できます。チェックステータスをクリックして [操作チェックの詳細] ダイアログボックスを開くと、チェックポイント名とそのステータスを含む拡張からの検証結果が表示されます。
関連ドキュメント
-
拡張を有効化する方法については、「拡張の有効化」をご参照ください。
-
オペレーションセンターの拡張ポイントイベントの詳細については、「サポートされている拡張ポイントイベント」をご参照ください。
-
データバックフィルイベントのメッセージ形式については、「データバックフィルイベント」をご参照ください。
-
ノード変更イベントのメッセージ形式については、「ノード変更イベント (作成、変更、削除、フリーズ、フリーズ解除、デプロイ解除)」をご参照ください。