THE HEADER¶

The first line of the header displays PostgreSQL's version, the host name, the connection string, the refresh rate and the duration mode.

The header is then divided in tree groups: instance, worker processes, system. The information is filtered according to the filter parameters when appropriate. This is shown in the following descriptions with the "(filtered)" mention. Depending on the version you are on, some information might not be available. In that case, it will be replaced by a dash.

The instance group displays information aubout the PostgreSQL instance (or cluster). This group can be displayed or hidden with the I Key.

Global :

- uptime: since when is the instance running;

- dbs size: total size of the databases (filtered);

- growth: growth in B/s of the databases (filtered);

- cache hit ratio: the percentage of page read from the PostgreSQL's cache since last snapshot (filtered).

Sessions :

- total: session count (filtered) / max_connections;

- active: number of active sessions (filtered);

- idle: number of idle sessions (filtered);

- idle in txn: number of sessions who are in the idle in transaction state (filtered);

- idle in txn abrt: number of sessions who are in the idle in transaction aborted state (filtered);

- waiting: number of sessions that are waiting for a lock (filtered).

Activity :

- tps: transaction per second (sum of commit & rollback for all databases / time elapsed since last snapshot) (filtered);

- insert/s: number of inserts per second (filtered);

- updates/s: number of updates per second (filtered);

- delete/s: number of deletes per second (filtered);

- tuples returned/s: number of tuples returned per second (filtered);

- temp files: number of temporary files created on the instance;

- temp size: total temporary file size on the instance.

The worker processes group displays information about backgroup workers, autovacuum processes, wal senders and wal receivers. It also gives information about replication slots. Except for the autovacuum workers count, most of this information is not related to a specific database, therefore their values will be zero when the data is filtered.

Worker processes:

- total: total worker count / maximum number of worker slots, parallel workers and logical replication wokers are taken from this amount (filtered);

- logical wokers: logical replication worker count / maximum number of logical replication wokers (filtered);

- parallel workers: parallel worker count for maintenance & queries / maximum number of parallel workers (filtered).

Other processes & information:

- autovacuum workers: number of autovacuum worker in action / maximum number of autovacuum workers (filtered);

- wal senders: number of wal senders / maximum number of wal senders processes (filtered);

- wal receivers: number of wal receivers / maximum number of wal receiver processes (filtered);

- repl. slots: number of replication slots / maximum number of replication slots (filtered).

The last group displays system information:

- Mem.: total / free / used and buff+cached memory with the related percentages;

- Swap: total / free / used swap;

- IO: the number of IO per second, current Read and Write thoughput (aggregated data gathered with the psutil library);

- Load: CPU load for the last 1, 5, 15 minutes;

THE RUNNING QUERIES PANEL¶

The running queries panel shows all running queries, transactions or backends (depending on the DURATION_MODE setting) which have lasted for more than min duration seconds. It displays the following information:

- PID: process id of the backend which executes the query;

- DATABASE: database specified in the connection string;

- APP: application name specified in the connection string;

- USER: user name specified in the connection string;

- CLIENT: client address or "local" in case of linux socker connection;

- CPU%: percentage of CPU used by the backend as reported by the psutil library;

- MEM%: percentage of memory used by the backend as reported by the psutil library;

- READ/s: read thruput as reported by the psutil library;

- WRITE/s: write thruput as reported by the psutil library;

- TIME: time since the beginning of the query / transaction / backend start depending on the DURATION_MODE currently in use;

- Waiting: for PostgreSQL 9.6+: a specific wait event or nothing. Otherwise, a boolean indicating if we are waiting for a Lock;

- IOW: boolean indicating that the process is waiting for IO as reported by the psutil library;

- state: state of the backend;

- Query: the query.

THE WAITING QUERIES PANEL¶

The waiting queries view displays queries that are waiting for a lock. It shows the following information:

- PID: process id of the backend which executes the query;

- DATABASE: database specified in the connection string;

- APP: application name specified in the connection string;

- USER: user name specified in the connection string;

- CLIENT: client address or "local" in case of linux socker connection;

- RELATION: the name of the relation being locked if applicable;

- TYPE: the type of lock;

- MODE: the mode of the lock;

- TIME+: the duration of the query, transaction or session depending on the DURATION_MODE setting;

- state: the state of the transaction;

- Query: the query.

THE BLOCKING QUERIES PANEL¶

The blocking queries view displays the queries that lock an object which is required by another session. It shows following information:

- PID: process id of the backend which executes the query;

- DATABASE: database specified in the connection string;

- APP: application name specified in the connection string;

- USER: user name specified in the connection string;

- CLIENT: client address or "local" in case of linux socker connection;

- RELATION: the name of the relation being locked if applicable;

- TYPE: the type of lock;

- MODE: the mode of the lock;

- TIME+: the duration of the query, transaction or session depending on the DURATION_MODE setting;

- Waiting: for PostgreSQL 9.6+: a specific wait event or nothing. Otherwise, a boolean indicating if we are waiting for a Lock;

- state: the state of the transaction;

- Query: the query.

OPTIONS¶

--blocksize=BLOCKSIZE

        Filesystem blocksize (default: 4096).
    

--rds

        Enable support for AWS RDS (implies --no-tempfiles and filters out the rdsadmin database from space calculation).
    

--output=FILEPATH

        Store running queries as CSV.
    

--no-db-size

        Skip total size of DB.
    

--no-tempfiles

        Skip tempfile count and size.
    

--no-walreceiver

        Skip walreceiver checks.
    

--no-walreceiver

        Skip walreceiver checks.
    

-w, --wrap-query

        Wrap query column instead of truncating.
    

--min-duration=SECONDS

        Don't display queries with smaller than specified duration (in seconds).
    

--filter=FIELD:REGEX

        Filter activities with a (case insensitive) regular expression applied on selected fields. Known fields are: dbname.
        
        Note: It's possible to filter out a database with negative lookahead, eg: '^(?!database_name)'
    

--help

        Show this help message and exit.
    

--version

        Show program's version number and exit.
    

CONNECTION OPTIONS¶

-U USERNAME, --username=USERNAME

        Database user name.
    

-p PORT, --port=PORT

        Database server port.
    

-h HOSTNAME, --host=HOSTNAME

        Database server host or socket directory.
    

-d DBNAME, --dbname=DBNAME

    Database name to connect to.
    

PROCESS DISPLAY OPTIONS¶

--no-pid

        Disable PID.
    

--no-database

        Disable DATABASE.
    

--no-user

        Disable USER.
    

--no-client

        Disable CLIENT.
    

--no-cpu

        Disable CPU%.
    

--no-mem

        Disable MEM%.
    

--no-read

        Disable READ/s.
    

--no-write

        Disable WRITE/s.
    

--no-time

        Disable TIME+.
    

--no-wait

        Disable W.
    

--no-app-name

        Disable App.
    

OTHER DISPLAY OPTIONS¶

--no-inst-info

        Display instance information in header.
    

--no-sys-info

        Display system information in header.
    

--no-proc-info

        Display workers process information in header.
    

--refresh

        Change the refresh rate, allowed values are: 0.5, 1, 2, 3, 4, 5 (in seconds) (default: 2).