comments addressed: fix in rules for field names and formatted. errors thrown when report directory cannot be made

Author: encima

internal/inspect/db_stats/db_stats.go

@@ -18,6 +18,7 @@ import (
 var DBStatsQuery string
 
 type Result struct {
+	Name                   string
 	Database_size          string
 	Total_index_size       string
 	Total_table_size       string
@@ -43,9 +44,9 @@ func Run(ctx context.Context, config pgconn.Config, fsys afero.Fs, options ...fu
 		return err
 	}
 
-	table := "|Database Size|Total Index Size|Total Table Size|Total Toast Size|Time Since Stats Reset|Index Hit Rate|Table Hit Rate|WAL Size|\n|-|-|-|-|-|-|-|-|\n"
+	table := "|Name|Database Size|Total Index Size|Total Table Size|Total Toast Size|Time Since Stats Reset|Index Hit Rate|Table Hit Rate|WAL Size|\n|-|-|-|-|-|-|-|-|\n"
 	for _, r := range result {
-		table += fmt.Sprintf("|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|\n", r.Database_size, r.Total_index_size, r.Total_table_size, r.Total_toast_size, r.Time_since_stats_reset, r.Index_hit_rate, r.Table_hit_rate, r.WAL_size)
+		table += fmt.Sprintf("|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|`%s`|\n", r.Name, r.Database_size, r.Total_index_size, r.Total_table_size, r.Total_toast_size, r.Time_since_stats_reset, r.Index_hit_rate, r.Table_hit_rate, r.WAL_size)
 	}
 	return list.RenderTable(table)
 }

internal/inspect/db_stats/db_stats.sql

@@ -1,4 +1,5 @@
 SELECT
+  'postgres' AS name,
   pg_size_pretty(pg_database_size('postgres'))                                                                            AS database_size,
   (SELECT pg_size_pretty(SUM(pg_relation_size(c.oid)))
    FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace WHERE c.relkind = 'i')                                         AS total_index_size,

internal/inspect/report.go

@@ -26,7 +26,6 @@ func Report(ctx context.Context, out string, config pgconn.Config, fsys afero.Fs
 	if err := utils.MkdirIfNotExistFS(fsys, out); err != nil {
 		return err
 	}
-	// create a date-based subdirectory
 	dateDir := filepath.Join(out, date)
 	if err := utils.MkdirIfNotExistFS(fsys, dateDir); err != nil {
 		return err
@@ -56,7 +55,10 @@ func Report(ctx context.Context, out string, config pgconn.Config, fsys afero.Fs
 	}
 	// print the actual save location
 	if !filepath.IsAbs(dateDir) {
-		dateDir, _ = filepath.Abs(dateDir)
+		dateDir, err = filepath.Abs(dateDir)
+		if err != nil {
+			return err
+		}
 	}
 	fmt.Fprintln(os.Stderr, "Reports saved to "+utils.Bold(dateDir))
 	return nil

internal/inspect/total_table_sizes/total_table_sizes.sql

@@ -1,5 +1,5 @@
 SELECT
-  n.nspname || '.' || c.relname AS name,
+  FORMAT('%I.%I', n.nspname, c.relname) AS name,
   pg_size_pretty(pg_total_relation_size(c.oid)) AS size
 FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)

internal/inspect/unused_indexes/unused_indexes.sql

@@ -1,5 +1,5 @@
 SELECT
-  schemaname || '.' || relname AS name,
+  FORMAT('%I.%I', schemaname, relname) AS name,
   indexrelname AS index,
   pg_size_pretty(pg_relation_size(i.indexrelid)) AS index_size,
   idx_scan as index_scans

internal/inspect/vacuum_stats/vacuum_stats.sql

@@ -20,7 +20,7 @@ WITH table_opts AS (
     table_opts
 )
 SELECT
-  vacuum_settings.nspname || '.' || vacuum_settings.relname AS name,
+  FORMAT('%I.%I', vacuum_settings.nspname, vacuum_settings.relname) AS name,
   coalesce(to_char(psut.last_vacuum, 'YYYY-MM-DD HH24:MI'), '') AS last_vacuum,
   coalesce(to_char(psut.last_autovacuum, 'YYYY-MM-DD HH24:MI'), '') AS last_autovacuum,
   to_char(pg_class.reltuples, '9G999G999G999') AS rowcount,

tools/inspect_rules.toml

@@ -2,37 +2,34 @@
 
 [[rule]]
 query = "SELECT LISTAGG(stmt, ',') AS match FROM `locks.csv` WHERE age > '00:02:00'"
-name      = "No old locks"
-pass     = "✔"
-fail     = "There is at least one lock older than 2 minutes"
+name = "No old locks"
+pass = "✔"
+fail = "There is at least one lock older than 2 minutes"
 
 [[rule]]
 query = "SELECT LISTAGG(stmt, ',') AS match FROM `locks.csv` WHERE granted = 'f'"
-name      = "No ungranted locks"
-pass     = "✔"
-fail     = "There is at least one ungranted lock"
-
+name = "No ungranted locks"
+pass = "✔"
+fail = "There is at least one ungranted lock"
 
 [[rule]]
 query = "SELECT LISTAGG(index, ',') AS match FROM `unused_indexes.csv`"
-pass          = "✔"
-fail          = "There is at least one unused index"
-name          = "No unused indexes"
-
+pass = "✔"
+fail = "There is at least one unused index"
+name = "No unused indexes"
 
 [[rule]]
-name      = "Check cache hit is within acceptable bounds"
+name = "Check cache hit is within acceptable bounds"
 query = "SELECT LISTAGG(name, ',') AS match FROM `db_stats.csv` WHERE index_hit_rate < 0.94 OR table_hit_rate < 0.94"
-pass     = "✔"
-fail     = "There is at least one table with a cache hit ratio below 94%"
+pass = "✔"
+fail = "There is a cache hit ratio (table or index) below 94%"
 
 [[rule]]
-query = "SELECT LISTAGG(s.name, ',') AS match FROM `seq_scans.csv` s  JOIN `table_record_counts.csv` t ON s.name = t.name WHERE t.estimated_count > 1000 AND s.seq_scans > t.estimated_count * 0.1;"
+query = "SELECT LISTAGG(t.name, ',') AS match FROM `table_stats.csv` t WHERE t.seq_scans > t.estimated_row_count * 0.1 AND t.estimated_row_count > 1000;"
 name = "No large tables with sequential scans more than 10% of rows"
 pass = "✔"
 fail = "At least one table is showing sequential scans more than 10% of total row count"
 
-
 [[rule]]
 query = "SELECT LISTAGG(s.tbl, ',') AS match FROM `vacuum_stats.csv` s WHERE s.expect_autovacuum = 'yes' and s.rowcount > 1000;"
 name = "No large tables waiting on autovacuum"