PostgreSQL is a powerful, open source object-relational database system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads.
This integration will monitor your PostgreSQL database by collecting metrics from PostgreSQL internal statistics views.
Once enabled you will get a default PostgreSQL dashboard to help you get started monitoring your key PostgreSQL metrics.
| Metric Name | Type | Labels | Unit | Description |
|---|---|---|---|---|
| postgres.connections | Gauge | connection | Number of active connections. | |
| postgres.sessions.active | Gauge | session | Number of active sessions. | |
| postgres.sessions.idle | Gauge | session | Number of idle sessions. | |
| postgres.sessions.idle_in_transaction | Gauge | session | Number of idle sessions in transaction. | |
| postgres.sessions.waiting | Gauge | session | Number of waiting sessions. | |
| postgres.sessions.longest_transaction | Gauge | uom | second | Longest transaction in seconds. |
| postgres.sessions.longest_query | Gauge | uom | second | Longest query in seconds. |
| postgres.locks.accessexclusive | Gauge | lock | Number of locks in AccessExclusiveLock mode. |
|
| postgres.locks.otherexclusive | Gauge | lock | Number of exclusive locks different than AccessExclusiveLock. |
|
| postgres.locks.shared | Gauge | lock | Number of locks in Share mode. |
|
| postgres.bgwriter.checkpoints_timed | Counter | checkpoint | Rate of scheduled checkpoints that have been performed. | |
| postgres.bgwriter.checkpoints_req | Counter | checkpoint | Rate of requested checkpoints that have been performed. | |
| postgres.bgwriter.checkpoint_write_time | Counter | millisecond | Rate of time that has been spent in the portion of checkpoint processing where files are written to disk. | |
| postgres.bgwriter.checkpoint_sync_time | Counter | millisecond | Rate of time that has been spent in the portion of checkpoint processing where files are synchronized to disk. | |
| postgres.bgwriter.buffers_checkpoint | Counter | buffer | Rate of buffers written during checkpoints. | |
| postgres.bgwriter.buffers_clean | Counter | buffer | Rate of buffers written by the background writer. | |
| postgres.bgwriter.buffers_backend | Counter | buffer | Rate of buffers written directly by a backend. | |
| postgres.bgwriter.buffers_alloc | Counter | buffer | Rate of buffers allocated. | |
| postgres.database.commits | Counter | database | commit | Rate of transactions in this database that have been committed. |
| postgres.database.rollbacks | Counter | database | rollback | Rate of transactions in this database that have been rolled back. |
| postgres.database.rows_inserted | Counter | database | row | Rate of rows inserted by queries in this database. |
| postgres.database.rows_updated | Counter | database | row | Rate of rows updated by queries in this database. |
| postgres.database.rows_deleted | Counter | database | row | Rate of rows deleted by queries in this database. |
| postgres.database.rows_returned | Counter | database | row | Rate of rows returned by queries in this database. |
| postgres.database.rows_fetched | Counter | database | row | Rate of rows fetched by queries in this database. |
| postgres.database.blocks_read | Counter | database | block | Rate of disk blocks read in this database. |
| postgres.database.blocks_hit | Counter | database | hit | Rate of times disk blocks were found already in the buffer cache, so that a read was not necessary. |
| postgres.database.temp_files | Counter | database | file | Rate of temporary files created by queries in this database. |
| postgres.database.temp_bytes | Counter | database | byte | Rate of data written to temporary files by queries in this database. |
| postgres.database.deadlocks | Counter | database | deadlock | Rate of deadlocks detected in this database. |
| postgres.database.block_read_time | Counter | database | millisecond | Rate of time spent reading data file blocks by backends in this database. |
| postgres.database.block_write_time | Counter | database | millisecond | Rate of spent writing data file blocks by backends in this database. |
This plugin runs queries to collect metrics from PostgreSQL, so you need to provide a valid user with appropriate privileges.
To create a specific user for collecting metrics, log into a psql session as a user who has CREATEROLE privileges, for example:
$ sudo -u postgres psql
Create a user and grant the appropriate privileges:
create user outlyer with password 'your_password';
grant SELECT ON pg_stat_database to outlyer;
Then configure the username and password plugin environment variables to match and run the PostgreSQL plugin against your PostgreSQL instance to start collecting metrics.
Plugin Environment Variables
The PostgreSQL plugin can be customized via environment variables.
| Variable | Default | Description |
|---|---|---|
| port | 5432 | PostgreSQL port. |
| dbname | postgres | PostgreSQL database name. |
| username | PostgreSQL username (required). | |
| password | PostgreSQL password (required). |
| Version | Release Date | Description |
|---|---|---|
| 1.0.1 | 20-Nov-2018 | Plugin fix: get host from the ip env var instead of host. |
| 1.0 | 19-Jun-2018 | Initial version of our PostgreSQL monitoring integration. |