Instrument C# apps for Error Reporting

The Google.Cloud.Diagnostics set of libraries lets you send error events directly from your C# applications to Error Reporting so that you can diagnose and monitor runtime crashes. Instrumenting your application with the library lets you report custom error events and capture errors even when your log buckets use customer-managed encryption keys (CMEK).

For applications running on integrated Google Cloud services—including Cloud Run functions, App Engine, Compute Engine, and Google Kubernetes Engine—Error Reporting can also infer error events automatically from Cloud Logging without the Google.Cloud.Diagnostics set of libraries . For Error Reporting to infer error events from logs, your log entries must follow the error formatting requirements and be stored in a non-CMEK log bucket owned by the originating project or by the destination project to which the logs were routed.

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

Install the client library

The Google.Cloud.Diagnostics set of libraries lets you monitor and view error events reported by C# applications running nearly anywhere.

1. For applications that target ASP.NET Core 3 or later, use the Google.Cloud.Diagnostics.AspNetCore3 library. You can install this library from NuGet.
2. For applications that target earlier versions of ASP.NET Core, use the Google.Cloud.Diagnostics.AspNetCore library. You can install this library from NuGet.
3. For applications that target non ASP.NET Core frameworks, use the Google.Cloud.Diagnostics.Common library. You can install this library from NuGet.

For more information on installation, read the documentation for the Google.Cloud.Diagnostics set of libraries . You can also report issues using the issue tracker.

Configure the client library

For more information and examples, see the following resources:

Google.Cloud.Diagnostics.AspNetCore3 documentation

Google.Cloud.Diagnostics.AspNetCore documentation

Google.Cloud.Diagnostics.Common documentation

Run apps on Google Cloud

To create error groups by using projects.events.report, your service account requires the Error Reporting Writer role (roles/errorreporting.writer).

Some Google Cloud services automatically grant the Error Reporting Writer role (roles/errorreporting.writer) to the appropriate service account. However, you must grant this role to the appropriate service account for some services.

Cloud Run and Cloud Run functions

The default service account used by Cloud Run has the permissions of Error Reporting Writer role (roles/errorreporting.writer).

The Google.Cloud.Diagnostics set of libraries can be used without needing to explicitly provide credentials.

Cloud Run is configured to use Error Reporting automatically. Unhandled JavaScript exceptions will appear in Logging and be processed by Error Reporting without needing to use the Google.Cloud.Diagnostics set of libraries .

Note: Error Reporting automatically creates an error event when a log entry contains a stack trace and the severity level of the log entry isn't set or is set to at least ERROR.

App Engine flexible environment

App Engine grants the Error Reporting Writer role (roles/errorreporting.writer) to your default service account automatically.

The Google.Cloud.Diagnostics set of libraries can be used without needing to explicitly provide credentials.

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 Google Cloud console.

Google Kubernetes Engine

To use Error Reporting with Google Kubernetes Engine, do the following:

1. Ensure that the service account to be used by your container has been granted the Error Reporting Writer role (roles/errorreporting.writer).

   You can use either the Compute Engine default service account or a custom service account.

   For information about granting roles, see Manage access to projects, folders, and organizations.

2. Create your cluster and grant the cluster the cloud-platform access scope.

   For example, the following create command specifies the cloud-platform access scope and a service account:

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

Note: After you create a cluster, you can't change its service account.

Compute Engine

To use Error Reporting with Compute Engine VM instances, do the following:

1. Ensure that the service account to be used by your VM instance has been granted the Error Reporting Writer role (roles/errorreporting.writer).

   You can use either the Compute Engine default service account or a custom service account.

   For information about granting roles, see Manage access to projects, folders, and organizations.

2. In the Google Cloud console, go to the VM instances page:

   Go to VM instances

   If you use the search bar to find this page, then select the result whose subheading is Compute Engine.

3. Select the VM instance that you want to receive the cloud-platform access scope.

4. Click Stop, and then click Edit.

5. In the Identity and API access section, select a service account that has the Error Reporting Writer role (roles/errorreporting.writer).

6. In the Access scopes section, select Allow full access to all Cloud APIs, and then save your changes.

7. Click Start/Resume.

Example

For more information and examples, see the following resources:

Google.Cloud.Diagnostics.AspNetCore3 documentation

Google.Cloud.Diagnostics.AspNetCore documentation

Google.Cloud.Diagnostics.Common documentation

Run apps in a local development environment

To use the Google.Cloud.Diagnostics set of libraries in a local development environment, such as running the library on your own workstation, you must provide your Google.Cloud.Diagnostics set of libraries with the local application default credentials. For more information, see Authenticate to Error Reporting.

To use the .NET samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

For more information, see Set up authentication for a local development environment.

The projects.events.report method also supports API keys. If you want to use API keys for authentication, you do not need to set up a local Application Default Credentials file. For more information, see Create an API key in the Google Cloud authentication documentation.

View error groups

In the Google Cloud console, go to the Error Reporting page:

Go to Error Reporting

You can also find this page by using the search bar.

For more information, see View and filter error groups.