使用平台記錄檔

本頁說明如何查看 SaaS Runtime 產生的平台記錄。平台記錄檔 Google Cloud 是服務專屬記錄檔，可用於偵錯及排解問題，並進一步瞭解您使用的 Google Cloud服務。

如要瞭解支援的 SaaS 執行階段平台記錄，請參閱Google Cloud 平台記錄。如要進一步瞭解如何解讀平台記錄資料表中的資料，請參閱「記錄項目結構」。

事前準備

  1. 在 Google Cloud 控制台的專案選擇器頁面中，選取或建立 Google Cloud 專案。
  2. 確認您已為 Google Cloud 專案啟用計費功能。
  3. 啟用 SaaS Runtime API。
  4. 如要取得查看記錄和建立快訊所需的權限，請要求管理員在專案中授予您下列 Identity and Access Management (IAM) 角色：
    • 記錄檢視者 (roles/logging.viewer)
    • Monitoring 編輯者 (roles/monitoring.editor)

建立記錄檔型快訊

如要建立記錄型快訊，請在 Logs Explorer 中建構查詢，傳回您要接收快訊的記錄項目，然後設定快訊政策。

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

    前往 Logs Explorer

  2. 在查詢編輯器中輸入查詢，篩選所選記錄項目。 如需查詢範例，請參閱下列各節。

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

  4. 輸入快訊政策的名稱和說明。

  5. 設定快訊詳細資料，包括通知管道。

  6. 按一下「儲存快訊」。

如需詳細操作說明，請參閱「建立以記錄為基礎的快訊」。

平台記錄的查詢範例

本節提供常見快訊情境的查詢範例，這些情境是以 SaaS 執行階段平台記錄為依據。

SaaS 營運快訊

如要在單元佈建作業失敗時建立快訊，請使用下列查詢：

protoPayload.methodName="google.cloud.saasplatform.saasservicemgmt.v1beta1.SaasDeployments.CreateUnitOperation"
protoPayload.response.state="UNIT_OPERATION_STATE_FAILED"

如要在單元佈建作業達到終端狀態 (成功、失敗或取消) 時建立快訊，請使用下列查詢：

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.UnitOperationLog"
AND (jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_SUCCEEDED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_FAILED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_CANCELLED")
AND jsonPayload.unit_operation_type="PROVISION"

推出作業快訊

如要建立快訊，在區域推出作業因使用者動作以外的原因進入 PAUSED 或 FAILED 狀態時觸發，請使用下列查詢：

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.reason!="USER_PAUSE"
AND jsonPayload.root_rollout_id != resource.labels.rollout_id

如要在全域推出進入 PAUSED 或 FAILED 狀態時建立快訊，請使用下列查詢：

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.root_rollout_id == resource.labels.rollout_id

如要建立記錄快訊，在推出作業進入 PAUSED 狀態 (因為 SaaS 執行階段已將推出作業識別為不正常) 或 FAILED 狀態時收到通知，請使用下列查詢：

logName:"rollout_events" 
(jsonPayload.currentState="PAUSED" jsonPayload.reason="SYSTEM_PAUSE")
OR 
jsonPayload.currentState="FAILED

如要在推出作業進入 PAUSED 狀態 (因為 SaaS Runtime 已將推出作業識別為不正常) 或 FAILED 狀態時，為推出作業狀態指標建立記錄快訊，請使用下列查詢：

saasservicemgmt_googleapis_com:rollout_state
{state_name="PAUSED", reason="SYSTEM_PAUSE"}
OR
saasservicemgmt_googleapis_com:rollout_state{state_name="FAILED"}

後續步驟