Error Reporting 用の C# アプリのインストルメント化

C# アプリケーションから Error Reporting にエラーレポートを送信するには、ライブラリの Google.Cloud.Diagnostics セットを使用します。次の場合は、ライブラリの Google.Cloud.Diagnostics セットを使用してエラーグループを作成します。

  • ログバケットには顧客管理の暗号鍵（CMEK）が含まれています。
  • ログバケットが global リージョンにない
  • カスタム エラーイベントを報告する。

Error Reporting は、App Engine、Compute Engine、Google Kubernetes Engine などの一部の Google Cloud サービスに統合されています。Error Reporting は、こうしたサービスで実行されるアプリケーションによって Cloud Logging に記録されたエラーを表示します。詳細については、このページの Google Cloud での実行をご覧ください。

Logging を使用して、エラーデータを Error Reporting に送信することもできます。データ形式の要件については、Logging のエラー メッセージの形式設定をご覧ください。

準備

  1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

  2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

  4. Error Reporting API を有効にします。

    API を有効にする

    5.

  5. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

    プロジェクト セレクタに移動

  6. Google Cloud プロジェクトで課金が有効になっていることを確認します。

  7. Error Reporting API を有効にします。

    API を有効にする

    8.

クライアント ライブラリをインストールする

ライブラリの Google.Cloud.Diagnostics セットを使用すると、ほぼすべての場所で動作している C# アプリケーションから報告されるエラーをモニタリングして表示できます。

  1. ASP.NET Core 3 以降を対象とするアプリケーションの場合は、Google.Cloud.Diagnostics.AspNetCore3 ライブラリを使用します。このライブラリは NuGet からインストールできます。
  2. ASP.NET Core の以前のバージョンを対象とするアプリケーションの場合は、Google.Cloud.Diagnostics.AspNetCore ライブラリを使用します。このライブラリは NuGet からインストールできます。
  3. ASP.NET Core フレームワーク以外を対象とするアプリケーションでは、Google.Cloud.Diagnostics.Common ライブラリを使用します。このライブラリは NuGet からインストールできます。

インストールの詳細については、ライブラリの Google.Cloud.Diagnostics セットのドキュメントをご覧ください。公開バグトラッカーを使用して問題を報告することもできます。

クライアント ライブラリを設定する

詳細と例については、次のリソースをご覧ください。

  • Google.Cloud.Diagnostics.AspNetCore3ドキュメント
  • Google.Cloud.Diagnostics.AspNetCoreドキュメント
  • Google.Cloud.Diagnostics.Commonドキュメント

    • Google Cloud でアプリを実行する

    projects.events.report を使用してエラーグループを作成するには、サービス アカウントに Error Reporting 書き込みロール（roles/errorreporting.writer）が必要です。

    一部の Google Cloud サービスでは、Error Reporting 書き込みロール（roles/errorreporting.writer）が適切なサービス アカウントに自動的に付与されます。ただし、一部のサービスに適したサービス アカウントにこのロールを付与する必要があります。

    App Engine フレキシブル環境

    App Engine では、デフォルトのサービス アカウントに Error Reporting 書き込みロール（roles/errorreporting.writer）が自動的に付与されます。

    ライブラリの Google.Cloud.Diagnostics セットを使用できます。認証情報を明示的に提供する必要はありません。

    App Engine フレキシブル環境のアプリケーションでは、Error Reporting が自動的に有効になります。特別な設定は必要ありません。App Engine から stderr に書き込まれたメッセージは分析され、メッセージにスタック トレースが含まれていることが検出されると、Error Reporting によってそのメッセージが表示されます。

    Google Cloud コンソールでアプリケーションのエラーと例外データを表示する手順については、エラーの表示をご覧ください。

    Google Kubernetes Engine

    Google Kubernetes Engine で Error Reporting を使用するには、次の操作を行います。

    1. コンテナが使用するサービス アカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

      Compute Engine のデフォルトのサービス アカウントまたはカスタム サービス アカウントを使用できます。

      ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

    2. クラスタを作成し、そのクラスタに cloud-platform アクセス スコープを付与します。

      たとえば、次の create コマンドでは、cloud-platform アクセス スコープとサービス アカウントを指定します。

      gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform

    Compute Engine

    Compute Engine の VM インスタンスで Error Reporting を使用するには、次のようにします。

    1. VM インスタンスが使用するサービス アカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

      Compute Engine のデフォルトのサービス アカウントまたはカスタム サービス アカウントを使用できます。

      ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

    2. Google Cloud コンソールのナビゲーション パネルで、[Compute Engine] を選択してから、[VM インスタンス] を選択します。

      [VM インスタンス] に移動

    3. cloud-platform アクセス スコープを受け取る VM インスタンスを選択します。

    4. [停止]、[編集] の順にクリックします。

    5. [ID と API へのアクセス] セクションで、Error Reporting 書き込みロール（roles/errorreporting.writer）を持つサービス アカウントを選択します。

    6. [アクセス スコープ] セクションで、[すべての Cloud API に完全アクセス権を許可] を選択して、変更内容を保存します。

    7. [開始 / 再開] をクリックします。

    例

    詳細と例については、次のリソースをご覧ください。

  • Google.Cloud.Diagnostics.AspNetCore3ドキュメント
  • Google.Cloud.Diagnostics.AspNetCoreドキュメント
  • Google.Cloud.Diagnostics.Commonドキュメント

    • ローカル開発環境でアプリを実行する

    自分のワークステーションでライブラリを実行するなど、ローカル開発環境でライブラリの Google.Cloud.Diagnostics セットを使用するには、ローカル アプリケーションのデフォルト認証情報を使用してライブラリの Google.Cloud.Diagnostics セットを指定する必要があります。詳細については、Error Reporting に対する認証をご覧ください。

    このページの .NET サンプルをローカル開発環境から使用するには、gcloud CLI をインストールして初期化し、自身のユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定してください。

    1. Google Cloud CLI をインストールします。

    2. gcloud CLI を初期化するには:

      gcloud init

    3. Google アカウントのローカル認証情報を作成します。

      gcloud auth application-default login

    詳細については、 ローカル開発環境の認証の設定 をご覧ください。

    projects.events.report メソッドは API キーもサポートしています。 認証に API キーを使用する場合、ローカルのアプリケーションのデフォルト認証情報ファイルを設定する必要はありません。詳細については、Google Cloud の認証に関するドキュメントの API キーを作成するをご覧ください。

    エラーレポートの表示

    Google Cloud コンソールのナビゲーション パネルで [エラーレポート] を選択し、Google Cloud プロジェクトを選択します。

    Error Reporting に移動

    詳細については、エラーの表示をご覧ください。