Commit 5fb6810

committed

feat: Add WAL metrics for Postgres 13+ (#194)

1 parent 43ab0d1 commit 5fb6810Copy full SHA for 5fb6810

File tree

+20

-1

lines changed

+20

-1

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,11 @@ const (`
`33`	`33`	`queryExplain = "EXPLAIN (FORMAT TEXT) "`
`34`	`34`	`queryExplainAnalyze = "EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON %s) "`
`35`	`35`	`settingsExplain = ", SETTINGS TRUE"`
	`36`	`+ walExplain = ", WAL"`
`36`	`37`
`37`	`38`	`postgresNumDiv = 10000 // Divider to get version from server_version_num.`
`38`	`39`	`pgVersion12 = 12 // Explain Settings are available starting with Postgres 12.`
	`40`	`+ pgVersion13 = 13 // Explain WAL are available starting with Postgres 13.`
`39`	`41`
`40`	`42`	`// locksTitle shows locks for a single query analyzed with EXPLAIN.`
`41`	`43`	`// locksTitle = "Query heavy locks:\n".`
`@@ -176,6 +178,10 @@ func analyzePrefix(dbVersionNum int) string {`
`176`	`178`	`settingsValue = settingsExplain`
`177`	`179`	`}`
`178`	`180`
	`181`	`+ if (dbVersionNum / postgresNumDiv) >= pgVersion13 {`
	`182`	`+ settingsValue += walExplain`
	`183`	`+ }`
	`184`	`+`
`179`	`185`	`return fmt.Sprintf(queryExplainAnalyze, settingsValue)`
`180`	`186`	`}`
`181`	`187`

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,13 @@ func TestAnalyzePrefix(t *testing.T) {`
`23`	`23`	`input: 120000,`
`24`	`24`	`expectedOutput: "EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON , SETTINGS TRUE) ",`
`25`	`25`	`},`
	`26`	`+ {`
	`27`	`+ input: 130000,`
	`28`	`+ expectedOutput: "EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON , SETTINGS TRUE, WAL) ",`
	`29`	`+ },`
`26`	`30`	`{`
`27`	`31`	`input: 160000,`
`28`		`- expectedOutput: "EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON , SETTINGS TRUE) ",`
	`32`	`+ expectedOutput: "EXPLAIN (ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON , SETTINGS TRUE, WAL) ",`
`29`	`33`	`},`
`30`	`34`	`}`
`31`	`35`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,11 @@ type Plan struct {`
`113`	`113`	StartupCost float64 `json:"Startup Cost"`
`114`	`114`	TotalCost float64 `json:"Total Cost"`
`115`	`115`
	`116`	`+ // WAL.`
	`117`	+ WALRecords uint64 `json:"WAL Records,omitempty"`
	`118`	+ WALFPI uint64 `json:"WAL FPI,omitempty"`
	`119`	+ WALBytes uint64 `json:"WAL Bytes,omitempty"`
	`120`	`+`
`116`	`121`	`// General.`
`117`	`122`	Alias string `json:"Alias"`
`118`	`123`	CteName string `json:"CTE Name"`
`@@ -606,6 +611,10 @@ func writePlanTextNodeDetails(outputFn func(string, ...interface{}) (int, error)`
`606`	`611`	`outputFn("Buffers: %s", buffers)`
`607`	`612`	`}`
`608`	`613`
	`614`	`+ if plan.WALRecords != 0 \|\| plan.WALFPI != 0 \|\| plan.WALBytes != 0 {`
	`615`	`+ _, _ = outputFn(fmt.Sprintf("WAL: records=%d fpi=%d bytes=%d", plan.WALRecords, plan.WALFPI, plan.WALBytes))`
	`616`	`+ }`
	`617`	`+`
`609`	`618`	`ioTiming := ""`
`610`	`619`	`if plan.IOReadTime != nil {`
`611`	`620`	`ioTiming += fmt.Sprintf(" read=%.3f", *plan.IOReadTime)`

Comments

(0)