Optimize Cloud SQL instances with high number of out-of-memory events

MySQL   |  PostgreSQL   |  SQL Server

Preview — Gemini in Databases

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. You can process personal data for this feature as outlined in the Cloud Data Processing Addendum, subject to the obligations and restrictions described in the agreement under which you access Google Cloud. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This page describes the Cloud SQL instance out-of-memory (OOM) optimization recommender which helps you detect instances that have a high number of OOM events within the last seven days.

This recommender detects instances that have a high number of OOM events. It then provides recommendations on how to optimize such instances and improve performance. Recommendations are generated daily.

Important: This recommender is only available if you have enabled Gemini in Databases. For more information on enabling Gemini in Databases, see Set up Database Center.

Pricing

The Cloud SQL OOM optimization 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 or cloudsql.viewer.
  Apply recommendations	One of these roles: recommender.cloudsqlAdmin, cloudsql.editor, or cloudsql.admin.

  For more information about IAM roles, see IAM basic and predefined roles reference and Manage access to projects, folders, and organizations.

• Enable the Recommender API.

  Enable the API

List OOM optimization recommendations for an instance

You can list OOM optimization recommendations for an instance 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:

1. Go to the Cloud SQL Instances page.

Go to Cloud SQL Instances

1. Click Expand Details on the Improve instance health by investigating issues and acting on recommendations banner.

Alternatively, follow these steps:

1. Go to the Recommendation Hub. See also Find and apply recommendations with the Recommendations.

2. Click Performance in the All recommendations card.

gcloud CLI

To list OOM optimization recommendations for an instance 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=MYSQL_FREQUENT_OUT_OF_MEMORY_BEST_PRACTICE

Replace the following:

• PROJECT_ID: Your project ID.
• LOCATION: A region where your instances are located, such as us-central1.

API

To list OOM optimization recommendations for an instance 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 as us-central1.

If the recommender detects instances with frequent OOM events, 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 instances that require an OOM optimization using the Google Cloud console, gcloud CLI, or the Recommender API.

Console

Do one of the following:

• On the Performance Recommendations page, click Performance recommendations card, click Frequent Out-of-Memory Best Practice. The recommendation panel appears, which contains insights and detailed recommendations for the instance.

• On the Instances page, click Frequent Out-of-Memory Best Practice. The list of instances displays only those instances for which the recommendation applies.

gcloud CLI

To view insights and detailed recommendations about instances that require an OOM optimization, 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=MYSQL_FREQUENT_OUT_OF_MEMORY

Replace the following:

• PROJECT_ID: Your project ID.
• LOCATION: A region where your instances are located, such as us-central1.

API

To view insights and detailed recommendations about instances that require an OOM optimization, use 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 where your instances are located, such as us-central1.

Apply recommendation

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.

What's next

• Google Cloud recommenders
• About database observability