Dataplex タスクのアラートと通知を設定する

このページでは、Dataplex タスクの失敗したジョブ実行に関するアラートを設定する方法について説明します。

アラートは、次のいずれかを使用して設定できます。

• Google Cloud コンソールのログ エクスプローラ
• Monitoring API

用語

• インシデントの自動クローズ期間: 一致するログエントリがない場合に、インシデントがクローズされるまでの期間。
• 通知間の時間: フィルタに一致するログの受信通知間の最小時間。最小時間内の一致ログがはスキップされます。設定可能な最小時間は 5 分です。

ログ エクスプローラを使用して通知を設定する

1. ブラウザで Google Cloud コンソールを開きます。
2. [ナビゲーション メニュー] > [ロギング] > [ログ エクスプローラ] の順にクリックします。

3. [クエリを表示] をクリックします。

   1. プロジェクト内の Dataplex タスクの失敗したジョブ実行に関するアラートを設定するには、次のクエリを入力します。

      severity=ERROR
      resource.type = "dataplex.googleapis.com/Task"
      logName = "projects/PROJECT_NAME/logs/dataplex.googleapis.com%2Fprocess"
      jsonPayload.state = "FAILED"
      

   2. プロジェクト内の特定の Dataplex タスクに対する失敗したジョブ実行のアラートを設定するには、次のクエリを入力します。

      severity=ERROR
      resource.type = "dataplex.googleapis.com/Task"
      resource.labels.task_id = TASK_ID
      logName = "projects/PROJECT_NAME/logs/dataplex.googleapis.com%2Fprocess"
      jsonPayload.state = "FAILED"
      

4. [アラートを作成] をクリックします。

5. [アラート ポリシー名] フィールドに、新しいアラートの名前を入力します。

6. [ドキュメント] フィールドに、通知に含める説明を入力します。アラート ポリシーのドキュメント フィールドに含めることができる内容の詳細については、ドキュメント テンプレートでマークダウンと変数を使用するをご覧ください。

7. [次へ] をクリックします。

8. アラートに含めるログを選択し、[次へ] をクリックします。

9. [通知間の時間] と [インシデントの自動クローズ期間] を設定し、[次へ] をクリックします。

10. 省略可: 通知チャンネルを選択します。Google Cloud コンソールを使用する通知チャンネルの構成についての詳細は、通知チャンネルを管理するをご覧ください。

11. [Save] をクリックします。

Monitoring API を使用して通知を設定する

1. Monitoring API を有効にし、ユーザーのアクセスを承認します。詳細については、Monitoring API の有効化をご覧ください。
2. アラート ポリシーの作成に必要なロールまたは権限を設定します。詳細については、アラート ポリシーの作成に必要な承認をご覧ください。
3. 通知チャンネルを作成するには、Google Cloud コンソール と Google Cloud CLI のいずれかを使用します。

4. 次のコマンドを使用して channel_id を取得します。

   gcloud beta monitoring channels list
   

5. log-based-alerting-policy 用に、次の内容の policy.json ファイルを作成します。

   1. プロジェクト内の Dataplex タスクの失敗したジョブ実行に関するアラートを設定するには、次のコードを使用します。

      {
      "displayName": "Alert Using Monitoring API",
      "documentation": {
        "content": "Log-based alert in project PROJECT.",
        "mimeType": "text/markdown"
      },
      
      "conditions": [
        {
          "displayName": "Log match condition: Failed Job Execution",
          "conditionMatchedLog": {
            "filter": "severity=\"ERROR\" resource.type = \"dataplex.googleapis.com/Task\" logName = \"projects/PROJECT_ID/logs/dataplex.googleapis.com%2Fprocess\" jsonPayload.state = \"FAILED\"",
          },
        }
      ],
      "combiner": "OR",
      
      "alertStrategy": {
        "notificationRateLimit": {
          "period": "300s"
        },
        "autoClose": "604800s",
      },
      
      "notificationChannels": [
        "projects/PROJECT_ID/notificationChannels/CHANNEL_ID"
      ]
      }
      

   2. プロジェクト内の特定の Dataplex タスクに対して失敗したジョブ実行に関するアラートを設定するには、次のコードを使用します。

      {
      "displayName": "Alert Using Monitoring API",
      "documentation": {
        "content": "Log-based alert in project PROJECT.",
        "mimeType": "text/markdown"
      },
      
      "conditions": [
        {
          "displayName": "Log match condition: Failed Job Execution",
          "conditionMatchedLog": {
            "filter": "severity=\"ERROR\" resource.type = \"dataplex.googleapis.com/Task\" logName = \"projects/PROJECT_ID/logs/dataplex.googleapis.com%2Fprocess\" jsonPayload.state = \"FAILED\" resource.labels.task_id = \"TASK_ID\"",
          },
        }
      ],
      "combiner": "OR",
      
      "alertStrategy": {
        "notificationRateLimit": {
          "period": "300s"
        },
        "autoClose": "604800s",
      },
      
      "notificationChannels": [
        "projects/PROJECT_ID/notificationChannels/CHANNEL_ID"
      ]
      }
      

6. 次のコマンドを使用して、policy.json ファイルを gcloud CLI に渡します。

   gcloud alpha monitoring policies create --policy-from-file="policy.json"
   

   成功すると、コマンドは新しいポリシーのリソース名を返します。次に例を示します。

   Created alert policy [projects/PROJECT_ID/alertPolicies/*POLICY_ID*].

次のステップ

• Cloud Logging の詳細を確認します。
• Dataplex のモニタリングを確認します。