-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathpostgres_reports.py
More file actions
5322 lines (4529 loc) · 243 KB
/
postgres_reports.py
File metadata and controls
5322 lines (4529 loc) · 243 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
"""
PostgreSQL Reports Generator using PromQL
This script generates JSON reports containing Observations for specific PostgreSQL
check types (A002, A003, A004, A007, D004, F001, F004, F005, H001, H002, H004,
I001, K001, K003, K004, K005, K006, K007, K008, M001, M002, M003, N001) by querying
Prometheus metrics using PromQL.
IMPORTANT: Scope of this module
-------------------------------
This module ONLY generates JSON reports with raw Observations (data collected
from Prometheus/PostgreSQL). The following are explicitly OUT OF SCOPE:
- Converting JSON reports to other formats (Markdown, HTML, PDF, etc.)
- Generating Conclusions based on Observations
- Generating Recommendations based on Conclusions
- Any report rendering or presentation logic
These responsibilities are handled by separate components in the system.
The JSON output from this module serves as input for downstream processing.
"""
__version__ = "1.0.2"
import requests
import json
import time
import re
import gc
from datetime import datetime, timedelta, timezone
from typing import Dict, List, Any, Optional, Tuple, Sequence
import argparse
import sys
import os
from pathlib import Path
try:
import psycopg2
import psycopg2.extras
except ImportError: # pragma: no cover
psycopg2 = None
import boto3
from requests_aws4auth import AWS4Auth
from reporter.logger import logger
try:
from monitoring_flask_backend.promql_utils import escape_promql_label as _promql_escape_label
except ImportError: # pragma: no cover
def _promql_escape_label(value: str) -> str: # type: ignore[misc]
"""Inline fallback when monitoring_flask_backend is not installed."""
return value.replace("\\", "\\\\").replace('"', '\\"').replace("\n", "\\n")
class PostgresReportGenerator:
# Default databases to always exclude
DEFAULT_EXCLUDED_DATABASES = {'template0', 'template1', 'rdsadmin', 'azure_maintenance', 'cloudsqladmin'}
# Settings filter lists for reports based on A003
D004_SETTINGS = [
'pg_stat_statements.max',
'pg_stat_statements.track',
'pg_stat_statements.track_utility',
'pg_stat_statements.save',
'pg_stat_statements.track_planning',
'shared_preload_libraries',
'track_activities',
'track_counts',
'track_functions',
'track_io_timing',
'track_wal_io_timing'
]
F001_SETTINGS = [
'autovacuum',
'autovacuum_analyze_scale_factor',
'autovacuum_analyze_threshold',
'autovacuum_freeze_max_age',
'autovacuum_max_workers',
'autovacuum_multixact_freeze_max_age',
'autovacuum_naptime',
'autovacuum_vacuum_cost_delay',
'autovacuum_vacuum_cost_limit',
'autovacuum_vacuum_insert_scale_factor',
'autovacuum_vacuum_scale_factor',
'autovacuum_vacuum_threshold',
'autovacuum_work_mem',
'vacuum_cost_delay',
'vacuum_cost_limit',
'vacuum_cost_page_dirty',
'vacuum_cost_page_hit',
'vacuum_cost_page_miss',
'vacuum_freeze_min_age',
'vacuum_freeze_table_age',
'vacuum_multixact_freeze_min_age',
'vacuum_multixact_freeze_table_age'
]
G001_SETTINGS = [
'shared_buffers',
'work_mem',
'maintenance_work_mem',
'effective_cache_size',
'autovacuum_work_mem',
'max_wal_size',
'min_wal_size',
'wal_buffers',
'checkpoint_completion_target',
'max_connections',
'max_prepared_transactions',
'max_locks_per_transaction',
'max_pred_locks_per_transaction',
'max_pred_locks_per_relation',
'max_pred_locks_per_page',
'logical_decoding_work_mem',
'hash_mem_multiplier',
'temp_buffers',
'shared_preload_libraries',
'dynamic_shared_memory_type',
'huge_pages',
'max_files_per_process',
'max_stack_depth'
]
def __init__(self, prometheus_url: str = "http://sink-prometheus:9090",
postgres_sink_url: str = "postgresql://pgwatch@sink-postgres:5432/measurements",
excluded_databases: Optional[List[str]] = None,
use_current_time: bool = False):
"""
Initialize the PostgreSQL report generator.
Args:
prometheus_url: URL of the Prometheus instance (default: http://sink-prometheus:9090)
postgres_sink_url: Connection string for the Postgres sink database
(default: postgresql://pgwatch@sink-postgres:5432/measurements)
excluded_databases: Additional databases to exclude from reports
use_current_time: If True, use current time instead of flooring to hour boundary.
Useful for testing with recently collected data.
"""
self.prometheus_url = prometheus_url
self.base_url = f"{prometheus_url}/api/v1"
self.postgres_sink_url = postgres_sink_url
self.pg_conn = None
self.use_current_time = use_current_time
self._build_metadata = self._load_build_metadata()
# Combine default exclusions with user-provided exclusions
self.excluded_databases = self.DEFAULT_EXCLUDED_DATABASES.copy()
if excluded_databases:
self.excluded_databases.update(excluded_databases)
# AWS Managed Prometheus Support
self.auth = None
if os.environ.get('ENABLE_AMP', 'false').lower() == 'true':
region = os.environ.get('AWS_REGION', 'us-east-1')
service = 'aps'
session = boto3.Session()
credentials = session.get_credentials()
if credentials:
self.auth = AWS4Auth(
region=region,
service=service,
refreshable_credentials=credentials,
)
vm_user = os.environ.get('VM_AUTH_USERNAME')
vm_pass = os.environ.get('VM_AUTH_PASSWORD')
if not self.auth and vm_user and vm_pass:
self.auth = (vm_user, vm_pass)
def _read_text_file(self, path: str) -> Optional[str]:
"""Read and strip a small text file. Returns None if missing/empty/unreadable."""
try:
with open(path, "r", encoding="utf-8") as f:
value = f.read().strip()
return value or None
except Exception:
return None
def _load_build_metadata(self) -> Dict[str, Optional[str]]:
"""
Load build metadata from the container filesystem.
Defaults:
- VERSION_FILE: /VERSION
- BUILD_TS_FILE: /BUILD_TS
Both paths can be overridden for testing via env:
- PGAI_VERSION_FILE
- PGAI_BUILD_TS_FILE
"""
version_path = os.getenv("PGAI_VERSION_FILE", "/VERSION")
build_ts_path = os.getenv("PGAI_BUILD_TS_FILE", "/BUILD_TS")
return {
"version": self._read_text_file(version_path),
"build_ts": self._read_text_file(build_ts_path),
}
@staticmethod
def _escape_promql_label(value: str) -> str:
"""Escape a value for use inside PromQL label matchers.
Delegates to the shared implementation in
monitoring_flask_backend.promql_utils to avoid duplicate logic.
Coerces the input to str first so callers may pass numeric values.
"""
return _promql_escape_label(str(value))
def test_connection(self) -> bool:
"""Test connection to Prometheus."""
try:
response = requests.get(f"{self.base_url}/status/config", timeout=10, auth=self.auth)
return response.status_code == 200
except Exception as e:
logger.error(f"Connection failed: {e}")
return False
def connect_postgres_sink(self) -> bool:
"""Connect to Postgres sink database."""
if not self.postgres_sink_url:
return False
if psycopg2 is None:
raise RuntimeError("psycopg2 is required for postgres sink access but is not installed")
try:
self.pg_conn = psycopg2.connect(self.postgres_sink_url, connect_timeout=10)
return True
except Exception as e:
logger.error(f"Postgres sink connection failed: {e}")
return False
def close_postgres_sink(self):
"""Close Postgres sink connection."""
if self.pg_conn:
self.pg_conn.close()
self.pg_conn = None
def get_index_definitions_from_sink(self, db_name: str = None) -> Dict[str, str]:
"""
Get index definitions from the Postgres sink database.
Args:
db_name: Optional database name to filter results
Returns:
Dictionary mapping index names to their definitions
"""
if not self.pg_conn:
if not self.connect_postgres_sink():
return {}
index_definitions = {}
try:
with self.pg_conn.cursor(cursor_factory=psycopg2.extras.DictCursor, name='index_defs_cursor') as cursor:
# Use server-side cursor for memory efficiency with large result sets
# PERFORMANCE NOTE: This query will use a Seq Scan on index_definitions table.
# This is acceptable because:
# 1. This method is called VERY rarely (only during report generation)
# 2. The table size is expected to remain small (< 10000 rows per database)
# 3. Current latency is well under 1 second for typical workloads
#
# If the table grows significantly larger (>> 10000 rows) or latency exceeds 1s,
# consider adding a GIN index on the data JSONB column or materialized view.
if db_name:
query = """
select distinct on (data->>'indexrelname')
data->>'indexrelname' as indexrelname,
data->>'index_definition' as index_definition,
dbname
from public.index_definitions
where dbname = %s
order by data->>'indexrelname', time desc
"""
cursor.execute(query, (db_name,))
else:
query = """
select distinct on (dbname, data->>'indexrelname')
data->>'indexrelname' as indexrelname,
data->>'index_definition' as index_definition,
dbname
from public.index_definitions
order by dbname, data->>'indexrelname', time desc
"""
cursor.execute(query)
# Use iterator to fetch rows in batches instead of loading all at once
for row in cursor:
if row['indexrelname']:
# Include database name in the key to avoid collisions across databases
key = f"{row['dbname']}.{row['indexrelname']}" if not db_name else row['indexrelname']
index_definitions[key] = row['index_definition']
except Exception as e:
logger.error(f"Error fetching index definitions from Postgres sink: {e}")
return index_definitions
def get_queryid_queries_from_sink(self, query_text_limit: int = 655360, db_names: List[str] = None) -> Dict[str, Dict[str, str]]:
"""
Get queryid-to-query text mappings from the Postgres sink database.
Args:
query_text_limit: Maximum number of characters for each query text (default: 655360)
db_names: Optional list of database names to filter results (default: fetch all)
Returns:
Dictionary with database names as keys, containing queryid->query mappings
"""
if not self.pg_conn:
if not self.connect_postgres_sink():
return {}
queries_by_db: Dict[str, Dict[str, str]] = {}
try:
# Use server-side cursor for memory efficiency with large result sets
with self.pg_conn.cursor(cursor_factory=psycopg2.extras.DictCursor, name='queryid_cursor') as cursor:
# Query unique queryid-to-query mappings
# The pgss_queryid_queries table stores deduplicated queryid->query mappings
if db_names:
query = """
select distinct on (dbname, data->>'queryid')
dbname,
data->>'queryid' as queryid,
data->>'query' as query
from public.pgss_queryid_queries
where
dbname = ANY(%s)
and data->>'queryid' is not null
and data->>'query' is not null
order by dbname, data->>'queryid', time desc
"""
cursor.execute(query, (db_names,))
else:
query = """
select distinct on (dbname, data->>'queryid')
dbname,
data->>'queryid' as queryid,
data->>'query' as query
from public.pgss_queryid_queries
where
data->>'queryid' is not null
and data->>'query' is not null
order by dbname, data->>'queryid', time desc
"""
cursor.execute(query)
for row in cursor:
db_name = row['dbname']
queryid = row['queryid']
query_text = row['query']
if not queryid:
continue
if query_text and len(query_text) > query_text_limit:
query_text = query_text[:query_text_limit] + '...'
if db_name not in queries_by_db:
queries_by_db[db_name] = {}
queries_by_db[db_name][queryid] = query_text or ''
except Exception as e:
logger.error(f"Error fetching queryid queries from Postgres sink: {e}")
return queries_by_db
def query_instant(self, query: str) -> Dict[str, Any]:
"""
Execute an instant PromQL query.
Args:
query: PromQL query string
Returns:
Dictionary containing the query results
"""
params = {'query': query}
try:
response = requests.get(f"{self.base_url}/query", params=params, auth=self.auth, timeout=30)
if response.status_code == 200:
return response.json()
else:
logger.error(f"Query failed with status {response.status_code}: {response.text}")
return {}
except Exception as e:
logger.error(f"Query error: {e}")
return {}
def _get_postgres_version_info(self, cluster: str, node_name: str) -> Dict[str, str]:
"""
Fetch and parse Postgres version information from pgwatch settings metrics.
Notes:
- This helper is intentionally defensive: it validates the returned setting_name label
(tests may stub query responses broadly by metric name substring).
- Uses a single query with a regex on setting_name to reduce roundtrips.
"""
# Support both label schemas:
# - newer/expected-by-tests: setting_name/setting_value
# - older/pgwatch-tagged: tag_setting_name/tag_setting_value
_esc = self._escape_promql_label
queries = [
(
"setting_name",
f'last_over_time(pgwatch_settings_configured{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", '
f'setting_name=~"server_version|server_version_num"}}[3h])',
),
(
"tag_setting_name",
f'last_over_time(pgwatch_settings_configured{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", '
f'tag_setting_name=~"server_version|server_version_num"}}[3h])',
),
]
version_str = None
version_num = None
for label_name, query in queries:
result = self.query_instant(query)
if result.get("status") != "success":
continue
for item in (result.get("data", {}) or {}).get("result", []) or []:
metric = item.get("metric", {}) or {}
setting_name = metric.get("setting_name") or metric.get("tag_setting_name") or ""
setting_value = metric.get("setting_value") or metric.get("tag_setting_value") or ""
if setting_name == "server_version" and setting_value and not version_str:
version_str = setting_value
elif setting_name == "server_version_num" and setting_value and not version_num:
version_num = setting_value
if version_str or version_num:
break
if not (version_str or version_num):
logger.warning(f"No version data found (cluster={cluster}, node_name={node_name})")
server_version = version_str or "Unknown"
version_info: Dict[str, str] = {
"version": server_version,
"server_version_num": version_num or "Unknown",
"server_major_ver": "Unknown",
"server_minor_ver": "Unknown",
}
if server_version != "Unknown":
# Handle both formats:
# - "15.3"
# - "15.3 (Ubuntu 15.3-1.pgdg20.04+1)"
version_parts = server_version.split()[0].split(".")
if len(version_parts) >= 1 and version_parts[0]:
version_info["server_major_ver"] = version_parts[0]
if len(version_parts) >= 2:
version_info["server_minor_ver"] = ".".join(version_parts[1:])
else:
version_info["server_minor_ver"] = "0"
return version_info
def generate_a002_version_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[str, Any]:
"""
Generate A002 Version Information report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing version information
"""
logger.info(f"Generating A002 Version Information report for cluster='{cluster}', node_name='{node_name}'...")
version_info = self._get_postgres_version_info(cluster, node_name)
return self.format_report_data("A002", {"version": version_info}, node_name)
def generate_a003_settings_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[str, Any]:
"""
Generate A003 PostgreSQL Settings report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing settings information
"""
logger.info("Generating A003 PostgreSQL Settings report...")
# Query all PostgreSQL settings using the pgwatch_settings_configured metric with last_over_time
# This metric has labels for each setting name
_esc = self._escape_promql_label
settings_query = f'last_over_time(pgwatch_settings_configured{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
result = self.query_instant(settings_query)
settings_data = {}
if result.get('status') == 'success' and result.get('data', {}).get('result'):
for item in result['data']['result']:
# Extract setting name from labels
setting_name = item['metric'].get('setting_name', '')
setting_value = item['metric'].get('setting_value', '')
# Skip if we don't have a setting name
if not setting_name:
continue
# Get additional metadata from labels
category = item['metric'].get('category', 'Other')
unit = item['metric'].get('unit', '')
context = item['metric'].get('context', '')
vartype = item['metric'].get('vartype', '')
settings_data[setting_name] = {
"setting": setting_value,
"unit": unit,
"category": category,
"context": context,
"vartype": vartype,
"pretty_value": self.format_setting_value(setting_name, setting_value, unit)
}
else:
logger.warning(f"A003 - No settings data returned for cluster={cluster}, node_name={node_name}")
logger.info(f"Query result status: {result.get('status')}")
logger.info(f"Query result data: {result.get('data', {})}")
return self.format_report_data("A003", settings_data, node_name, postgres_version=self._get_postgres_version_info(cluster, node_name))
def generate_a004_cluster_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[str, Any]:
"""
Generate A004 Cluster Information report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing cluster information
"""
logger.info("Generating A004 Cluster Information report...")
# Query cluster information
_esc = self._escape_promql_label
cluster_queries = {
'active_connections': f'sum(last_over_time(pgwatch_pg_stat_activity_count{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", state="active"}}[3h]))',
'idle_connections': f'sum(last_over_time(pgwatch_pg_stat_activity_count{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", state="idle"}}[3h]))',
'total_connections': f'sum(last_over_time(pgwatch_pg_stat_activity_count{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]))',
'database_sizes': f'sum(last_over_time(pgwatch_db_size_size_b{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]))',
'cache_hit_ratio': f'sum(last_over_time(pgwatch_db_stats_blks_hit{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])) / clamp_min(sum(last_over_time(pgwatch_db_stats_blks_hit{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])) + sum(last_over_time(pgwatch_db_stats_blks_read{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])), 1) * 100',
'transactions_per_sec': f'sum(rate(pgwatch_db_stats_xact_commit{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[5m])) + sum(rate(pgwatch_db_stats_xact_rollback{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[5m]))',
'checkpoints_per_sec': f'sum(rate(pgwatch_pg_stat_bgwriter_checkpoints_timed{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[5m])) + sum(rate(pgwatch_pg_stat_bgwriter_checkpoints_req{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[5m]))',
'deadlocks': f'sum(last_over_time(pgwatch_db_stats_deadlocks{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]))',
'temp_files': f'sum(last_over_time(pgwatch_db_stats_temp_files{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]))',
'temp_bytes': f'sum(last_over_time(pgwatch_db_stats_temp_bytes{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]))',
}
cluster_data = {}
for metric_name, query in cluster_queries.items():
result = self.query_instant(query)
if result.get('status') == 'success' and result.get('data', {}).get('result'):
values = result['data']['result']
if values:
latest_value = values[0].get('value', [None, None])[1]
cluster_data[metric_name] = {
"value": latest_value,
"unit": self.get_cluster_metric_unit(metric_name),
"description": self.get_cluster_metric_description(metric_name)
}
# Get database sizes
db_sizes_query = f'last_over_time(pgwatch_db_size_size_b{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
db_sizes_result = self.query_instant(db_sizes_query)
database_sizes = {}
if db_sizes_result.get('status') == 'success' and db_sizes_result.get('data', {}).get('result'):
for result in db_sizes_result['data']['result']:
db_name = result['metric'].get('datname', 'unknown')
size_bytes = float(result['value'][1])
database_sizes[db_name] = size_bytes
return self.format_report_data(
"A004",
{
"general_info": cluster_data,
"database_sizes": database_sizes,
},
node_name,
postgres_version=self._get_postgres_version_info(cluster, node_name),
)
def generate_a007_altered_settings_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[
str, Any]:
"""
Generate A007 Altered Settings report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing altered settings information
"""
_esc = self._escape_promql_label
logger.info("Generating A007 Altered Settings report...")
# Query settings by source using the pgwatch_settings_is_default metric with last_over_time
# This returns settings where is_default = 0 (i.e., non-default/altered settings)
settings_by_source_query = f'last_over_time(pgwatch_settings_is_default{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h]) < 1'
result = self.query_instant(settings_by_source_query)
altered_settings = {}
if result.get('status') == 'success' and result.get('data', {}).get('result'):
for item in result['data']['result']:
# Extract setting information from labels
setting_name = item['metric'].get('setting_name', '')
value = item['metric'].get('setting_value', '')
unit = item['metric'].get('unit', '')
category = item['metric'].get('category', 'Other')
# Skip if we don't have a setting name
if not setting_name:
continue
pretty_value = self.format_setting_value(setting_name, value, unit)
altered_settings[setting_name] = {
"value": value,
"unit": unit,
"category": category,
"pretty_value": pretty_value
}
else:
logger.warning(f"A007 - No altered settings data returned for cluster={cluster}, node_name={node_name}")
logger.info(f"Query result status: {result.get('status')}")
return self.format_report_data("A007", altered_settings, node_name, postgres_version=self._get_postgres_version_info(cluster, node_name))
# H001 collects observation data only; recommendations (DROP, RECREATE, UNCERTAIN)
# are computed at render time by CLI (cli/lib/checkup.ts -> getInvalidIndexRecommendation())
# and UI (Grafana / web template) using the same decision tree.
def generate_h001_invalid_indexes_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[
str, Any]:
"""
Generate H001 Invalid Indexes report with observation data for decision tree.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing invalid indexes observation data for decision tree analysis
"""
logger.info("Generating H001 Invalid Indexes report...")
_esc = self._escape_promql_label
# Get all databases
databases = self.get_all_databases(cluster, node_name)
# Get database sizes
db_sizes_query = f'last_over_time(pgwatch_db_size_size_b{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
db_sizes_result = self.query_instant(db_sizes_query)
database_sizes = {}
if db_sizes_result.get('status') == 'success' and db_sizes_result.get('data', {}).get('result'):
for result in db_sizes_result['data']['result']:
db_name = result['metric'].get('datname', 'unknown')
size_bytes = float(result['value'][1])
database_sizes[db_name] = size_bytes
invalid_indexes_by_db = {}
for db_name in databases:
# Fetch index definitions from the sink for this database (used to aid remediation)
index_definitions = self.get_index_definitions_from_sink(db_name)
# Query all invalid indexes metrics and merge by index key
# Each field is a separate metric in pgwatch prometheus export
_esc = self._escape_promql_label
base_filter = f'cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", datname="{_esc(db_name)}"'
# Query primary metric (index_size_bytes) - this determines which indexes exist
size_query = f'last_over_time(pgwatch_pg_invalid_indexes_index_size_bytes{{{base_filter}}}[3h])'
size_result = self.query_instant(size_query)
# Build index data keyed by (schema_name, table_name, index_name)
indexes_data: Dict[tuple, Dict[str, Any]] = {}
if size_result.get('status') == 'success' and size_result.get('data', {}).get('result'):
for item in size_result['data']['result']:
schema_name = item['metric'].get('schema_name', 'unknown')
table_name = item['metric'].get('table_name', 'unknown')
index_name = item['metric'].get('index_name', 'unknown')
key = (schema_name, table_name, index_name)
indexes_data[key] = {
"schema_name": schema_name,
"table_name": table_name,
"index_name": index_name,
"relation_name": item['metric'].get('relation_name', f"{schema_name}.{table_name}"),
"index_size_bytes": float(item['value'][1]) if item.get('value') else 0,
"index_definition": index_definitions.get(index_name, "Definition not available"),
"valid_duplicate_name": item['metric'].get('valid_index_name') or None,
"valid_duplicate_definition": item['metric'].get('valid_index_definition') or None,
"constraint_name": item['metric'].get('constraint_name') or None,
# Defaults for boolean/numeric fields (will be updated from separate metrics)
"supports_fk": False,
"is_pk": False,
"is_unique": False,
"has_valid_duplicate": False,
"table_row_estimate": 0,
}
# Query additional metrics and merge values
additional_metrics = [
('pgwatch_pg_invalid_indexes_supports_fk', 'supports_fk', lambda v: int(float(v)) == 1),
('pgwatch_pg_invalid_indexes_is_pk', 'is_pk', lambda v: int(float(v)) == 1),
('pgwatch_pg_invalid_indexes_is_unique', 'is_unique', lambda v: int(float(v)) == 1),
('pgwatch_pg_invalid_indexes_has_valid_duplicate', 'has_valid_duplicate', lambda v: int(float(v)) == 1),
('pgwatch_pg_invalid_indexes_table_row_estimate', 'table_row_estimate', lambda v: int(float(v))),
]
for metric_name, field_name, converter in additional_metrics:
query = f'last_over_time({metric_name}{{{base_filter}}}[3h])'
result = self.query_instant(query)
if result.get('status') == 'success' and result.get('data', {}).get('result'):
for item in result['data']['result']:
key = (
item['metric'].get('schema_name', 'unknown'),
item['metric'].get('table_name', 'unknown'),
item['metric'].get('index_name', 'unknown'),
)
if key in indexes_data and item.get('value'):
try:
indexes_data[key][field_name] = converter(item['value'][1])
except (ValueError, TypeError):
pass # Keep default value
# Convert to list and calculate totals
invalid_indexes = []
total_size = 0
for data in indexes_data.values():
data["index_size_pretty"] = self.format_bytes(data["index_size_bytes"])
invalid_indexes.append(data)
total_size += data["index_size_bytes"]
# Skip databases with no invalid indexes
if not invalid_indexes:
continue
db_size_bytes = database_sizes.get(db_name, 0)
invalid_indexes_by_db[db_name] = {
"invalid_indexes": invalid_indexes,
"total_count": len(invalid_indexes),
"total_size_bytes": total_size,
"total_size_pretty": self.format_bytes(total_size),
"database_size_bytes": db_size_bytes,
"database_size_pretty": self.format_bytes(db_size_bytes)
}
return self.format_report_data(
"H001",
invalid_indexes_by_db,
node_name,
postgres_version=self._get_postgres_version_info(cluster, node_name),
)
def generate_h002_unused_indexes_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[str, Any]:
"""
Generate H002 Unused Indexes report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing unused indexes information
"""
_esc = self._escape_promql_label
logger.info("Generating H002 Unused Indexes report...")
# Get all databases
databases = self.get_all_databases(cluster, node_name)
# Get database sizes
db_sizes_query = f'last_over_time(pgwatch_db_size_size_b{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
db_sizes_result = self.query_instant(db_sizes_query)
database_sizes = {}
if db_sizes_result.get('status') == 'success' and db_sizes_result.get('data', {}).get('result'):
for result in db_sizes_result['data']['result']:
db_name = result['metric'].get('datname', 'unknown')
size_bytes = float(result['value'][1])
database_sizes[db_name] = size_bytes
# Query postmaster uptime to get startup time
postmaster_uptime_query = f'last_over_time(pgwatch_db_stats_postmaster_uptime_s{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
postmaster_uptime_result = self.query_instant(postmaster_uptime_query)
postmaster_startup_time = None
postmaster_startup_epoch = None
if postmaster_uptime_result.get('status') == 'success' and postmaster_uptime_result.get('data', {}).get('result'):
uptime_seconds = float(postmaster_uptime_result['data']['result'][0]['value'][1]) if postmaster_uptime_result['data']['result'] else None
if uptime_seconds:
postmaster_startup_epoch = datetime.now().timestamp() - uptime_seconds
postmaster_startup_time = datetime.fromtimestamp(postmaster_startup_epoch).isoformat()
unused_indexes_by_db = {}
for db_name in databases:
# Get index definitions from Postgres sink database for this specific database
index_definitions = self.get_index_definitions_from_sink(db_name)
# Query stats_reset timestamp for this database
stats_reset_query = f'last_over_time(pgwatch_stats_reset_stats_reset_epoch{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", datname="{_esc(db_name)}"}}[3h])'
stats_reset_result = self.query_instant(stats_reset_query)
stats_reset_epoch = None
days_since_reset = None
stats_reset_time = None
if stats_reset_result.get('status') == 'success' and stats_reset_result.get('data', {}).get('result'):
stats_reset_epoch = float(stats_reset_result['data']['result'][0]['value'][1]) if stats_reset_result['data']['result'] else None
if stats_reset_epoch:
stats_reset_time = datetime.fromtimestamp(stats_reset_epoch).isoformat()
days_since_reset = (datetime.now() - datetime.fromtimestamp(stats_reset_epoch)).days
# Query unused indexes for each database using last_over_time to get most recent value
unused_indexes_query = f'last_over_time(pgwatch_unused_indexes_index_size_bytes{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", datname="{_esc(db_name)}"}}[3h])'
unused_result = self.query_instant(unused_indexes_query)
unused_indexes = []
if unused_result.get('status') == 'success' and unused_result.get('data', {}).get('result'):
for item in unused_result['data']['result']:
schema_name = item['metric'].get('schema_name', 'unknown')
table_name = item['metric'].get('table_name', 'unknown')
index_name = item['metric'].get('index_name', 'unknown')
reason = item['metric'].get('reason', 'Unknown')
# Get the index size from the metric value
index_size_bytes = float(item['value'][1]) if item.get('value') else 0
# Query other related metrics for this index
idx_scan_query = f'last_over_time(pgwatch_unused_indexes_idx_scan{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", datname="{_esc(db_name)}", schema_name="{_esc(schema_name)}", table_name="{_esc(table_name)}", index_name="{_esc(index_name)}"}}[3h])'
idx_scan_result = self.query_instant(idx_scan_query)
idx_scan = float(idx_scan_result['data']['result'][0]['value'][1]) if idx_scan_result.get('data',
{}).get(
'result') else 0
# Get index definition from collected metrics
index_definition = index_definitions.get(index_name, "Definition not available")
index_data = {
"schema_name": schema_name,
"table_name": table_name,
"index_name": index_name,
"index_definition": index_definition,
"reason": reason,
"idx_scan": idx_scan,
"index_size_bytes": index_size_bytes,
"idx_is_btree": item['metric'].get('idx_is_btree', 'false') == 'true',
"supports_fk": bool(int(item['metric'].get('supports_fk', 0)))
}
index_data['index_size_pretty'] = self.format_bytes(index_data['index_size_bytes'])
unused_indexes.append(index_data)
# Sort by index size descending
unused_indexes.sort(key=lambda x: x['index_size_bytes'], reverse=True)
# Skip databases with no unused indexes
if not unused_indexes:
continue
total_unused_size = sum(idx['index_size_bytes'] for idx in unused_indexes)
db_size_bytes = database_sizes.get(db_name, 0)
unused_indexes_by_db[db_name] = {
"unused_indexes": unused_indexes,
"total_count": len(unused_indexes),
"total_size_bytes": total_unused_size,
"total_size_pretty": self.format_bytes(total_unused_size),
"database_size_bytes": db_size_bytes,
"database_size_pretty": self.format_bytes(db_size_bytes),
"stats_reset": {
"stats_reset_epoch": stats_reset_epoch,
"stats_reset_time": stats_reset_time,
"days_since_reset": days_since_reset,
"postmaster_startup_epoch": postmaster_startup_epoch,
"postmaster_startup_time": postmaster_startup_time
}
}
return self.format_report_data(
"H002",
unused_indexes_by_db,
node_name,
postgres_version=self._get_postgres_version_info(cluster, node_name),
)
def generate_h004_redundant_indexes_report(self, cluster: str = "local", node_name: str = "node-01") -> Dict[
str, Any]:
"""
Generate H004 Redundant Indexes report.
Args:
cluster: Cluster name
node_name: Node name
Returns:
Dictionary containing redundant indexes information
"""
_esc = self._escape_promql_label
logger.info("Generating H004 Redundant Indexes report...")
# Get all databases
databases = self.get_all_databases(cluster, node_name)
# Get database sizes
db_sizes_query = f'last_over_time(pgwatch_db_size_size_b{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}"}}[3h])'
db_sizes_result = self.query_instant(db_sizes_query)
database_sizes = {}
if db_sizes_result.get('status') == 'success' and db_sizes_result.get('data', {}).get('result'):
for result in db_sizes_result['data']['result']:
db_name = result['metric'].get('datname', 'unknown')
size_bytes = float(result['value'][1])
database_sizes[db_name] = size_bytes
redundant_indexes_by_db = {}
for db_name in databases:
# Fetch index definitions from the sink for this database (used to aid remediation)
index_definitions = self.get_index_definitions_from_sink(db_name)
# Query redundant indexes for each database using last_over_time to get most recent value
redundant_indexes_query = f'last_over_time(pgwatch_redundant_indexes_index_size_bytes{{cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", dbname="{_esc(db_name)}"}}[3h])'
result = self.query_instant(redundant_indexes_query)
redundant_indexes = []
total_size = 0
if result.get('status') == 'success' and result.get('data', {}).get('result'):
for item in result['data']['result']:
schema_name = item['metric'].get('schema_name', 'unknown')
table_name = item['metric'].get('table_name', 'unknown')
index_name = item['metric'].get('index_name', 'unknown')
relation_name = item['metric'].get('relation_name', f"{schema_name}.{table_name}")
access_method = item['metric'].get('access_method', 'unknown')
reason = item['metric'].get('reason', 'Unknown')
# Get the index size from the metric value
index_size_bytes = float(item['value'][1]) if item.get('value') else 0
# Query other related metrics for this index
_idx_filter = f'cluster="{_esc(cluster)}", node_name="{_esc(node_name)}", dbname="{_esc(db_name)}", schema_name="{_esc(schema_name)}", table_name="{_esc(table_name)}", index_name="{_esc(index_name)}"'
table_size_query = f'last_over_time(pgwatch_redundant_indexes_table_size_bytes{{{_idx_filter}}}[3h])'
table_size_result = self.query_instant(table_size_query)
table_size_bytes = float(
table_size_result['data']['result'][0]['value'][1]) if table_size_result.get('data', {}).get(
'result') else 0
index_usage_query = f'last_over_time(pgwatch_redundant_indexes_index_usage{{{_idx_filter}}}[3h])'
index_usage_result = self.query_instant(index_usage_query)
index_usage = float(index_usage_result['data']['result'][0]['value'][1]) if index_usage_result.get(
'data', {}).get('result') else 0
supports_fk_query = f'last_over_time(pgwatch_redundant_indexes_supports_fk{{{_idx_filter}}}[3h])'
supports_fk_result = self.query_instant(supports_fk_query)
supports_fk = bool(
int(supports_fk_result['data']['result'][0]['value'][1])) if supports_fk_result.get('data',
{}).get(
'result') else False
# Build redundant_to array from the reason field
# The reason field contains comma-separated index names
# (the indexes that make this index redundant)
# Note: In full mode, index sizes for redundant_to are not available
# (would require additional Prometheus queries). Use express mode for sizes.
redundant_to = []
for idx_name in [r.strip() for r in reason.split(',') if r.strip()]:
redundant_to.append({
"index_name": idx_name,
"index_definition": index_definitions.get(idx_name, "Definition not available"),
"index_size_bytes": 0,
"index_size_pretty": "N/A"
})
redundant_index = {
"schema_name": schema_name,
"table_name": table_name,
"index_name": index_name,
"relation_name": relation_name,
"access_method": access_method,
"reason": reason,
"index_size_bytes": index_size_bytes,
"table_size_bytes": table_size_bytes,
"index_usage": index_usage,
"supports_fk": supports_fk,
"index_definition": index_definitions.get(index_name, "Definition not available"),
"index_size_pretty": self.format_bytes(index_size_bytes),
"table_size_pretty": self.format_bytes(table_size_bytes),
"redundant_to": redundant_to
}