DataWorks のモニタリングとアラートにカスタム Webhook を使用する場合、DataWorks はデフォルトでパブリックネットワーク経由で Webhook サービスにアラートメッセージをプッシュします。Webhook サービスのデプロイ環境に基づいて接続方法を選択できます。パブリックネットワーク方式を使用するには、DataWorks のパブリック IP アドレスを Webhook サービスの許可リストに追加します。内部ネットワーク方式を使用するには、テナントアラートポリシーで Webhook サービスに接続できるリソースグループを指定すると、そのリソースグループがアラートメッセージを送信します。これにより、アラートメッセージの確実な配信が保証されます。
使用上の注意
ネットワークの制限：アラートメッセージはデフォルトでパブリックネットワーク経由でプッシュされます。Webhook サービスが内部ネットワークにデプロイされている場合は、テナントのアラートポリシーで Webhook サービスに接続可能なリソースグループを指定すると、そのリソースグループがアラートメッセージを送信します。2つの接続方法の詳細については、「パブリックネットワークモード」および「内部ネットワークモード」をご参照ください。
エディションの制限：カスタム Webhook は DataWorks Enterprise Edition でのみサポートされています。
ネットワーク設定
デフォルトでは、DataWorks はパブリックネットワーク経由で Webhook サービスにアラートメッセージをプッシュします。Webhook サービスのデプロイ環境に基づいて、パブリックネットワークモードまたは内部ネットワークモードを選択できます。
パブリックネットワークモード
デフォルトでは、DataWorks はパブリックネットワーク経由で Webhook サービスにアラートメッセージをプッシュするため、追加のネットワーク設定は不要です。
Webhook サービスが許可リストによるアクセス制御を使用していない場合は、この手順をスキップしてください。
Webhook サービスがアクセス制御に許可リストを使用している場合は、DataWorks の以下のパブリック IP アドレスをその許可リストに追加してください。
リージョン名 | リージョン ID | IP アドレス |
中国 (北京) | cn-beijing | 47.93.5.9, 47.93.60.157, 47.94.111.106, 59.110.166.34, 60.205.184.153, 60.205.227.157, 60.205.223.44, 123.56.217.46, 123.57.155.168, 123.57.243.71 |
中国 (張家口) | cn-zhangjiakou | 39.100.0.109, 39.100.9.117, 39.100.9.121 |
中国 (杭州) | cn-hangzhou | 47.96.30.97, 47.97.175.135, 116.62.247.242, 120.27.233.168, 121.40.70.19, 121.199.31.66, 121.199.41.143, 121.199.61.16 |
中国 (上海) | cn-shanghai | 47.100.10.242, 47.101.166.155, 47.101.179.29, 47.101.196.116, 101.132.179.94, 106.14.1.102, 106.15.197.122, 106.15.202.114 |
中国 (深圳) | cn-shenzhen | 47.107.81.9, 47.112.11.104, 47.112.21.108, 47.112.22.239, 47.112.23.85 |
マレーシア (クアラルンプール) | ap-southeast-3 | 47.254.198.127, 47.254.200.185 |
日本 (東京) | ap-northeast-1 | 47.74.22.81, 47.74.23.43 |
韓国 (ソウル) | ap-northeast-2 | 47.80.13.207, 47.80.10.92 |
中国 (成都) | cn-chengdu | 47.108.64.120, 47.108.119.242 |
シンガポール | ap-southeast-1 | 47.74.209.97, 47.74.229.187, 47.74.243.124 |
インドネシア (ジャカルタ) | ap-southeast-5 | 149.129.253.151, 149.129.253.185 |
中国 (香港) | cn-hongkong | 47.52.128.224, 47.244.33.205 |
ドイツ (フランクフルト) | eu-central-1 | 47.91.89.154, 47.254.153.91 |
米国 (バージニア) | us-east-1 | 47.89.191.99, 47.90.253.133 |
米国 (シリコンバレー) | us-west-1 | 47.88.4.25, 47.88.6.226 |
英国 (ロンドン) | eu-west-1 | 8.208.12.7, 8.208.15.6 |
サウジアラビア (リヤド - パートナーリージョン) | me-central-1 | 8.213.30.84, 8.213.30.232 |
内部ネットワークモード
Webhook サービスが内部ネットワークにデプロイされている場合、テナントのアラートポリシーでカスタム Webhook 用に Webhook サービスに接続できるリソースグループを指定できます。そのリソースグループがアラートメッセージを送信します。これにより、アラートメッセージが内部ネットワークから出ることなく、より安全に転送されます。
DataWorks コンソールにログインし、オペレーションセンターに移動します。左側のナビゲーションペインで、 をクリックします。
[テナントアラートポリシー設定] をクリックします。
[カスタムWebhookリソースグループ] で、Webhook サービスへ接続できるリソースグループ (サーバーレスリソースグループのみサポート) を選択し、設定を完了します。テナントのアラートポリシーの詳細については、「テナントのアラートポリシー設定」をご参照ください。リソースグループのネットワーク接続を設定する方法の詳細については、「ネットワーク接続の設定」をご参照ください。
リソースグループが選択されていない場合、テナント内のカスタム Webhook はデフォルトでパブリックネットワーク経由でアラートメッセージを送信します。設定が有効になると、[アラート情報] ページの上部に、現在のテナントのカスタム Webhook でリソースグループ経由の送信が有効になったことを示すメッセージが表示されます。メッセージ内の [設定の変更] をクリックして設定を変更できます。
メッセージ形式
DataWorks は、アラートメッセージを JSON 形式でカスタム Webhook サービスに送信します。以下のセクションでは、接続テストのペイロード、メッセージ本文の例、および各アラートタイプのフィールドについて説明します。
接続テスト
{
"message":{
"content": "DataWorks Workbench Alarm Connectivity Test"
}
}
カスタムアラート
メッセージ本文
自動トリガーインスタンスのアラート
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "webhookTest",
"remind_unit": "Task",
"occur_time": "2021-07-13 16:16:20",
"remind_type": "uncompleted",
"task_size": 1,
"node_id_list": "220167523",
"node_name_list": "nodeName",
"node_owner_list": "123123123",
"remind_founder": "jingyan20182222",
"number_of_alerts": 3,
"more_information": "http://..."
}
} リソースグループのアラート
{
"message": {
"title": "DataWorks_Remind",
"remind_name": "Alert rule name",
"remind_unit": "ScheduleResourceGroup",
"occur_time": "2021-07-13 16:16:20",
"remind_type": "resGroup use ratio",
"resource_group_name": "Resource group name",
"threshold": 99,
"duration": 30,
"remind_founder": "jingyan20182222"
}
}フィールド
フィールド | 説明 | 例 |
title | アラートのタイトル。 | DataWorks_Remind |
task_size | タスクの数。 | 1 |
remind_name | アラートルールの名前。 | webhookTest |
occur_time | アラートがトリガーされた時刻。 | 2021-07-13 16:16:20 |
remind_type | トリガー条件。 有効値：
| completed |
node_id_list | ノード ID。複数の ID はカンマ (,) で区切ります。最大 5 つのノード ID を指定できます。 | 220167523 |
node_name_list | ノード名。複数の名前はカンマ (,) で区切ります。最大 5 つのノード名を指定できます。 | nodeName |
node_owner_list | ノードの所有者。複数の所有者はカンマ (,) で区切ります。最大 5 人のノード所有者を指定できます。 | 123123123 |
remind_founder | アラートルールの作成者。 | jingyan20182222 |
remind_unit | アラートルールのモニタリング粒度。 有効値：
| Task |
number_of_alerts | アラートの n 回目のトリガー。 | 3 |
more_information | オペレーションセンターにおける対象の自動トリガーインスタンスの URL。 | http://XXXX |
threshold | しきい値。このパラメーターはリソースグループでのみ使用可能です。
| 99 |
duration | 期間。単位：分。このパラメーターはリソースグループでのみ使用可能です。 | 30 |
ベースラインアラート
メッセージ本文
{
"message": {
"cycle_number": 1,
"occur_time": "2024-07-31 11:29:43",
"baseline_owners": "dp3base",
"baseline_name": "Baseline test",
"key_instance": 10590018690,
"sla_time": "2024-07-30 17:30:00",
"buffer": -1081,
"title": "DataWorks_Baseline_Alert",
"status": "overSla"
}
}フィールド
フィールド | 説明 | 例 |
cycle_number | ベースラインインスタンスのサイクルの ID。日次サイクルの ID は | 1 |
occur_time | アラートがトリガーされた時刻。 | 2024-07-31 11:29:43 |
baseline_owners | ベースラインの所有者。 | dp3base |
baseline_name | ベースラインの名前。 | Baseline test |
key_instance | 現在のキーインスタンス。 | 10590018690 |
sla_time | SLA で定められた完了時刻。 | 2024-07-30 17:30:00 |
buffer | ベースラインのアラートマージンのしきい値。単位：分。 | -1081 |
title | アラートタイプを指定するタイトル。 | DataWorks_Baseline_Alert |
status | ベースラインのステータス。有効値：
| overSla |
イベントアラート
メッセージ本文
{
"message": {
"task_name": "Name of a failed task",
"event_type": "ERROR",
"task_owner_name": "dp3base",
"occur_time": "2024-07-30 23:06:06",
"event_name": "20240729-10000213793(Name of a failed task)(24)-[project:lwt_test_hongkong]Error",
"title": "DataWorks_Event_Remind"
}
}
フィールド
フィールド | 説明 | 例 |
task_name | 異常なタスクの名前。 | Name of a failed task |
event_type | イベントのタイプ。有効値：
| ERROR |
task_owner_name | タスクの所有者。 | dp3base |
occur_time | アラートがトリガーされた時刻。 | 2024-07-30 23:06:06 |
event_name | イベントの名前。形式：
|
|
title | アラートタイプを指定するタイトル。 | DataWorks_Event_Remind |