為儲存庫資源設定記錄式警告

本頁說明如何透過 Google Cloud 控制台的「Logs Explorer」頁面,為儲存庫資源設定以記錄為基礎的警示。

Logs Explorer 頁面會引導您完成下列步驟,建立及編輯以記錄為基礎的警報:

  • 提供警告的名稱和說明。
  • 選擇要接收通知的記錄檔。
  • 設定通知間隔時間。
  • 設定自動關閉事件的時間。
  • 指定通知對象。

您可以為工作類別設定警示:SCHEDULED_BACKUPON_DEMAND_BACKUPRESTORE。您也可以為工作狀態設定警示:SUCCESSFULFAILEDSKIPPEDRUNNING

您可以設定一或多個通知管道 (例如 Google Chat、電子郵件、簡訊或即時通訊程式管道),以便在發生快訊時收到通知。如需操作說明,請參閱「建立及管理通知管道」。

事前準備

建立記錄式警告

如要發出快訊,您必須具備通知管道。您可以在建立快訊之前或建立快訊時建立通知管道。

請按照下列操作說明建立記錄式警報。

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

    前往「Logs Explorer」

  2. 在「查詢」窗格中,定義要接收通知的快訊。

    以下查詢為範例,可在排定的備份工作失敗時收到通知。

      logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
      jsonPayload.jobCategory="SCHEDULED_BACKUP"
      jsonPayload.jobStatus="FAILED"
    

    更改下列內容:

    • PROJECT_ID:專案名稱。
  3. 在「查詢結果」窗格的標頭中,按一下「建立快訊」

  4. 在「Alert details」(快訊詳細資料) 部分執行下列操作:

    1. 在「Alert Policy Name」欄位中輸入快訊的名稱。這個名稱會顯示在通知標頭中。
    2. 在「Documentation」欄位中輸入快訊的說明。如要瞭解如何格式化及精修這個欄位的內容,請參閱「在文件範本中使用 Markdown 和變數」。
  5. 點按「Next」

  6. 在「Choose logs to include in the alert」(選擇要加入快訊的記錄檔) 區段中,執行下列操作:

    1. 按一下「Preview logs」即可查看查詢和結果。如有需要,您也可以在這個窗格中編輯查詢。
    2. 按一下「Add a label」,然後執行下列操作。標籤可讓您自訂通知,讓通知更具資訊性。

      1. 在「Display name」欄位中,輸入標籤名稱。
      2. 從「Log field name」清單中選取記錄檔欄位名稱。系統會根據所選查詢結果顯示這些欄位。
      3. 在「規則運算式」欄位中輸入運算式,擷取特定欄位的值,該欄位只能包含一個規則運算式群組。
  7. 點按「Next」

  8. 在「Set notification frequency and autoclose duration」(設定通知頻率和自動關閉期限) 區段中,執行下列操作:

    1. 在「Time between notifications」清單中,選取通知間隔時間下限。這個值可讓您控制如果觸發多次,會收到這項快訊的通知幾次。
    2. 在「事件自動關閉期限」清單中,選取期限,缺少相符記錄項目時,事件經過這段時間後便會自動關閉。
  9. 點按「Next」

  10. 在「Notification channels」清單中,選取一或多個快訊通知管道。如果您尚未設定通知管道,請按一下「管理通知管道」來建立管道。如需操作說明,請參閱「建立及管理通知管道」。

  11. 按一下 [儲存]

測試以記錄為基礎的警告

如要測試您建立的以記錄為基礎的警告,可以手動寫入符合查詢的記錄項目。

請按照下列指示撰寫記錄項目。

  1. 前往 logEntries.write 參考頁面。

    前往 logEntries.write

  2. PROJECT_ID 變數變更為您的專案 ID,設定下列記錄項目。

          {
            "entries": [
              {
                "jsonPayload": {
                  "jobCategory": "SCHEDULED_BACKUP",
                  "jobStatus": "FAILED"
                }
              }
            ],
            "resource": {
              "type": "backupdr.googleapis.com/BackupDRProject"
            },
            "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
          }
    

    更改下列內容:

    • PROJECT_ID:專案名稱。
  3. 複製先前設定的日誌項目。

  4. 在「Try this API (試用這個 API)」窗格中,請按照下列步驟操作:

    1. 在「Request body」欄位中,將內容替換為您在上一個步驟中複製的記錄項目。
    2. 按一下 [Execute] (執行)。如果系統出現提示,請按照驗證流程操作。
  5. 如果 logEntries.write 呼叫成功,您會收到 HTTP 200 回應代碼和空白回應主體 {}。如要進一步瞭解 API Explorer,請參閱「使用 API Explorer」一文。

    記錄項目會以以下方式符合快訊指定的篩選器:

    • logName 值會指定雲端專案中的備份或還原工作記錄。
    • jsonPayload 包含失敗的工作類別 SCHEDULED_BACKUP,表示記錄與備份方案排定的備份相關。
    • jsonPayload 包含欄位工作狀態為 FAILED,表示工作失敗。
  6. 寫入記錄項目後,系統會執行以下程序:

    1. Logs Explorer 中會顯示新的記錄項目,並觸發快訊。
    2. 系統會在 Cloud Monitoring 頁面中開啟事件。
    3. 您會收到事件通知。如果您已設定電子郵件通知管道,系統就會顯示通知。

      您可以點選電子郵件中的「View incident」,在「Cloud Monitoring」頁面中查看事件。如要進一步瞭解事件 (包括如何確認及關閉事件),請參閱「管理記錄檔型快訊的事件」。