GCP PostgreSQL instance with log_checkpoints database flag is disabled
Description
Enabling log_checkpoints causes checkpoints and restart points to be logged in the server log. Some statistics are included in the log messages, including the number of buffers written, and the time spent writing them. This parameter can only be set in the postgresql.conf file or on the server command line. We recommended you set the log_checkpoints database flag for the Cloud SQL PostgreSQL instance to on.
Code Example
resource "google_sql_database_instance" "default" {
name = "master-instance"
database_version = "POSTGRES_11"
region = "us-central1"
settings {
+ database_flags {
+ name = "log_checkpoints"
+ value = "on"
}
}
}Remediation
- GCP Console To change the policy using the GCP Console, follow these steps:*
. Log in to the GCP Console at https://console.cloud.google.com.
. Navigate to https://console.cloud.google.com/sql/instances [Cloud SQL Instances].
. Select the * PostgreSQL instance* where the database flag needs to be enabled.
. Click * Edit*.
. Scroll down to the * Flags* section.
. To set a flag that has not been set on the instance before, click * Add item*.
. Select the flag * log_checkpoints* from the drop-down menu, and set its value to * On*.
. Click * Save*.
. Confirm the changes in the * Flags* section on the * Overview* page.
- CLI Command*
. List all Cloud SQL database instances using the following command: `gcloud sql instances list`
. Configure the `log_checkpoints` database flag for every Cloud SQL PosgreSQL database instance using the below command: `gcloud sql instances patch INSTANCE_NAME --database-flags log_checkpoints=on` + NOTE: This command will overwrite all previously set database flags. To keep those flags, and add new ones, include the values for all flags to be set on the instance. Any flag not specifically included is set to its default value. For flags that do not take a value, specify the flag name followed by an equals sign (=).
=== Fix - Buildtime
Terraform
- Resource: google_sql_database_instance
- Arguments: database_version = "POSTGRES_* " settings::database_flags: key:"log_checkpoints", value: by default set to "off"
Rule Details
| Field | Value |
|---|---|
| ID | IAC-0910 |
| Severity | LOW |
| IaC Type | Terraform |
| Frameworks | Terraform, TerraformPlan |
| Checkov ID | CKV_GCP_51 |