Error Reporting notification recommender and insights

The Error Reporting recommender looks for recent crashes in your Google Cloud project and provides recommendations if you have not configured Error Reporting notifications. When you have notifications configured, no recommendations are made.

This document describes how to enable and view your recommendations and insights.

Before you begin

Before you can view Error Reporting recommendations and insights, you must do the following:

Enable the Recommender API as described in Enable the API.

Ensure that you have sufficient permission. You must have one of the following roles, which provide the necessary permissions:

Task description	Role
View recommendations/insights	`roles/recommender.errorReportingViewer`
View and update (dismiss) recommendations/insights	`roles/recommender.errorReportingAdmin`
Opt out of recommendations/insights in Transparency and Control Center. For more information, see Opting out.	`roles/dataprocessing.admin`

These Recommender roles provide the following API permissions:

Role	Included permissions
`roles/recommender.errorReportingViewer`	`recommender.errorReportingInsights.get` `recommender.errorReportingInsights.list` `recommender.errorReportingRecommendations.get` `recommender.errorReportingRecommendations.list`
`roles/recommender.errorReportingAdmin`	`roles/recommender.errorReportingViewer` permissions, plus `recommender.errorReportingInsights.update` `recommender.errorReportingRecommendations.update`

For more information about roles and about granting access, see the following:

View recommendations

Recommender displays recommendations in the Google Cloud console. You can also list recommendations by using the Google Cloud CLI or the Recommender API.

Google Cloud console

To view your recommendations, do the following:

Go to the Google Cloud console, or use the following button:

Go to Google Cloud console
Select the Recommendations tab.

gcloud CLI

To list your Error Reporting recommendations by using the gcloud CLI, run the following command:

gcloud recommender recommendations list \
    --recommender=google.clouderrorreporting.Recommender \
    --project=PROJECT_ID \
    --location=global

Replace PROJECT_ID with the identifier for your Google Cloud project.

For more information about this command, including options for the output format, see gcloud recommender recommendations list.

Recommender API

To list your Error Reporting recommendations by using the Recommender API, run the following command:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  \
"https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/global/recommenders/google.clouderrorreporting.Recommender/recommendations"

Replace PROJECT_ID with the identifier for your Google Cloud project.

For more information, see Using the API - Recommendations.

View insights

The Error Reporting recommender generates recommendations based on insights. You can retrieve these insights by using the Google Cloud CLI or the Recommender API.

gcloud CLI

To list your Error Reporting insights by using the gcloud CLI, run the following command:

gcloud recommender insights list \
    --insight-type=google.clouderrorreporting.Insight \
    --project=PROJECT_ID \
    --location=global

Replace PROJECT_ID with the identifier for your Google Cloud project.

For more information about this command, including options for the output format, see gcloud recommender insights list.

Recommender API

To list your Error Reporting insights by using the Recommender API, run the following command:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)"  \
"https://recommender.googleapis.com/v1/projects/PROJECT_ID/locations/global/recommenders/google.clouderrorreporting.Insight/insights"

Replace PROJECT_ID with the identifier for your Google Cloud project.

For more information, see Using the API - Insights.

Pricing

Error Reporting recommendations and insights are available free of charge. For information about other pricing tiers, see Recommender pricing.