README
¶
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, and BASE_BACKUP. See Progress Reporting for more information.
Requires
go 1.16 or later
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'
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%
Monitors PostgreSQL's pg_stat_progress_*.
Usage:
pgsp [flags]
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
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var AnalyzeColumns = []string{
"pid",
"datid",
"datname",
"relid",
"phase",
"sample_blks_total",
"sample_blks_scanned",
"ext_stats_total",
"ext_stats_computed",
"child_tables_total",
"child_tables_done",
"current_child_table_relid",
}
View Source
var AnalyzeTableName = "pg_stat_progress_analyze"
View Source
var BaseBackupColumns = []string{
"pid",
"phase",
"backup_total",
"backup_streamed",
"tablespaces_total",
"tablespaces_streamed",
}
View Source
var BaseBackupTableName = "pg_stat_progress_basebackup"
View Source
var ClusterColumns = []string{
"pid",
"datid",
"datname",
"relid",
"command",
"phase",
"cluster_index_relid",
"heap_tuples_scanned",
"heap_tuples_written",
"heap_blks_total",
"heap_blks_scanned",
"index_rebuild_count",
}
View Source
var ClusterTableName = "pg_stat_progress_cluster"
View Source
var CreateIndexColumns = []string{
"pid",
"datid",
"datname",
"relid",
"index_relid",
"command",
"phase",
"lockers_total",
"lockers_done",
"current_locker_pid",
"blocks_total",
"blocks_done",
"tuples_total",
"tuples_done",
"partitions_total",
"partitions_done",
}
View Source
var CreateIndexTableName = "pg_stat_progress_create_index"
View Source
var VacuumColumns = []string{
"pid",
"datid",
"datname",
"relid",
"phase",
"heap_blks_total",
"heap_blks_scanned",
"heap_blks_vacuumed",
"index_vacuum_count",
"max_dead_tuples",
"num_dead_tuples",
}
Functions ¶
func DisConnect ¶
Types ¶
type Analyze ¶
type Analyze struct {
PID int `db:"pid"`
DATID int `db:"datid"`
DATNAME string `db:"datname"`
RELID int `db:"relid"`
PHASE string `db:"phase"`
SampleBLKSTotal int64 `db:"sample_blks_total"`
SampleBLKSScanned int64 `db:"sample_blks_scanned"`
ExtStatsTotal int64 `db:"ext_stats_total"`
ExtStatsComputed int64 `db:"ext_stats_computed"`
ChildTablesTotal int64 `db:"child_tables_total"`
ChildTablesDone int64 `db:"child_tables_done"`
CurrentChildTableRelid int `db:"current_child_table_relid"`
}
pg_stat_progress_analyze
type BaseBackup ¶
type BaseBackup struct {
PID int `db:"pid"`
PHASE string `db:"phase"`
BackupTotal int64 `db:"backup_total"`
BackupStreamed int64 `db:"backup_streamed"`
TablespacesTotal int64 `db:"tablespaces_total"`
TablespacesStreamed int64 `db:"tablespaces_streamed"`
}
pg_stat_progress_basebackup
func GetBaseBackup ¶
func GetBaseBackup(db *sql.DB) ([]BaseBackup, error)
func (BaseBackup) Name ¶
func (v BaseBackup) Name() string
func (BaseBackup) Pid ¶
func (v BaseBackup) Pid() int
func (BaseBackup) Progress ¶
func (v BaseBackup) Progress() float64
func (BaseBackup) String ¶
func (v BaseBackup) String() []string
func (BaseBackup) Table ¶
func (v BaseBackup) Table() string
func (BaseBackup) Vertical ¶
func (v BaseBackup) Vertical() string
type Cluster ¶
type Cluster struct {
PID int `db:"pid"`
DATID int `db:"datid"`
DATNAME string `db:"datname"`
RELID int `db:"relid"`
Command string `db:"command"`
PHASE string `db:"phase"`
ClusterIndexRelid int64 `db:"cluster_index_relid"`
HeapTuplesScanned int64 `db:"heap_tuples_scanned"`
HeapTuplesWritten int64 `db:"heap_tuples_written"`
HeapBlksTotal int64 `db:"heap_blks_total"`
HeapBlksScanned int64 `db:"heap_blks_scanned"`
IndexRebuildCount int64 `db:"index_rebuild_count"`
}
pg_stat_progress_Cluster
type CreateIndex ¶
type CreateIndex struct {
PID int `db:"pid"`
DATID int `db:"datid"`
DATNAME string `db:"datname"`
RELID int `db:"relid"`
IndexRelid int `db:"index_relid"`
Command string `db:"command"`
PHASE string `db:"phase"`
LockersTotal int64 `db:"lockers_total"`
LockersDone int64 `db:"lockers_done"`
LockersPid int `db:"current_locker_pid"`
BlocksTotal int64 `db:"blocks_total"`
BlocksDone int64 `db:"blocks_done"`
TuplesTotal int64 `db:"tuples_total"`
TuplesDone int64 `db:"tuples_done"`
PartitionsTotal int64 `db:"partitions_total"`
PartitionsDone int64 `db:"partitions__done"`
}
pg_stat_progress_create_index
func GetCreateIndex ¶
func GetCreateIndex(db *sql.DB) ([]CreateIndex, error)
func (CreateIndex) Name ¶
func (v CreateIndex) Name() string
func (CreateIndex) Pid ¶
func (v CreateIndex) Pid() int
func (CreateIndex) Progress ¶
func (v CreateIndex) Progress() float64
func (CreateIndex) String ¶
func (v CreateIndex) String() []string
func (CreateIndex) Table ¶
func (v CreateIndex) Table() string
func (CreateIndex) Vertical ¶
func (v CreateIndex) Vertical() string
type PGSProgress ¶
type Vacuum ¶
type Vacuum struct {
PID int `db:"pid"`
DATID int `db:"datid"`
DATNAME string `db:"datname"`
RELID int `db:"relid"`
PHASE string `db:"phase"`
HeapBLKSTotal int64 `db:"heap_blks_total"`
HeapBLKSScanned int64 `db:"heap_blks_scanned"`
HeapBLKSVacuumed int64 `db:"heap_blks_vacuumed"`
IndexVacuumCount int64 `db:"index_vacuum_count"`
MaxDeadTuples int64 `db:"max_dead_tuples"`
NumDeadTuples int64 `db:"num_dead_tuples"`
}
pg_stat_progress_vacuum
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.