This page describes the Cloud SQL optimize high memory queries recommender which reports queries with high memory utilization.
This recommender reports normalized query text of the queries terminated to prevent out-of-memory errors in the past 24 hours. It then provides recommendations on how to optimize such instances and improve performance. Recommendations are generated daily.
Pricing
The Cloud SQL optimize high memory queries recommender is in the Standard Recommender pricing tier.
Before you begin
Before you can view recommendations and insights, do the following:
- To get the permissions to view and work with insights and recommendations,
ensure that you have the required Identity and Access Management (IAM) roles.
Tasks Roles View recommendations One of these roles: recommender.cloudsqlViewer
orcloudsql.viewer
.Apply recommendations One of these roles: recommender.cloudsqlAdmin
,cloudsql.editor
, orcloudsql.admin
. -
Enable the Recommender API.
List recommendations for optimizing queries with high memory usage
You can list recommendations for optimizing queries with high memory usage
using the Google Cloud console, gcloud CLI
, or the Recommender API.
Console
To list recommendations about instance performance by using the
Google Cloud console, follow these steps:
- Go to the Cloud SQL Instances page.
- Click Expand Details on the Improve instance health by investigating issues and acting on recommendations banner.
Alternatively, follow these steps:
Go to the Recommendation Hub. See also Find and apply recommendations with the Recommendations.
Click Performance in the All recommendations card.
gcloud CLI
To list optimization recommendations for queries with high memory usage using gcloud CLI, run the
gcloud recommender recommendations list
command as follows:
gcloud recommender recommendations list \ --project=PROJECT_ID \ --location=LOCATION \ --recommender=google.cloudsql.instance.PerformanceRecommender \ --filter=recommenderSubtype=POSTGRES_OPTIMIZE_HIGH_MEMORY_QUERIES
Replace the following:
PROJECT_ID
: Your project ID.LOCATION
: A region where your instances are located, such asus-central1
.
API
To list optimization recommendations for queries with high memory usage using the
Recommendations API, call the
recommendations.list
method as follows:
GET https://recommender.googleapis.com/v1/projects/PROJECT-ID/locations/LOCATION/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations
Replace the following:
PROJECT_ID
: Your project ID.LOCATION
: A region where your instances are located, such asus-central1
.
If the recommender reports instances with terminated queries, it lists them in a table. Each row shows the instance name, a brief recommendation, the current machine type, the recommended machine type, the location, and the last refresh date.
View insights and detailed recommendations
You can view insights and detailed recommendations for optimizing queries with high memory usage using the Google Cloud console,
gcloud
, or the Recommender API.
Console
Do one of the following:
On the Performance Recommendations page, click Performance recommendations card, click Optimize High Memory Queries. The recommendation panel appears, which contains insights and detailed recommendations for the instance.
On the Instances page, click Optimize High Memory Queries. The list of instances displays only those instances for which the recommendation applies.
gcloud CLI
To view insights and detailed recommendations for optimizing queries with high memory usage using gcloud
, run the
gcloud recommender insights list
command as follows:
gcloud recommender insights list \ --project=PROJECT_ID \ --location=LOCATION \ --insight-type=google.cloudsql.instance.PerformanceInsight \ --filter=insightSubtype=POSTGRES_HIGH_MEMORY_QUERIES_TERMINATED_TO_PREVENT_OOM
Replace the following:
PROJECT_ID
: Your project ID.LOCATION
: A region, such asus-central1
.
API
To view insights and detailed recommendations for optimizing queries with high memory usage using the Recommendations API,
call the insights.list
method as follows:
GET https://recommender.googleapis.com/v1/projects/PROJECT-ID/locations/LOCATION/insightTypes/google.cloudsql.instance.PerformanceInsight/insights
Replace the following:
PROJECT_ID
: Your project ID.LOCATION
: A region, such asus-central1
.
Apply recommendations
Evaluate the recommendation carefully and do any of the following:
- For more information, see Optimize instance high memory usage.
- To dismiss the recommendation so that it's de-emphasized and appears dimmed, click Dismiss.
- To close the panel without applying or dismissing the recommendation, click Cancel.