GCP Cloud SQL for PostgreSQL Integration

GCP Cloud SQL for PostgreSQL monitoring is essential for tracking database performance, query behavior, and resource utilization in cloud environments. This guide explains how to set up Cloud SQL for PostgreSQL monitoring in Middleware using a GCE VM host agent, enabling full observability into queries, metrics, and performance bottlenecks. The agent runs on a GCE VM you control and connects to the managed database over the network—not on the Cloud SQL instance itself.

Prerequisites#

  • Middleware Host Agent on GCE VM: Install the Linux Host Agent on a GCE VM that has network connectivity to your Cloud SQL endpoint. Follow Installing the Agent and the Linux Host Agent steps.
  • Managed database: Do not attempt to install the Host Agent on Cloud SQL. Cloud SQL is a managed service; integration is always GCE VM (agent) → Cloud SQL for PostgreSQL using a credentials file on the VM and the PostgreSQL integration in Middleware.

Retrieve connection details from GCP#

Gather the following before you configure Middleware:

  • Public or private IP and port: In the Google Cloud console, open SQL → your instance → Overview. Copy the Public IP address or Private IP address and Port (PostgreSQL default is 5432).
  • Database name: The initial database created with the instance, or another database you created.
  • Username and password: The postgres admin user or a dedicated monitoring user you create in SQL (see Step 3). Store passwords securely (for example in Secret Manager or your team's vault); rotate them according to your policy.

Network connectivity#

  • Authorized networks: In the Google Cloud console, go to your Cloud SQL instance → ConnectionsNetworking. Add the public IP of your GCE VM to Authorized networks, or use a private IP if both resources share a VPC.
  • Placement: The GCE VM running the agent should be in a VPC that can reach the Cloud SQL endpoint (same VPC is typical for private IP; for public IP, the VM's external IP must be in the authorized networks list).
  • Verification: From the GCE VM, test connectivity (for example with psql or nc -zv <ip> <port>) before relying on the integration.

Setup#

1 Set database flags#

Cloud SQL uses database flags instead of editing postgresql.conf on disk.

  • In the Google Cloud console, go to SQL → your instance → EditFlags.
  • Add or update the following flags:
    • cloudsql.enable_pg_stat_statements = on
    • pg_stat_statements.track = all
    • pg_stat_statements.max = 10000 (or your chosen limit)
    • pg_stat_statements.save = on
    • track_io_timing = on
  • Click Save. Cloud SQL may restart the instance for certain flag changes to take effect.
  • Connect to the database (for example with psql from the GCE VM) and run as a user with sufficient privileges:
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
SELECT calls, query FROM pg_stat_statements LIMIT 1;

You should see a row once statements have executed (your values will differ):

calls | query
-------+-------------------------------
     8 | SELECT * FROM t WHERE field = $1

2 Configure TLS with SSL client certificates#

GCP Cloud SQL is the only major cloud platform that supports SSL client certificates alongside a CA certificate. The TLS setup differs depending on whether you use a public or private IP.

Public IP — resolve the SAN hostname

Cloud SQL's server certificate uses a Subject Alternative Name (SAN) that does not match the instance's public IP. You must resolve this hostname on the GCE VM running the agent.

  1. Retrieve the SAN DNS name from the Cloud SQL server certificate:
openssl s_client -connect YOUR_CLOUDSQL_IP:PORT -starttls postgres 2>/dev/null | \
  openssl x509 -noout -subject -ext subjectAltName
  1. Add an entry in /etc/hosts on the GCE VM so that the SAN hostname resolves to the Cloud SQL public IP:
sudo sh -c 'echo "YOUR_CLOUDSQL_IP DNS_LISTED_UNDER_SAN" >> /etc/hosts'
  1. Use the SAN DNS name (not the IP) as the host when configuring the PostgreSQL integration in Middleware (i.e. DNS_NAME:PORT instead of IP:PORT).

Download certificates

In the Google Cloud console, go to SQL → your instance → ConnectionsSecurityManage SSL client certificates:

  • Create a client certificate — download the three files:
    • server-ca.pem (CA certificate)
    • client-cert.pem (client certificate)
    • client-key.pem (client key)
  • Place all three files on the GCE VM where the Middleware Host Agent runs (for example in /etc/mw-certs/).

3 (optional): Create a least-privileged user#

If you do not want to use the admin user for monitoring, create a read-only user with minimal privileges. Run against the Cloud SQL endpoint (for example from the GCE VM using psql):

CREATE USER lpu WITH PASSWORD 'pass';

Verify:

\du

Grant minimal access:

-- allow connections to the database you'll monitor
GRANT CONNECT ON DATABASE <your_db_name> TO lpu;

-- permit reading statement stats
GRANT SELECT ON pg_stat_statements TO lpu;

-- permit reading global stats where needed
GRANT pg_read_all_stats TO lpu;

Test with the lpu account:

SELECT calls, query FROM pg_stat_statements LIMIT 1;

4 Open the integration in Middleware#

In Middleware, go to InstallationsAll IntegrationsPostgreSQL.

GCP Cloud SQL for PostgreSQL Monitoring with Middleware

5 Fill the integration form#

In the PostgreSQL integration form:

  • Select the GCE VM host (from the dropdown) where the Middleware Host Agent runs.
  • Enter the required connection details:
    • Database name
    • Host — use the SAN DNS name if connecting over public IP (see Step 2), or the private IP if using private connectivity
    • Username
    • Password
  • (Optional) Query Collection:
    • Query Sample Collection captures sampled query activity (query text, state, wait events, and client/application details) for troubleshooting.
    • Top Query Collection captures aggregated high-impact query metrics (calls, rows, block I/O, and planning/execution timings) from pg_stat_statements.
  • (Optional) Schema Collection captures database schema and table metadata for schema visibility in Middleware.
  • TLS Settings:
    • Set Allow Insecure to false and Skip Certificate Verification to false.
    • Provide the paths to the certificate files downloaded in Step 2:
      • CA certificate file path — e.g. /etc/mw-certs/server-ca.pem
      • Client certificate file path — e.g. /etc/mw-certs/client-cert.pem
      • Client key file path — e.g. /etc/mw-certs/client-key.pem

6 Save and enable the integration#

  • Click Save.
GCP Cloud SQL for PostgreSQL integration save confirmation in Middleware

Once saved, the integration starts ingesting metrics from your Cloud SQL for PostgreSQL instance.

Visualise your Data#

Default PostgreSQL dashboard#

After setup, Middleware adds a PostgreSQL dashboard to the Dashboard Builder. Use it as a starting point to explore key DB metrics without building widgets from scratch.

Create custom widgets#

When adding a widget, choose data source postgresql to browse all exposed metrics and craft charts for your SLOs or run-book checks.

Alerts#

You can alert on any PostgreSQL metric. Create a rule using Database as the detection method and PostgreSQL as the database type; the Metrics dropdown then lists all available metrics for this integration. Configure conditions, thresholds, and recipients as usual.

Metrics Collected#

The following metrics are emitted when enabled in the PostgreSQL receiver (names and descriptions align with the integration's metric definitions). Cloud SQL for PostgreSQL uses the same metric set as self-hosted PostgreSQL.

Core Engine & Storage#

Metric NameDescription
postgresql.backendsThe number of backends.
postgresql.blocks_readThe number of blocks read (tagged by block read source).
postgresql.buffer_hitThe number of disk block hits in the buffer cache, thereby avoiding database reads, tagged with database name.
postgresql.db_sizeThe database disk usage.
postgresql.database.countNumber of user databases.

Tables, Indexes & Maintenance#

Metric NameDescription
postgresql.table.countNumber of user tables in a database.
postgresql.table.sizeDisk space used by a table.
postgresql.table.vacuum.countNumber of times a table has manually been vacuumed.
postgresql.table_bloatEstimated table bloat ratio (actual pages / expected pages); 1.0 indicates no bloat.
postgresql.analyzedNumber of times a table has been manually analyzed.
postgresql.autoanalyzedNumber of times a table has been automatically analyzed.
postgresql.autovacuumedNumber of times a table has been automatically vacuumed.
postgresql.index.scansThe number of index scans on a table.
postgresql.index.sizeThe size of the index on disk.
postgresql.index.blocks_readThe number of disk blocks read by this index (tagged by source).
postgresql.index.rows_readThe number of index entries returned by scans on this index.
postgresql.index_bloatEstimated index bloat ratio (actual pages / expected pages); 1.0 indicates no bloat.

TOAST#

Metric NameDescription
postgresql.toast.blocks_hitNumber of TOAST block hits.
postgresql.toast.index.blocks_readNumber of TOAST index block reads.
postgresql.toast.sizeSize of TOAST table.

Transactions & Row Activity#

Metric NameDescription
postgresql.commitsThe number of commits.
postgresql.rollbacksThe number of rollbacks.
postgresql.rowsThe number of rows in the database (tagged by row state).
postgresql.rows_deletedRows deleted by queries in this database, tagged with relation name.
postgresql.rows_fetchedRows fetched by queries in this database, tagged with relation name.
postgresql.rows_insertedRows inserted by queries in the database, tagged with relation name.
postgresql.rows_updatedRows updated by queries in the database, tagged with relation name.
postgresql.operationsThe number of database row operations (tagged by operation: ins, upd, del, hot_upd).

Checkpointing & Background Writer#

Metric NameDescription
postgresql.bgwriter.checkpoint.countThe number of checkpoints performed (tagged by checkpoint type).
postgresql.bgwriter.durationTotal time spent writing and syncing files to disk by checkpoints (tagged by duration type).
postgresql.bgwriter.maxwrittenNumber of times the background writer stopped a cleaning scan because it had written too many buffers.
postgresql.bgwriter.buffers.writesNumber of buffers written (tagged by buffer source).
postgresql.bgwriter.buffers.allocatedNumber of buffers allocated.

Connections & Limits#

Metric NameDescription
postgresql.connection.countThe number of active connections to this database; when DBM is enabled, tagged with state, application name, database, and user.
postgresql.connection.maxConfigured maximum number of client connections allowed.

Statement-level (via pg_stat_statements)#

Metric NameDescription
postgresql.query.countNumber of times the statement was executed (tagged with query_text, query_id).
postgresql.query.total_exec_timeTotal wait time of the normalised timed events (nanoseconds; tagged with query_text, query_id).

Replication & WAL#

Metric NameDescription
postgresql.replication.data_delayThe amount of data delayed in replication (tagged with replication client).
postgresql.wal.ageAge of the oldest WAL file (requires WAL with at least one replica).
postgresql.wal.countNumber of WAL files.
postgresql.wal.lagTime between flushing recent WAL locally and receiving notification that the standby completed an operation (tagged by operation and replication client; requires WAL with at least one replica).
postgresql.wal.sizeTotal size of WAL files.

Live Row Estimates#

Metric NameDescription
postgresql.live_rowsThe approximate number of live rows, tagged with relation name.

Active Transaction Duration#

Metric NameDescription
postgresql.transactions.duration.maxMax duration of active transactions.
postgresql.transactions.duration.sumSum of duration of active transactions.

Troubleshooting#

"Integrations" menu not visible

If you do not see Integrations in Middleware, your account probably lacks Installation permissions. Ask an admin to add Installation to your role in Settings.

No metrics or connection failures

  • Confirm the GCE VM can reach the Cloud SQL instance (check authorized networks, firewall rules, and VPC configuration).
  • Confirm the credentials use the correct host (SAN DNS name for public IP, or private IP) and port reachable from the VM.
  • Verify database flags are set and pg_stat_statements is enabled, and the database user has the grants from Step 3.
  • For public IP connections, ensure /etc/hosts maps the Cloud SQL IP to the SAN DNS name (see Step 2).
  • Ensure SSL certificates (server-ca.pem, client-cert.pem, client-key.pem) are present on the VM and paths are correctly entered in the integration form.

Need assistance or want to learn more about Middleware? Contact our support team at [email protected] or join our Slack channel.