lacework-global-312
Set 'Log_error_verbosity' Database Flag for Cloud SQL PostgreSQL Instance to 'DEFAULT' or Stricter (Automated)
Profile Applicability
• Level 2
Description
The log_error_verbosity
flag controls the verbosity/details of messages logged. Valid values are:
TERSE
DEFAULT
VERBOSE
TERSE
excludes the logging of DETAIL
, HINT
, QUERY
, and CONTEXT
error information. VERBOSE
output includes the SQLSTATE
error code, source code filename, function name, and line number that generated the error.
Set log_error_verbosity to 'DEFAULT' or stricter.
Rationale
Auditing helps in troubleshooting operational problems and also permits forensic analysis. If log_error_verbosity
is not set to the correct value, too many details or too few details may be logged. This flag should be configured with a value of 'DEFAULT' or stricter. 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
Configuration
card - Under
Database flags
, check the value oflog_error_verbosity
flag is set to 'DEFAULT' or stricter.
From Command Line:
- Use the below command for every Cloud SQL PostgreSQL database instance to verify the value of
log_error_verbosity
gcloud sql instances list --format=json | jq '.settings.databaseFlags[] | select(.name=="log_error_verbosity")|.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_error_verbosity
from the drop-down menu and set appropriate value. - Click
Save
to save your changes. - Confirm your changes under
Flags
on the Overview page.
From Command Line:
- Configure the
log_error_verbosity
database flag for every Cloud SQL PosgreSQL database instance using the below command:
gcloud sql instances patch <instance_name> --database-flags log_error_verbosity=<TERSE|DEFAULT|VERBOSE>
This command overwrites all database flags previously set. To keep those and add new ones, include the values for all flags you want 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/current/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 Operational Guidelines.
Configuring the preceding flag does not require restarting the Cloud SQL instance.