The PostgreSQL integration collects database-usage metrics, such as the database size, the number of backends, or the number of operations. The integration also collects PostgreSQL logs and parses them into a JSON payload. This result includes fields for role, user, level, and message.
For more information about PostgreSQL, see the PostgreSQL documentation.
PrerequisitesTo collect PostgreSQL telemetry, you must install the Ops Agent:
This integration supports PostgreSQL version 10.18+.
Configure your PostgreSQL instanceThe postgresql
receiver connects by default to a local postgresql
server using a Unix socket and Unix authentication as the root
user.
Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from PostgreSQL instances, and restart the agent.
Example configurationThe following commands create the configuration to collect and ingest telemetry for PostgreSQL:
For these changes to take effect, you must restart the Ops Agent:
Linuxsudo systemctl restart google-cloud-ops-agent
sudo systemctl status "google-cloud-ops-agent*"
Restart-Service google-cloud-ops-agent -Force
Get-Service google-cloud-ops-agent*
To ingest logs from PostgreSQL, you must create a receiver for the logs that PostgreSQL produces and then create a pipeline for the new receiver.
To configure a receiver for your postgresql_general
logs, specify the following fields:
exclude_paths
A list of filesystem path patterns to exclude from the set matched by include_paths
. include_paths
[/var/log/postgresql/postgresql*.log, /var/lib/pgsql/data/log/postgresql*.log, /var/lib/pgsql/*/data/log/postgresql*.log]
A list of filesystem paths to read by tailing each file. A wild card (*
) can be used in the paths. record_log_file_path
false
If set to true
, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path
label. When using a wildcard, only the path of the file from which the record was obtained is recorded. type
This value must be postgresql_general
. wildcard_refresh_interval
60s
The interval at which wildcard file paths in include_paths
are refreshed. Given as a time duration, for example 30s
or 2m
. This property might be useful under high logging throughputs where log files are rotated faster than the default interval. What is logged
The logName
is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry
are as follows.
The postgresql_general
logs contain the following fields in the LogEntry
:
jsonPayload.database
string Database name for the action being logged when relevant jsonPayload.level
string Log severity or type of database interaction type for some logs jsonPayload.message
string Log of the database action jsonPayload.tid
number Thread ID where the log originated jsonPayload.user
string Authenticated user for the action being logged when relevant severity
string (LogSeverity
) Log entry level (translated). Configure metrics collection
To ingest metrics from PostgreSQL, you must create a receiver for the metrics that PostgreSQL produces and then create a pipeline for the new receiver.
This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.
To configure a receiver for your postgresql
metrics, specify the following fields:
ca_file
Path to the CA certificate. As a client, this verifies the server certificate. If empty, the receiver uses the system root CA. cert_file
Path to the TLS certificate to use for mTLS-required connections. collection_interval
60s
A time duration value, such as 30s
or 5m
. endpoint
/var/run/postgresql/.s.PGSQL.5432
The hostname:port
or Unix socket path starting with /
used to connect to the PostgreSQL server. insecure
true
Sets whether or not to use a secure TLS connection. If set to false
, then TLS is enabled. insecure_skip_verify
false
Sets whether or not to skip verifying the certificate. If insecure
is set to true
, then the insecure_skip_verify
value is not used. key_file
Path to the TLS key to use for mTLS-required connections. password
The password used to connect to the server. type
This value must be postgresql
. username
The username used to connect to the server. What is monitored
The following table provides the list of metrics that the Ops Agent collects from the PostgreSQL instance.
Metric type Kind, Typeworkload.googleapis.com/postgresql.backends
GAUGE
, INT64
database
workload.googleapis.com/postgresql.bgwriter.buffers.allocated
CUMULATIVE
, INT64
workload.googleapis.com/postgresql.bgwriter.buffers.writes
CUMULATIVE
, INT64
source
workload.googleapis.com/postgresql.bgwriter.checkpoint.count
CUMULATIVE
, INT64
type
workload.googleapis.com/postgresql.bgwriter.duration
CUMULATIVE
, INT64
type
workload.googleapis.com/postgresql.bgwriter.maxwritten
CUMULATIVE
, INT64
workload.googleapis.com/postgresql.blocks_read
CUMULATIVE
, INT64
database
source
table
workload.googleapis.com/postgresql.commits
CUMULATIVE
, INT64
database
workload.googleapis.com/postgresql.connection.max
GAUGE
, INT64
workload.googleapis.com/postgresql.database.count
GAUGE
, INT64
workload.googleapis.com/postgresql.db_size
GAUGE
, INT64
database
workload.googleapis.com/postgresql.index.scans
CUMULATIVE
, INT64
database
index
table
workload.googleapis.com/postgresql.index.size
GAUGE
, INT64
database
index
table
workload.googleapis.com/postgresql.operations
CUMULATIVE
, INT64
database
operation
table
workload.googleapis.com/postgresql.replication.data_delay
GAUGE
, INT64
replication_client
workload.googleapis.com/postgresql.rollbacks
CUMULATIVE
, INT64
database
workload.googleapis.com/postgresql.rows
GAUGE
, INT64
database
state
table
workload.googleapis.com/postgresql.table.count
GAUGE
, INT64
database
workload.googleapis.com/postgresql.table.size
GAUGE
, INT64
database
table
workload.googleapis.com/postgresql.table.vacuum.count
CUMULATIVE
, INT64
database
table
workload.googleapis.com/postgresql.wal.age
GAUGE
, INT64
workload.googleapis.com/postgresql.wal.lag
GAUGE
, INT64
operation
replication_client
Verify the configuration
This section describes how to verify that you correctly configured the PostgreSQL receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.
To verify that PostgreSQL logs are being sent to Cloud Logging, do the following:
In the Google Cloud console, go to the Logs Explorer page:
If you use the search bar to find this page, then select the result whose subheading is Logging.
resource.type="gce_instance" log_id("postgresql_general")
To verify that PostgreSQL metrics are being sent to Cloud Monitoring, do the following:
In the Google Cloud console, go to the leaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
{"workload.googleapis.com/postgresql.backends", monitored_resource="gce_instance"}
To view your PostgreSQL metrics, you must have a chart or dashboard configured. The PostgreSQL integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.
You can also view static previews of dashboards without installing the integration.
To view an installed dashboard, do the following:
In the Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.
To view a static preview of the dashboard, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
For more information about dashboards in Cloud Monitoring, see Dashboards and charts.
For more information about using the Integrations page, see Manage integrations.
Install alerting policiesAlerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The PostgreSQL integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.
To view the descriptions of available alerting policies and install them, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.
For more information about notification channels, see Manage notification channels.
For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.
For more information about using the Integrations page, see Manage integrations.
What's nextFor a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4