Ensure that the 'log_lock_waits' database flag for Cloud SQL PostgreSQL instance is set to 'on'

Enabling log_lock_waits flag will enable logging of any session waits that take longer than deadlock_timeout. This feature is recommended in order to increase logging details for your PostgreSQL database instances, and it might help to identify poor performance.

Risk Level: Low
Cloud Entity: GCP CloudSql
CloudGuard Rule ID: D9.GCP.LOG.04
Covered by Spectral: Yes
Category: Database

GSL LOGIC

CloudSql where databaseVersion like 'POSTGRES%' should have settings.databaseFlags contain [ name like 'log_lock_waits' and value like 'on' ]

REMEDIATION

From Portal

  1. Go to https://console.cloud.google.com/sql/instances and navigate to the instance where the flag needs to be set
  2. Click Edit Configurations
  3. Under flags section, choose add flag, look for log_lock_waits and choose value - on.
  4. Save and review your changes

From TF
Set the flag 'log_lock_waits' to 'on':

resource 'google_sql_database_instance' 'default' {
	...
	settings {
		database_flags {
			name  = 'log_lock_waits'
			value = 'on'
		}
	}
}

From Command Line

  1. First retrieve all existing flags values:
gcloud sql instances describe INSTANCE_NAME
  1. Add all existing flags and their value to the patch request - otherwise they will get set to their default value.
gcloud sql instances patch INSTANCE_NAME --database-flags (ExistingFlag1=Value1,ExistingFlag2=Value2,...),log_lock_waits=on

References

  1. https://cloud.google.com/sdk/gcloud/reference/sql/instances/describe
  2. https://cloud.google.com/sdk/gcloud/reference/sql/instances/patch#--database-flags
  3. https://cloud.google.com/sql/docs/postgres/flags
  4. https://www.postgresql.org/docs/9.6/runtime-config-locks.html#GUC-DEADLOCK-TIMEOUT
  5. https://www.postgresql.org/docs/9.6/runtime-config-logging.html#GUC-LOG-LOCK-WAITS

GCP CloudSql

Cloud SQL is a fully managed database service that makes it easy to set up, maintain, manage, and administer your relational PostgreSQL, MySQL, and SQL Server databases in the cloud.

Compliance Frameworks

  • CloudGuard GCP All Rules Ruleset
  • GCP CIS Foundations v. 1.1.0
  • GCP CIS Foundations v. 1.2.0
  • GCP CloudGuard Best Practices
  • GCP MITRE ATT&CK Framework v12.1
  • GCP NIST 800-53 Rev 5