lacework-global-277
Set the 'Log_connections' Database Flag for Cloud SQL PostgreSQL Instance to 'On' (Automated)
Profile Applicability
• Level 1
Description
Enabling the log_connections
setting logs each attempted connection to the server, along with successful completion of client authentication. It is not possible to change this parameter after the session starts.
Rationale
PostgreSQL does not log attempted connections by default. Enabling the log_connections
setting will create log entries for each attempted connection as well as successful completion of client authentication which can be useful in troubleshooting issues and to determine any unusual connection attempts to the server. This recommendation is applicable to PostgreSQL database instances.
Impact
Turning on logging will increase the required storage over time. Mismanaged logs may cause your storage costs to increase. Setting custom flags via command line on certain instances will cause all omitted flags to be reset to defaults. This may cause you to lose custom flags and could result in unforeseen complications or instance restarts. Because of this, it is recommended you apply these flags changes during a period of low usage.
Audit
From Console:
- Go to the Cloud SQL Instances page in the Google Cloud Console by visiting https://console.cloud.google.com/sql/instances.
- Select the instance to open its
Instance Overview
page. - Go to the
Configuration
card. - Under
Database flags
, check the value oflog_connections
flag to determine if it is configured as expected.
From Command Line:
- Ensure the below command returns
on
for every Cloud SQL PostgreSQL database instance:
gcloud sql instances list --format=json | jq '.settings.databaseFlags[] | select(.name=="log_connections")|.value'
Remediation
From Console:
- Go to the Cloud SQL Instances page in the Google Cloud Console by visiting: https://console.cloud.google.com/sql/instances.
- Select the PostgreSQL instance for which you want to enable the database flag.
- Click
Edit
. - Scroll down to the
Flags
section. - To set a flag that is new to the instance, click
Add item
, choose the flaglog_connections
from the drop-down menu and set the value ason
. - Click
Save
. - Confirm the changes under
Flags
on the Overview page.
From Command Line:
- Configure the
log_connections
database flag for every Cloud SQL PosgreSQL database instance using the below command.
gcloud sql instances patch <instance_name> --database-flags log_connections=on
This command overwrites all previously set database flags. To keep those and add new ones, include the values for all flags to set on the instance; any flag not specifically included uses the default value. For flags that do not take a value, specify the flag name followed by an equals sign ("=").
References
https://cloud.google.com/sql/docs/postgres/flags
https://www.postgresql.org/docs/9.6/runtime-config-logging.html#RUNTIME-CONFIG-LOGGING-WHAT
Additional Information
This patch modifies database flag values, which may require you to restart your instance. The list of supported flags is on this page, along with details of which flags require a restart: https://cloud.google.com/sql/docs/postgres/flags.
Some database flag settings can affect instance availability or stability and remove the instance from the Cloud SQL Service-Level Agreement (SLA). For information about these flags, see the Operational Guidelines.
Configuring the preceding flag does not require restarting the Cloud SQL instance.