Skip to content

Commit

Permalink
Use descriptive constants for Postgres versions.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdevan
mdevan committed Oct 3, 2021
1 parent 1122723 commit b7e167b
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 48 deletions.
36 changes: 24 additions & 12 deletions cmd/pgmetrics/report.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ import (
"github.com/rapidloop/pgmetrics"
)

// Postgres version constants
const (
pgv94 = 9_04_00
pgv95 = 9_05_00
pgv96 = 9_06_00
pgv10 = 10_00_00
pgv11 = 11_00_00
pgv12 = 12_00_00
pgv13 = 13_00_00
pgv14 = 14_00_00
)

func writeHumanTo(fd io.Writer, o options, result *pgmetrics.Model) {
if result.PgBouncer != nil {
pgbouncerWriteHumanTo(fd, o, result)
Expand All @@ -52,7 +64,7 @@ PostgreSQL Cluster:
getSetting(result, "server_version"),
fmtTimeAndSince(result.StartTime),
)
if version >= 90600 {
if version >= pgv96 {
fmt.Fprintf(fd, `
System Identifier: %s
Timeline: %d
Expand Down Expand Up @@ -92,7 +104,7 @@ PostgreSQL Cluster:
)
}

if version >= 90600 {
if version >= pgv96 {
fmt.Fprintf(fd, `
Notification Queue: %.1f%% used`, result.NotificationQueueUsage)
}
Expand Down Expand Up @@ -129,7 +141,7 @@ PostgreSQL Cluster:
reportBGWriter(fd, result)
reportBackends(fd, o.tooLongSec, result)
reportLocks(fd, result)
if version >= 90600 {
if version >= pgv96 {
reportVacuumProgress(fd, result)
}
reportRoles(fd, result)
Expand Down Expand Up @@ -230,7 +242,7 @@ Physical Replication Slots:
`)
var tw tableWriter
cols := []interface{}{"Name", "Active", "Oldest Txn ID", "Restart LSN"}
if version >= 100000 {
if version >= pgv10 {
cols = append(cols, "Temporary")
}
tw.add(cols...)
Expand All @@ -240,7 +252,7 @@ Physical Replication Slots:
}
vals := []interface{}{r.SlotName, fmtYesNo(r.Active),
fmtIntZero(r.Xmin), r.RestartLSN}
if version >= 100000 {
if version >= pgv10 {
vals = append(vals, fmtYesNo(r.Temporary))
}
tw.add(vals...)
Expand All @@ -254,7 +266,7 @@ Logical Replication Slots:
var tw tableWriter
cols := []interface{}{"Name", "Plugin", "Database", "Active",
"Oldest Txn ID", "Restart LSN", "Flushed Until"}
if version >= 100000 {
if version >= pgv10 {
cols = append(cols, "Temporary")
}
tw.add(cols...)
Expand All @@ -265,7 +277,7 @@ Logical Replication Slots:
vals := []interface{}{r.SlotName, r.Plugin, r.DBName,
fmtYesNo(r.Active), fmtIntZero(r.Xmin), r.RestartLSN,
r.ConfirmedFlushLSN}
if version >= 100000 {
if version >= pgv10 {
vals = append(vals, fmtYesNo(r.Temporary))
}
tw.add(vals...)
Expand Down Expand Up @@ -326,7 +338,7 @@ WAL Files:
}
tw1.add("checkpoint_timeout", getSetting(result, "checkpoint_timeout"))
tw1.add("full_page_writes", getSetting(result, "full_page_writes"))
if version >= 130000 {
if version >= pgv13 {
tw1.add("wal_keep_size", getSettingBytes(result, "wal_keep_size", 1024*1024))
} else {
tw1.add("wal_keep_segments", getSetting(result, "wal_keep_segments"))
Expand Down Expand Up @@ -1594,10 +1606,10 @@ func getVersion(result *pgmetrics.Model) int {
}

func getMaxWalSize(result *pgmetrics.Model) (key, val string) {
if version := getVersion(result); version >= 100000 {
if version := getVersion(result); version >= pgv10 {
key = "max_wal_size"
val = getSettingBytes(result, key, 1024*1024)
} else if version >= 90500 {
} else if version >= pgv95 {
key = "max_wal_size"
val = getSettingBytes(result, key, 16*1024*1024)
} else {
Expand All @@ -1608,9 +1620,9 @@ func getMaxWalSize(result *pgmetrics.Model) (key, val string) {
}

func getMinWalSize(result *pgmetrics.Model) (val string) {
if version := getVersion(result); version >= 100000 {
if version := getVersion(result); version >= pgv10 {
val = getSettingBytes(result, "min_wal_size", 1024*1024)
} else if version >= 90500 {
} else if version >= pgv95 {
val = getSettingBytes(result, "min_wal_size", 16*1024*1024)
}
return
Expand Down
84 changes: 48 additions & 36 deletions collector/collect.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ import (
"github.com/rapidloop/pq"
)

// Postgres version constants
const (
pgv94 = 9_04_00
pgv95 = 9_05_00
pgv96 = 9_06_00
pgv10 = 10_00_00
pgv11 = 11_00_00
pgv12 = 12_00_00
pgv13 = 13_00_00
pgv14 = 14_00_00
)

// See https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING
func makeKV(k, v string) string {
var v2 string
Expand Down Expand Up @@ -374,80 +386,80 @@ func (c *collector) collectNext(db *sql.DB, o CollectConfig) {
func (c *collector) collectCluster(o CollectConfig) {
c.getStartTime()

if c.version >= 90600 {
if c.version >= pgv96 {
c.getControlSystemv96()
}

if c.version >= 90500 {
if c.version >= pgv95 {
c.getLastXactv95()
}

if c.version >= 110000 {
if c.version >= pgv11 {
c.getControlCheckpointv11()
} else if c.version >= 100000 {
} else if c.version >= pgv10 {
c.getControlCheckpointv10()
} else if c.version >= 90600 {
} else if c.version >= pgv96 {
c.getControlCheckpointv96()
}

if c.version >= 90600 {
if c.version >= pgv96 {
c.getActivityv96()
} else if c.version >= 90400 {
} else if c.version >= pgv94 {
c.getActivityv94()
} else {
c.getActivityv93()
}

if c.version >= 100000 {
if c.version >= pgv10 {
c.getBETypeCountsv10()
}

if c.version >= 90400 {
if c.version >= pgv94 {
c.getWALArchiver()
}

c.getBGWriter()

if c.version >= 100000 {
if c.version >= pgv10 {
c.getReplicationv10()
} else {
c.getReplicationv9()
}

if c.version >= 130000 {
if c.version >= pgv13 {
c.getWalReceiverv13()
} else if c.version >= 90600 {
} else if c.version >= pgv96 {
c.getWalReceiverv96()
}

if c.version >= 100000 {
if c.version >= pgv10 {
c.getAdminFuncv10()
} else {
c.getAdminFuncv9()
}

if c.version >= 90600 {
if c.version >= pgv96 {
c.getVacuumProgress()
}

c.getDatabases(!o.NoSizes, o.OnlyListedDBs, c.dbnames)
c.getTablespaces(!o.NoSizes)

if c.version >= 90400 {
if c.version >= pgv94 {
c.getReplicationSlotsv94()
}

c.getRoles()

if c.version >= 120000 {
if c.version >= pgv12 {
c.getWALCountsv12()
} else if c.version >= 110000 {
} else if c.version >= pgv11 {
c.getWALCountsv11()
} else {
c.getWALCounts()
}

if c.version >= 90600 {
if c.version >= pgv96 {
c.getNotification()
}

Expand All @@ -464,7 +476,7 @@ func (c *collector) collectDatabase(o CollectConfig) {
if !arrayHas(o.Omit, "tables") {
c.getTables(!o.NoSizes)
// partition information, added schema v1.2
if c.version >= 100000 {
if c.version >= pgv10 {
c.getPartitionInfo()
}
// parent information, added schema v1.2
Expand Down Expand Up @@ -492,7 +504,7 @@ func (c *collector) collectDatabase(o CollectConfig) {
c.getBloat()

// logical replication, added schema v1.2
if c.version >= 100000 {
if c.version >= pgv10 {
c.getPublications()
c.getSubscriptions()
}
Expand Down Expand Up @@ -688,7 +700,7 @@ func (c *collector) getReplicationv10() {
pid
FROM pg_stat_replication
ORDER BY pid ASC`
if c.version >= 120000 {
if c.version >= pgv12 {
// for pg v12+ also collect reply_time
q = strings.Replace(q, "@reply_time@", `COALESCE(EXTRACT(EPOCH FROM reply_time)::bigint, 0)`, 1)
} else {
Expand Down Expand Up @@ -735,7 +747,7 @@ func (c *collector) getReplicationv9() {
pid
FROM pg_stat_replication
ORDER BY pid ASC`
if c.version < 90400 { // backend_xmin is only in v9.4+
if c.version < pgv94 { // backend_xmin is only in v9.4+
q = strings.Replace(q, "backend_xmin", "0", 1)
}
rows, err := c.db.QueryContext(ctx, q)
Expand Down Expand Up @@ -777,7 +789,7 @@ func (c *collector) getWalReceiverv13() {
COALESCE(EXTRACT(EPOCH FROM latest_end_time)::bigint, 0),
COALESCE(slot_name, ''), conninfo, @sender_host@
FROM pg_stat_wal_receiver`
if c.version >= 110000 {
if c.version >= pgv11 {
q = strings.Replace(q, "@sender_host@", `COALESCE(sender_host, '')`, 1)
} else {
q = strings.Replace(q, "@sender_host@", `''`, 1)
Expand Down Expand Up @@ -873,7 +885,7 @@ func (c *collector) getAdminFuncv9() {
}
}
} else {
if c.version >= 90600 && !c.isAWSAurora() { // don't attempt on Aurora
if c.version >= pgv96 && !c.isAWSAurora() { // don't attempt on Aurora
qx := `SELECT pg_current_xlog_flush_location(),
pg_current_xlog_insert_location(), pg_current_xlog_location()`
if err := c.db.QueryRowContext(ctx, qx).Scan(&c.result.WALFlushLSN,
Expand Down Expand Up @@ -1105,7 +1117,7 @@ func (c *collector) getActivityv96() {
COALESCE(state, ''), COALESCE(backend_xid, ''),
COALESCE(backend_xmin, ''), LEFT(COALESCE(query, ''), $1)
FROM pg_stat_activity`
if c.version >= 100000 {
if c.version >= pgv10 {
q += " WHERE backend_type='client backend'"
}
q += " ORDER BY pid ASC"
Expand Down Expand Up @@ -1385,10 +1397,10 @@ func (c *collector) getTables(fillSize bool) {
JOIN pg_class AS C
ON C.oid = S.relid
ORDER BY S.relid ASC`
if c.version < 90400 { // n_mod_since_analyze only in v9.4+
if c.version < pgv94 { // n_mod_since_analyze only in v9.4+
q = strings.Replace(q, "S.n_mod_since_analyze", "0", 1)
}
if c.version < 100000 { // relispartition only in v10+
if c.version < pgv10 { // relispartition only in v10+
q = strings.Replace(q, "C.relispartition", "false", 1)
}
rows, err := c.db.QueryContext(ctx, q)
Expand Down Expand Up @@ -1659,7 +1671,7 @@ func (c *collector) getRoles() {
WHERE M.member = R.oid)
FROM pg_roles AS R
ORDER BY R.oid ASC`
if c.version < 90500 { // RLS is only available in v9.5+
if c.version < pgv95 { // RLS is only available in v9.5+
q = strings.Replace(q, "R.rolbypassrls", "FALSE", 1)
}
rows, err := c.db.QueryContext(ctx, q)
Expand Down Expand Up @@ -1696,10 +1708,10 @@ func (c *collector) getReplicationSlotsv94() {
restart_lsn, confirmed_flush_lsn, temporary
FROM pg_replication_slots
ORDER BY slot_name ASC`
if c.version < 90600 { // confirmed_flush_lsn only in v9.6+
if c.version < pgv96 { // confirmed_flush_lsn only in v9.6+
q = strings.Replace(q, "confirmed_flush_lsn", "''", 1)
}
if c.version < 100000 { // temporary only in v10+
if c.version < pgv10 { // temporary only in v10+
q = strings.Replace(q, "temporary", "FALSE", 1)
}
rows, err := c.db.QueryContext(ctx, q)
Expand Down Expand Up @@ -1782,7 +1794,7 @@ func (c *collector) getStatements(currdb string) {
return
}

if c.version >= 130000 {
if c.version >= pgv13 {
c.getStatementsv13(currdb)
} else {
c.getStatementsPrev13(currdb)
Expand Down Expand Up @@ -1909,7 +1921,7 @@ func (c *collector) getStatementsPrev13(currdb string) {

func (c *collector) getWALSegmentSize() (out int) {
out = 16 * 1024 * 1024 // default to 16MB
if c.version >= 110000 {
if c.version >= pgv11 {
if v, err := strconv.Atoi(c.setting("wal_segment_size")); err == nil {
out = v
}
Expand Down Expand Up @@ -1975,7 +1987,7 @@ func (c *collector) getWALCounts() {

q1 := `SELECT pg_ls_dir FROM pg_ls_dir('pg_xlog') WHERE pg_ls_dir ~ '^[0-9A-F]{24}$'`
q2 := `SELECT COUNT(*) FROM pg_ls_dir('pg_xlog/archive_status') WHERE pg_ls_dir ~ '^[0-9A-F]{24}.ready$'`
if c.version >= 100000 {
if c.version >= pgv10 {
q1 = strings.Replace(q1, "pg_xlog", "pg_wal", -1)
q2 = strings.Replace(q2, "pg_xlog", "pg_wal", -1)
}
Expand Down Expand Up @@ -2044,7 +2056,7 @@ func (c *collector) getNotification() {

func (c *collector) getLocks() {
c.getLockRows()
if c.version >= 90600 {
if c.version >= pgv96 {
c.getBlockers96()
} else {
c.getBlockers()
Expand Down Expand Up @@ -2257,7 +2269,7 @@ func (c *collector) getParentInfo() {

q := `SELECT c.oid, i.inhparent::regclass
FROM pg_class c JOIN pg_inherits i ON c.oid=i.inhrelid`
if c.version >= 100000 { // exclude partition children in v10+
if c.version >= pgv10 { // exclude partition children in v10+
q += ` WHERE NOT c.relispartition`
}
rows, err := c.db.QueryContext(ctx, q)
Expand Down Expand Up @@ -2615,7 +2627,7 @@ func (c *collector) getLogInfo() {
c.setting("logging_collector") == "on"

// pg_current_logfile is only available in v10 and above
if c.version < 100000 {
if c.version < pgv10 {
return
}

Expand Down

0 comments on commit b7e167b

Please sign in to comment.