Overview

Error Reporting API 提供下列功能:

  • 簡單的端點,可回報執行中服務的錯誤。
  • 可讀取錯誤群組和相關錯誤。

開始使用

啟用 Error Reporting API。

啟用 API 時所需的角色

如要啟用 API,您需要服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin),其中包含 serviceusage.services.enable 權限。瞭解如何授予角色

啟用 API

授權使用 API

Error Reporting API 的存取權由 Identity and Access Management 角色和權限控管。如要進一步瞭解 Google Cloud API 的驗證和授權,請參閱驗證指南

資料模型

Error Reporting API 定義了三種實體:錯誤事件、錯誤群組和錯誤群組統計資料。錯誤群組統計資料物件是大多數使用者最常互動的物件。

錯誤事件

ErrorEvent 代表應用程式中發生的單一錯誤。這個物件包含錯誤相關資訊,例如發生時間、發生背景脈絡,以及傳回的錯誤訊息。系統保證錯誤事件會在產生後至少保留 30 天。

錯誤群組

ErrorGroup 物件是錯誤事件的邏輯分組集合。分組依據是錯誤事件堆疊追蹤中的資訊。錯誤群組是簡單的物件,只包含名稱、群組 ID,以及與群組相關聯的任何追蹤問題。

如要更新追蹤問題網址,請使用這項資源的 update 方法。

錯誤群組統計資料

ErrorGroupStats 物件包含錯誤群組的詳細資訊,也是您最常互動的 API 物件。groupStats 物件中的資訊包括這個群組中錯誤事件的首次和最後一次發生時間、計數、受影響的使用者人數等。建構小工具和自訂資訊主頁時,這個物件非常實用。

作業

Error Reporting API 支援下列作業:

  • 回報新的錯誤事件
  • 列出錯誤群組統計資料
  • 列出錯誤事件
  • 取得錯誤群組
  • 更新錯誤群組的追蹤問題

回報錯誤事件

您可以將錯誤事件寫入 ReportedErrorEvent,從執行中的服務回報錯誤事件。這樣做會在 Cloud Logging 中產生格式正確的錯誤訊息。產生的記錄名稱格式為 projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors。使用這種方法可能會產生少許 Cloud Logging 擷取費用;如要控管這些費用,請參閱「記錄排除項目」。

您也可以從執行中的服務組裝錯誤事件實體,然後傳送至 events.report 方法,向 Error Reporting 回報新的錯誤事件。

列出錯誤群組統計資料

如要取得錯誤群組統計資料清單,請對 groupStats.list 方法傳送要求。您可以傳遞一或多個查詢參數,篩選傳回的群組統計資料。

列出錯誤事件

如要取得特定錯誤群組的錯誤事件清單,請向 events.list 方法傳送要求。您可以將篩選條件傳遞至這些要求,只擷取特定開始和結束時間之間發生的錯誤事件,或符合特定服務環境的錯誤事件。

取得錯誤群組

如要擷取特定錯誤群組資源,請向 groups.get 方法傳送要求。

更新錯誤群組

如要更新與錯誤群組相關聯的追蹤問題網址,請將更新後的 ErrorGroup 資源傳送至 groups.update 方法。