Ensure GCP PostgreSQL instance database flag log_connections is enabled

Error: GCP PostgreSQL instance database flag log_connections is disabled

Bridgecrew Policy ID: BC_GCP_SQL_3
Checkov Check ID: CKV_GCP_52
Severity: LOW

GCP PostgreSQL instance database flag log_connections is disabled

Description

PostgreSQL does not log attempted connections by default. Enabling the log_connections setting creates log entries for each attempted connection to the server, along with successful completion of client authentication. This information can be useful in troubleshooting issues and to determine any unusual connection attempts to the server.

We recommend you set the log_connections database flag for Cloud SQL PostgreSQL instances to on.

Fix - Runtime

GCP Console

To change the policy using the GCP Console, follow these steps:

  1. Log in to the GCP Console at https://console.cloud.google.com.
  2. Navigate to Cloud SQL Instances.
  3. Select the PostgreSQL instance for which you want to enable the database flag.
  4. Click Edit.
  5. Scroll down to the Flags section.
  6. To set a flag that has not been set on the instance before, click Add item.
  7. Select the flag log_connections from the drop-down menu, and set the value to on.
  8. Click Save.
  9. Confirm the changes in the Flags section on the Overview page.

CLI Command

  1. List all Cloud SQL database instances using the following command:
    gcloud sql instances list
  2. Configure the log_connections database flag for every Cloud SQL PosgreSQL database instance using the following command:
    gcloud sql instances patch INSTANCE_NAME --database-flags log_connections=on

📘

Note

This command will overwrite all previously set database flags. To keep those 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 ("=").se flags. To keep those 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:
    databaseversion = "POSTGRES* "
    settings::database_flags: key:"log_connections", value: by default set to "off"
resource "google_sql_database_instance" "default" {
  name             = "master-instance"
  database_version = "POSTGRES_11"
  region           = "us-central1"

  settings {
+         database_flags {
+            name  = "log_connections"
+            value = "on"
          }
  }
}

Did this page help you?