pgsp - PostgreSQL Stat Progress CLI Monitor

A CUI tool that monitors PostgreSQL's pg_stat_progress*.

Supported progress reports are ANALYZE, CLUSTER, CREATE INDEX, VACUUM, COPY, and BASE_BACKUP. See Progress Reporting for more information.

Requires

go 1.18 or later

Install

Download binary

releases page.

Go install

go install github.com/noborus/pgsp/cmd/pgsp@latest

Usage

Shows a progress bar if pg_stat_progress* is updated while waiting while running.

$ pgsp --dsn 'host=/var/run/postgresql port=5432'
Using config file: /home/noborus/.pgsp.yaml
quit: q, ctrl+c, esc
pg_stat_progress_basebackup
 pid                  | 402006
 phase                | streaming database files
 backup_total         | 10976660480
 backup_streamed      | 6093522944
 tablespaces_total    | 1
 tablespaces_streamed | 0

█████████████████████████░░░░░░░░░░░░░░░░░░  56%

It is also possible to specify one of the analyze, basebackup, cluster, createindex, vacuums, copy for monitoring.

pgsp basebackup

Monitors PostgreSQL's pg_stat_progress_*.

Usage:
  pgsp [flags]
  pgsp [command]

Available Commands:
  analyze     analyze
  basebackup  basebackup
  cluster     cluster
  copy        copy
  createindex createindex
  help        Help about any command
  vacuum      vacuum

Flags:
  -a, --AfterCompletion int   Time to display after completion(Seconds) (default 10)
  -i, --Interval float        Update interval(Seconds) (default 0.5)
      --config string         config file (default is $HOME/.pgsp.yaml)
      --dsn string            PostgreSQL data source name
  -f, --fullscreen            Display in Full Screen
  -h, --help                  help for pgsp
  -t, --toggle                Help message for toggle
  -v, --version               display version information

Use "pgsp [command] --help" for more information about a command.