Error Reporting API は次の機能を提供します。
- 実行中のサービスからエラーを報告するためのシンプルなエンドポイント。
- エラーグループおよび関連エラーへの読み取りアクセス。
ご利用にあたって
Error Reporting API を有効にします。
API を有効にするために必要なロール
API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。詳しくは、ロールを付与する方法をご覧ください。
API の使用を承認する
Error Reporting API へのアクセスは、Identity and Access Management のロールと権限によって制御されます。 Google Cloud API の認証と認可について詳しくは、認証ガイドをご覧ください。
データモデル
Error Reporting API はエラーイベント、エラーグループ、エラーグループ統計の 3 つのエンティティを定義します。エラーグループ統計オブジェクトは、ほとんどのユーザーが最も頻繁に対話するオブジェクトです。
エラーイベント
ErrorEvent は、アプリケーションで発生したエラーの単一のインスタンスを表します。このオブジェクトには、エラーが発生した時刻、発生したコンテキスト、返されたエラー メッセージなど、エラーに関する情報が含まれています。エラー イベントは、生成されてから少なくとも 30 日間は利用できます。
エラーグループ
ErrorGroup オブジェクトは、エラーイベントの論理的にグループ化されたコレクションです。グループ化は、エラーイベントのスタック トレース内の情報に基づいています。エラーグループはシンプルなオブジェクトで、名前、グループ ID、グループのために関連する問題追跡のみが含まれます。
トラッキング問題の URL を更新するには、このリソースの 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 メソッドにリクエストを送信します。1 つ以上のクエリ パラメータを渡して、返されるグループ統計情報をフィルタできます。
エラーイベントの一覧表示
特定のエラーグループに属するエラーイベントのリストを取得するには、events.list メソッドにリクエストを送信します。これらのリクエストにフィルタ条件を渡すと、特定の日時の間に発生したエラー イベントや、特定のサービス コンテキストに一致するエラー イベントのみを取得できます。
エラーグループを取得
特定のエラーグループ リソースを取得するには、groups.get メソッドにリクエストを送信します。
エラーグループを更新
エラーグループに関連付けられているトラッキング問題の URL を更新するには、更新された ErrorGroup リソースを groups.update メソッドに送信します。