.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH PGSTAT "1" "January 2022" "pgstat 1.2.0" "User Commands"
.SH NAME
pgstat \- Gather statistical informations from PostgreSQL the vmstat way
.SH DESCRIPTION
pgstat gathers statistics from a PostgreSQL database.
.SS "Usage:"
.IP
pgstat [OPTIONS] [delay [count]]
.SS "General options:"
.TP
\fB\-f\fR FILTER
include only this object
(only works for database, table, tableio,
.TP
index, function, statement statistics,
replication slots, and slru)
.TP
\fB\-H\fR
display human\-readable values
.TP
\fB\-n\fR
do not redisplay header
.TP
\fB\-s\fR STAT
stats to collect
.TP
\fB\-v\fR
verbose
.TP
\-?|\-\-help
show this help, then exit
.TP
\fB\-V\fR|\-\-version
output version information, then exit
.SS "Connection options:"
.TP
\fB\-h\fR HOSTNAME
database server host or socket directory
.TP
\fB\-p\fR PORT
database server port number
.TP
\fB\-U\fR USER
connect as specified database user
.TP
\fB\-d\fR DBNAME
database to connect to
.PP
The default stat is pg_stat_bgwriter, but you can change it with
the \fB\-s\fR command line option, and one of its value (STAT):
.TP
* archiver
for pg_stat_archiver (only for 9.4+)
.TP
* bgwriter
for pg_stat_bgwriter
.TP
* buffercache
for pg_buffercache (needs the extension)
.TP
* connection
(only for 9.2+)
.TP
* database
for pg_stat_database
.TP
* table
for pg_stat_all_tables
.TP
* tableio
for pg_statio_all_tables
.TP
* index
for pg_stat_all_indexes
.TP
* function
for pg_stat_user_function
.TP
* statement
for pg_stat_statements (needs the extension)
.TP
* slru
for pg_stat_slru (only for 13+)
.TP
* xlog
for xlog writes (only for 9.2+)
.TP
* repslots
for replication slots
.TP
* tempfile
for temporary file usage
.TP
* waitevent
for wait events usage
.TP
* wal
for pg_stat_wal (only for 14+)
.TP
* progress_analyze
for analyze progress monitoring (only for
13+)
.TP
* progress_basebackup
for base backup progress monitoring (only
for 13+)
.TP
* progress_cluster
for cluster progress monitoring (only for
12+)
.TP
* progress_copy
for copy progress monitoring (only for
14+)
.TP
* progress_createindex for create index progress monitoring (only
for 12+)
.TP
* progress_vacuum
for vacuum progress monitoring (only for
9.6+)
.TP
* pbpools
for pgBouncer pools statistics
.TP
* pbstats
for pgBouncer statistics
.SH "REPORTING BUGS"
Report bugs to <guillaume@lelarge.info>.