設定 Dataplex 通用目錄工作專案的快訊和通知

本頁說明如何為 Dataplex Universal Catalog 工作的執行失敗事件設定快訊。

如要設定快訊，可以使用 Google Cloud 控制台 中的記錄檔探索工具或 Monitoring API。

術語

  • 事件自動關閉期限：如果這段時間內沒有相符的記錄項目，系統就會自動關閉事件。
  • 通知間隔時間：設定相同通知的間隔時間，即可降低重複通知的頻率。在這段期間，系統會略過符合篩選條件的記錄項目。時間下限為 5 分鐘。

使用記錄檔探索工具設定通知

  1. 前往 Google Cloud 控制台的「Logs Explorer」頁面。

    前往「Logs explorer」(記錄檔探索工具)

  2. 按一下「顯示查詢」切換按鈕。

    1. 如要為專案中任何 Dataplex Universal Catalog 工作的工作執行失敗事件設定快訊，請輸入下列查詢：

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

    2. 如要為專案中特定 Dataplex Universal Catalog 工作的工作執行失敗事件設定快訊，請輸入下列查詢：

      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"

  3. 按一下「建立快訊」。

  4. 在「快訊政策名稱」欄位中，輸入新快訊的名稱。

  5. 在「Documentation」(說明文件) 欄位中，輸入要加入通知的說明。如要進一步瞭解可在快訊政策的說明文件欄位中加入的內容，請參閱「在說明文件範本中使用 Markdown 和變數」。

  6. 點選「下一步」。

  7. 選擇要納入快訊的記錄檔，然後點選「下一步」。

  8. 設定「通知傳送間隔時間」和「事件自動關閉期限」，然後點選「下一步」。

  9. 選用：選取通知管道。如要進一步瞭解如何使用 Google Cloud 控制台設定通知管道，請參閱「管理通知管道」。

  10. 按一下 [儲存]。

使用 Monitoring API 設定通知

  1. 選用：啟用 Monitoring API，並授權使用者存取。詳情請參閱「啟用 Monitoring API」。
  2. 選用：設定建立快訊政策所需的角色或權限。 詳情請參閱建立快訊政策時需要授權。
  3. 使用Google Cloud 控制台或 Google Cloud CLI 建立通知管道。

  4. 取得 channel_id：

    gcloud beta monitoring channels list

  5. 建立 policy.json 檔案，並加入以下內容，以設定以記錄為準的快訊政策：

    1. 為專案中任何 Dataplex Universal Catalog 工作的工作執行失敗設定快訊：

      {
"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 Universal Catalog 工作設定工作執行失敗快訊：

      {
"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*].

後續步驟