Enabling the library

Setting Up Error Reporting for .NET

You can send error reports to Stackdriver Error Reporting from .NET applications by using the Stackdriver Error Reporting library for .NET.

Error Reporting is integrated with some Google Cloud Platform products, such as App Engine, Compute Engine, and Google Kubernetes Engine. Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those products. See Running on Google Cloud Platform for more information.

You can also send error data to Error Reporting using Stackdriver Logging. For information on the data formatting requirements, see Formatting error messages in Stackdriver Logging.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a Google Cloud Platform project.

    Go to the Manage resources page

  3. Make sure that billing is enabled for your Google Cloud Platform project.

    Learn how to enable billing

  4. Enable the Error Reporting API API.

    Enable the API

Installing the client library

Stackdriver Error Reporting library for .NET lets you monitor and view errors reported by .NET applications running nearly anywhere.

For more information on installation, see the documentation for the Stackdriver Error Reporting library for .NET. You can also report issues using the issue tracker.

Configuring the client library

You can customize the behavior of the Stackdriver Error Reporting library for .NET. See the .NET API Reference Documentation

Reporting errors

Install cloud libraries with the following commands:

Package Manager

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

.NET CLI

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

If you're using App Engine flexible environment, see the App Engine flexible environment section.

Running on Google Cloud Platform

Using the Stackdriver Error Reporting library for .NET requires the Cloud IAM Error Reporting Writer role. Most Google Cloud Platform computing platforms provide this role by default.

App Engine flexible environment

App Engine grants the Error Reporting Writer role by default.

The Stackdriver Error Reporting library for .NET can be used without needing to explicitly provide credentials.

Stackdriver Error Reporting is automatically enabled for App Engine flexible environment applications. No additional setup is required. Messages written from App Engine to stderr are analyzed and, if found to contain a stack trace, will be displayed by Error Reporting.

See Viewing Errors for instructions on viewing error and exception data for your application in the GCP Console.

GKE

On GKE, you must add the cloud-platform access scope when creating the cluster, as the following example command shows:

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

Compute Engine

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Error Reporting Writer role in the IAM & admin section of the GCP Console.

Running locally and elsewhere

To use the Stackdriver Error Reporting library for .NET outside of Google Cloud Platform, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for .NET. This applies to running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider. For more information see Obtaining and providing service account credentials manually.

Viewing error reports

After deployment, you can view error reports in the GCP Console Error Reporting dashboard.

Go to the Error Reporting dashboard

For more information, see Viewing Errors.

Setting Up Stackdriver Error Reporting for .NET Core applications

To use the Google.Cloud.Diagnostics.AspNetCore client library:

  1. Right-click your solution in Visual Studio and select Manage Nuget packages for solution.

  2. Select the Include prerelease checkbox.

  3. Search for and install the package named Google.Cloud.Diagnostics.AspNetCore.

  4. Once the Google.Cloud.Diagnostics.AspNetCore client is installed, add the following using directive to your application's source code files when you want to customize the error information being sent to Error Reporting:

     using Google.Cloud.Diagnostics.AspNetCore;
    

Then complete the following steps to log custom error reports from your application:

  1. Create or edit the ConfigureServices method in your application's Startup.cs file and call services.AddGoogleExceptionLogging():

    services.AddGoogleExceptionLogging(options =>
    {
        options.ProjectId = "YOUR-GOOGLE-PROJECT-ID";
        options.ServiceName = "ShoppingCartService";
        options.Version = "0.01";
    });
    
  2. Edit the Configure method in your application's Startup.cs file and call app.UseGoogleExceptionLogging() before calling app.UseStaticFiles() and app.UseMvc().

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

The following sample demonstrates logging errors to report a custom error event for ingestion by Stackdriver Error Reporting:

throw new Exception("Generic exception for testing Stackdriver Error Reporting");
Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Error Reporting
Need help? Visit our support page.