The [Google.Cloud.Diagnostics set of libraries](https://github.com/googleapis/google-cloud-dotnet) 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)](https://docs.cloud.google.com/kms/docs/cmek.md.txt).

For applications running on integrated Google Cloud services---including
[Cloud Run functions](https://docs.cloud.google.com/error-reporting/docs/setup/dotnet.md.txt#cloud_functions),
[App Engine](https://docs.cloud.google.com/appengine/docs.md.txt), [Compute Engine](https://docs.cloud.google.com/compute/docs.md.txt), and
[Google Kubernetes Engine](https://docs.cloud.google.com/kubernetes-engine/docs.md.txt)---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](https://docs.cloud.google.com/error-reporting/docs/formatting-error-messages.md.txt)
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

## 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](https://www.nuget.org/packages/Google.Cloud.Diagnostics.AspNetCore3/).
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](https://www.nuget.org/packages/Google.Cloud.Diagnostics.AspNetCore/).
3. For applications that target non ASP.NET Core frameworks, use the `Google.Cloud.Diagnostics.Common` library. You can install this library from [NuGet](https://www.nuget.org/packages/Google.Cloud.Diagnostics.Common/).

For more information on installation, read the
[documentation](https://docs.cloud.google.com/error-reporting/docs/setup/dotnet.md.txt#installing_the_client_library) for the

Google.Cloud.Diagnostics set of libraries
. You can also report issues using the
[issue tracker](https://github.com/googleapis/google-cloud-dotnet/issues).

### Configure the client library


For more information and examples, see the following resources:
- [`Google.Cloud.Diagnostics.AspNetCore3`
  documentation](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.AspNetCore3/latest#configuration)
- [`Google.Cloud.Diagnostics.AspNetCore`
  documentation](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.AspNetCore/latest#configuration)
- [`Google.Cloud.Diagnostics.Common`
  documentation](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.Common/latest#configuration)

## Run apps on Google Cloud

- To create error groups by using [`projects.events.report`](https://docs.cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report.md.txt), your service account requires the [Error Reporting Writer role](https://docs.cloud.google.com/error-reporting/docs/iam.md.txt#errorreporting.writer) (`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](https://docs.cloud.google.com/run/docs.md.txt) has the permissions of [Error Reporting Writer role](https://docs.cloud.google.com/error-reporting/docs/iam.md.txt#errorreporting.writer) (`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]
> **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](https://docs.cloud.google.com/appengine/docs.md.txt) grants the [Error Reporting Writer role](https://docs.cloud.google.com/error-reporting/docs/iam.md.txt#errorreporting.writer) (`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](https://docs.cloud.google.com/error-reporting/docs/viewing-errors.md.txt) 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](https://docs.cloud.google.com/error-reporting/docs/iam.md.txt#errorreporting.writer) (`roles/errorreporting.writer`).

     You can use either the [Compute Engine default service account](https://docs.cloud.google.com/compute/docs/access/service-accounts.md.txt#default_service_account)
     or a custom service account.

     For information about granting roles, see
     [Manage access to projects, folders, and organizations](https://docs.cloud.google.com/iam/docs/granting-changing-revoking-access.md.txt).
  2. Create your cluster and grant the cluster the
     `cloud-platform` [access scope](https://docs.cloud.google.com/compute/docs/access/service-accounts.md.txt#accesscopesiam).

     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]
> **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](https://docs.cloud.google.com/error-reporting/docs/iam.md.txt#errorreporting.writer) (`roles/errorreporting.writer`).

     You can use either the [Compute Engine default service account](https://docs.cloud.google.com/compute/docs/access/service-accounts.md.txt#default_service_account)
     or a custom service account.

     For information about granting roles, see
     [Manage access to projects, folders, and organizations](https://docs.cloud.google.com/iam/docs/granting-changing-revoking-access.md.txt).
  2. In the Google Cloud console, go to the **VM instances** page:

     [Go to **VM instances**](https://console.cloud.google.com/compute/instances)

     <br />

     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](https://docs.cloud.google.com/compute/docs/access/service-accounts.md.txt#accesscopesiam).

  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](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.AspNetCore3/latest#configuration)
- [`Google.Cloud.Diagnostics.AspNetCore`
  documentation](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.AspNetCore/latest#configuration)
- [`Google.Cloud.Diagnostics.Common`
  documentation](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.Diagnostics.Common/latest#configuration)

## 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](https://docs.cloud.google.com/error-reporting/docs/reference/authentication.md.txt#client-libs).
- 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](https://docs.cloud.google.com/sdk/docs/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](https://docs.cloud.google.com/iam/docs/workforce-log-in-gcloud.md.txt).

  3.

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

     ```bash
     gcloud auth application-default login
     ```

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

     > [!NOTE]
     >
     > **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:
     >
     > ```bash
     > 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](https://docs.cloud.google.com/iam/docs/workforce-log-in-gcloud.md.txt).
- For more information, see [Set up authentication for a local development environment](https://docs.cloud.google.com/error-reporting/docs/reference/authentication.md.txt#local-development).
- The [`projects.events.report` method](https://docs.cloud.google.com/error-reporting/reference/rest/v1beta1/projects.events/report.md.txt) 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](https://docs.cloud.google.com/docs/authentication/api-keys.md.txt#create) in the Google Cloud authentication documentation.

## View error groups

- In the Google Cloud console, go to the **Error Reporting** page:
- [Go to **Error Reporting**](https://console.cloud.google.com/errors)
- You can also find this page by using the search bar.
- For more information, see [View and filter error groups](https://docs.cloud.google.com/error-reporting/docs/viewing-errors.md.txt).