.NET 用 Error Reporting の設定

ライブラリの有効化

は、

.NET 用 Stackdriver Error Reporting ライブラリを使用すると、.NET アプリケーションから Stackdriver Error Reporting にエラーレポートを送信できます。

Error Reporting は、App EngineCompute EngineGoogle Kubernetes Engine などの一部の Google Cloud Platform プロダクトに統合されています。Error Reporting は、それらのプロダクトで実行中のアプリケーションによって Stackdriver Logging に記録されたエラーを表示します。詳細については、Google Cloud Platform での実行をご覧ください。

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

始める前に

  1. Google アカウントにログインします。

    Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

  2. GCP プロジェクトを選択または作成します。

    [リソースの管理] ページに移動

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

    課金を有効にする方法について

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

    APIを有効にする

クライアント ライブラリのインストール

.NET 用の Stackdriver Error Reporting ライブラリを使用すると、ほとんどの場所で稼働している .NET アプリケーションから報告されるエラーをモニタリングして表示できます。

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

クライアント ライブラリの構成

.NET 用 Stackdriver Error Reporting ライブラリの動作はカスタマイズできます。.NET API リファレンス ドキュメントをご覧ください。

エラーの報告

次のコマンドを使用して、クラウド ライブラリをインストールします。

パッケージ マネージャー

PM> Install-Package Google.Cloud.Diagnostics.AspNetCore -Version 2.0.1

.NET CLI

> dotnet add package Google.Cloud.Diagnostics.AspNetCore --version 2.0.1

App Engine フレキシブル環境を使用している場合は、App Engine フレキシブル環境のセクションをご覧ください。

Google Cloud Platform での実行

.NET 用 Stackdriver Error Reporting ライブラリを使用するには、Cloud IAM Error Reporting 書き込み役割が必要です。ほとんどの Google Cloud Platform コンピューティング プラットフォームでは、デフォルトでこの役割が付与されます。

App Engine フレキシブル環境

App Engine は、デフォルトで Error Reporting 書き込み役割を付与します。

.NET 用 Stackdriver Error Reporting ライブラリは、明示的に認証情報を提示しなくても使用できます。

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

GCP Console で使用するアプリケーションのエラーや例外データを確認する手順については、エラーの表示をご覧ください。

GKE

GKE では、次のコマンド例に示すように、クラスタの作成時に cloud-platform アクセス スコープを追加する必要があります。

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

Compute Engine VM インスタンスを使用する場合は、各インスタンスに cloud-platform アクセス スコープを追加します。Google Cloud Platform Console で新しいインスタンスを作成する場合は、[インスタンスの作成] パネルの [ID と API へのアクセス] セクションで行うことができます。Compute Engine のデフォルト サービス アカウントや別のサービス アカウントを使用して、[ID と API へのアクセス] セクションの [すべての Cloud API に完全アクセス権を許可] を選択します。どのサービス アカウントを選択する場合でも、GCP Console の [IAM と管理] セクションで、そのアカウントに Error Reporting 書き込み役割が付与されていることを確認してください。

ローカルやその他の場所での実行

Google Cloud Platform の外部で .NET 用 Stackdriver Error Reporting ライブラリを使用するには、GCP プロジェクト ID と該当するサービス アカウント認証情報を .NET 用 Stackdriver Error Reporting ライブラリに直接指定する必要があります。この要件が適用されるのは、独自のワークステーション、データセンターのコンピュータ、または他のクラウド プロバイダの VM インスタンスでライブラリを実行する場合です。詳細については、サービス アカウントの認証情報を手動で取得して指定するをご覧ください。

エラーレポートの表示

デプロイ後は、GCP Console の Error Reporting ダッシュボードでエラーレポートを表示できます。

Error Reporting ダッシュボードに移動

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

.NET Core アプリケーション用の Stackdriver Error Reporting の設定

Google.Cloud.Diagnostics.AspNetCore クライアント ライブラリを使用するには:

  1. Visual Studio でソリューションを右クリックして、[ソリューション用の NuGet パッケージを管理] を選択します。

  2. [プレリリースを含む] チェックボックスを選択します。

  3. Google.Cloud.Diagnostics.AspNetCore という名前のパッケージを検索して、インストールします。

  4. Google.Cloud.Diagnostics.AspNetCore クライアントをインストールした後、Error Reporting に送信されるエラー情報をカスタマイズするには、アプリケーションのソースコード ファイルに次の using ディレクティブを追加します。

     using Google.Cloud.Diagnostics.AspNetCore;
    

その後、次の手順に従って、アプリケーションからのカスタム エラーレポートをログに記録します。

  1. アプリケーションの Startup.cs ファイル内で ConfigureServices メソッドを作成または編集し、services.AddGoogleExceptionLogging() を呼び出します。

    services.AddGoogleExceptionLogging(options =>
    {
        options.ProjectId = "YOUR-GOOGLE-PROJECT-ID";
        options.ServiceName = "ShoppingCartService";
        options.Version = "0.01";
    });
    
  2. アプリケーションの Startup.cs ファイル内で Configure メソッドを編集し、app.UseGoogleExceptionLogging() を呼び出してから app.UseStaticFiles()app.UseMvc() を呼び出します。

    // Use before handling any requests to ensure all unhandled exceptions are reported.
    app.UseGoogleExceptionLogging();
    

次のサンプルは、エラーをログに記録し、Stackdriver Error Reporting で取り込めるよう、カスタム エラーイベントを報告する方法を示しています。

throw new Exception("Generic exception for testing Stackdriver Error Reporting");
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Stackdriver Error Reporting
ご不明な点がありましたら、Google のサポートページをご覧ください。