このドキュメントでは、Error Reporting でサポートされている環境の一覧と、アプリケーション開発者向けの言語固有のガイドへのリンクを示します。言語固有のクライアント ライブラリを使用するか、自動的に収集されるログを使用することをおすすめします。ただし、Cloud Logging API または Error Reporting API を使用してエラーデータを書き込むことができます。たとえば、Cloud Run を使用している場合、stderr
に書き込まれる例外は自動的に Cloud Logging に送信されます。
Error Reporting は、Google Cloud プロジェクトのログを自動的に分析してエラーを特定するグローバル サービスです。ただし、Error Reporting はグローバル サービスであり、送信元と宛先の Google Cloud プロジェクトが同じで、顧客管理の暗号鍵(CMEK)が無効になっている global
リージョンで Cloud Logging バケットに保存されているログエントリのみ分析できます。ログを別の Google Cloud プロジェクトまたはリージョン バケットにルーティングしているか、CMEK を有効にした場合、Error Reporting はそれらのログのキャプチャと分析を行いません。
ログバケットの構成を確認する方法については、トラブルシューティングをご覧ください。
Virtual Private Cloud のサポート
Error Reporting は、Virtual Private Cloud(VPC)のサポート対象のサービスです。
データの引き出しのリスクを軽減するには、VPC Service Controls を使用して、Google マネージド サービスの周囲にサービス境界を作成します。VPC Service Controls の概要、およびサービス パラメータの作成方法については、VPC Service Controls のドキュメントをご覧ください。
エラーデータを自動的に報告するように環境を構成する
環境に固有の構成の要件については、次のガイドをご覧ください。
- App Engine フレキシブル環境
- App Engine スタンダード環境
- Apps Script
- Cloud Functions
- Cloud Run
- Compute Engine
- Google Kubernetes Engine
- Amazon EC2
クライアント ライブラリを使用してアプリをインストルメント化する
アプリケーションを構成してエラーレポートを送信する方法については、言語に固有の構成ガイドをご覧ください。
API を使用してエラーデータを書き込む
Error Reporting API メソッド report
または Cloud Logging API メソッド write
を実行することで、Google Cloud プロジェクトにエラーイベントを報告できます。
API キーベースの認証が必要な場合は、Error Reporting API を使用する必要があります。Error Reporting API を使用してエラーイベントを報告するには、メソッド
report
を実行して、メソッドのリクエスト本文をReportedErrorEvent
オブジェクトとしてフォーマットします。Error Reporting API を使用すると、正しい形式のエラー メッセージを含むログエントリが自動的に生成され、Cloud Logging に書き込まれます。これらのログエントリは、次のような
logName
の形式のログに書き込まれます。projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors
ログエントリは
report
の呼び出しによって生成されるため、Cloud Logging の取り込み料金が発生することがあります。取り込むログを指定するには、除外フィルタをご覧ください。Error Reporting API を使用してエラーイベントを報告した場合、このドキュメントの残りの部分は適用されません。
Cloud Logging API を使用する場合は、スタック トレースまたは
ReportedErrorEvent
オブジェクトを含むようにLogEntry
オブジェクトの形式を設定する必要があります。形式の要件の詳細については、ログの形式設定エラーをご覧ください。