postgresai 0.16.0-rc.4 → 0.16.0

package/schemas/H004.schema.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "H004 report schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["checkId", "checkTitle", "timestamptz", "nodes", "results"],
+  "properties": {
+    "contract_version": { "type": ["string", "null"] },
+    "summary": { "type": "object", "additionalProperties": false, "required": ["status", "message"], "properties": { "status": { "enum": ["ok", "warning", "info"] }, "message": { "type": "string" } } },
+    "version": { "type": ["string", "null"] },
+    "build_ts": { "type": ["string", "null"] },
+    "generation_mode": { "type": ["string", "null"] },
+    "checkId": { "const": "H004" },
+    "checkTitle": { "const": "Redundant indexes" },
+    "timestamptz": { "type": "string" },
+    "nodes": { "$ref": "#/$defs/nodes" },
+    "results": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": { "$ref": "#/$defs/nodeResult" }
+    }
+  },
+  "$defs": {
+    "nodes": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["primary", "standbys"],
+      "properties": {
+        "primary": { "type": "string" },
+        "standbys": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "postgresVersion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "server_version_num", "server_major_ver", "server_minor_ver"],
+      "properties": {
+        "version": { "type": "string" },
+        "server_version_num": { "type": "string" },
+        "server_major_ver": { "type": "string" },
+        "server_minor_ver": { "type": "string" }
+      }
+    },
+    "redundantToIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["index_name", "index_definition", "index_size_bytes", "index_size_pretty"],
+      "properties": {
+        "index_name": { "type": "string" },
+        "index_definition": { "type": "string" },
+        "index_size_bytes": { "type": "number" },
+        "index_size_pretty": { "type": "string" }
+      }
+    },
+    "redundantIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "index_name",
+        "relation_name",
+        "access_method",
+        "reason",
+        "index_size_bytes",
+        "table_size_bytes",
+        "index_usage",
+        "supports_fk",
+        "index_definition",
+        "index_size_pretty",
+        "table_size_pretty",
+        "redundant_to"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "index_name": { "type": "string" },
+        "relation_name": { "type": "string" },
+        "access_method": { "type": "string" },
+        "reason": { "type": "string" },
+        "index_size_bytes": { "type": "number" },
+        "table_size_bytes": { "type": "number" },
+        "index_usage": { "type": "number" },
+        "supports_fk": { "type": "boolean" },
+        "index_definition": { "type": "string" },
+        "index_size_pretty": { "type": "string" },
+        "table_size_pretty": { "type": "string" },
+        "redundant_to": { "type": "array", "items": { "$ref": "#/$defs/redundantToIndex" } },
+        "redundant_to_parse_error": { "type": "string" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "redundant_indexes",
+        "total_count",
+        "total_size_bytes",
+        "total_size_pretty",
+        "database_size_bytes",
+        "database_size_pretty"
+      ],
+      "properties": {
+        "redundant_indexes": { "type": "array", "items": { "$ref": "#/$defs/redundantIndex" } },
+        "total_count": { "type": "integer" },
+        "total_size_bytes": { "type": "number" },
+        "total_size_pretty": { "type": "string" },
+        "database_size_bytes": { "type": "number" },
+        "database_size_pretty": { "type": "string" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/dbEntry" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+

package/schemas/I001.schema.json

@@ -0,0 +1,149 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "I001 report schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["checkId", "checkTitle", "timestamptz", "nodes", "results"],
+  "properties": {
+    "contract_version": { "type": ["string", "null"] },
+    "summary": { "type": "object", "additionalProperties": false, "required": ["status", "message"], "properties": { "status": { "enum": ["ok", "warning", "info"] }, "message": { "type": "string" } } },
+    "version": { "type": ["string", "null"] },
+    "build_ts": { "type": ["string", "null"] },
+    "generation_mode": { "type": ["string", "null"] },
+    "checkId": { "const": "I001" },
+    "checkTitle": { "const": "I/O statistics (pg_stat_io)" },
+    "timestamptz": { "type": "string" },
+    "nodes": { "$ref": "#/$defs/nodes" },
+    "results": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": { "$ref": "#/$defs/nodeResult" }
+    }
+  },
+  "$defs": {
+    "nodes": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["primary", "standbys"],
+      "properties": {
+        "primary": { "type": "string" },
+        "standbys": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "postgresVersion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "server_version_num", "server_major_ver", "server_minor_ver"],
+      "properties": {
+        "version": { "type": "string" },
+        "server_version_num": { "type": "string" },
+        "server_major_ver": { "type": "string" },
+        "server_minor_ver": { "type": "string" }
+      }
+    },
+    "backendIOStats": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "backend_type",
+        "reads",
+        "read_bytes_mb",
+        "read_time_ms",
+        "writes",
+        "write_bytes_mb",
+        "write_time_ms",
+        "writebacks",
+        "writeback_bytes_mb",
+        "writeback_time_ms",
+        "fsyncs",
+        "fsync_time_ms",
+        "hits",
+        "evictions",
+        "reuses"
+      ],
+      "properties": {
+        "backend_type": { "type": "string" },
+        "reads": { "type": "number" },
+        "read_bytes_mb": { "type": "number" },
+        "read_time_ms": { "type": "number" },
+        "writes": { "type": "number" },
+        "write_bytes_mb": { "type": "number" },
+        "write_time_ms": { "type": "number" },
+        "writebacks": { "type": "number" },
+        "writeback_bytes_mb": { "type": "number" },
+        "writeback_time_ms": { "type": "number" },
+        "fsyncs": { "type": "number" },
+        "fsync_time_ms": { "type": "number" },
+        "extends": {
+          "type": "number",
+          "description": "Number of relation extension operations reported by pg_stat_io. Populated for PostgreSQL 16+ backends."
+        },
+        "extend_bytes_mb": {
+          "type": "number",
+          "description": "Mebibytes extended by pg_stat_io. PostgreSQL 16 derives this from extends * op_bytes; PostgreSQL 18+ uses the native extend_bytes column."
+        },
+        "hits": { "type": "number" },
+        "evictions": { "type": "number" },
+        "reuses": { "type": "number" }
+      }
+    },
+    "analysis": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["total_read_mb", "total_write_mb", "total_io_time_ms", "read_hit_ratio_pct"],
+      "properties": {
+        "total_read_mb": {
+          "type": "number",
+          "description": "Total read volume in MiB. Historical field name retains the _mb suffix for compatibility."
+        },
+        "total_write_mb": {
+          "type": "number",
+          "description": "Total write volume in MiB. Historical field name retains the _mb suffix for compatibility."
+        },
+        "total_io_time_ms": {
+          "type": "number",
+          "description": "Total read_time_ms + write_time_ms across backends. Excludes writeback and fsync time."
+        },
+        "read_hit_ratio_pct": {
+          "type": "number",
+          "description": "Buffer hit ratio percentage: 100 * hits / (hits + reads)."
+        },
+        "avg_read_time_ms": {
+          "type": ["number", "null"],
+          "description": "Average read latency in milliseconds per read operation; null when total reads is zero."
+        },
+        "avg_write_time_ms": {
+          "type": ["number", "null"],
+          "description": "Average write latency in milliseconds per write operation; null when total writes is zero."
+        }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["available", "by_backend_type", "analysis", "stats_reset_s"],
+      "properties": {
+        "available": { "type": "boolean" },
+        "min_version_required": {
+          "type": "string",
+          "description": "Minimum PostgreSQL major version required for this check. Present when available is false because pg_stat_io is unsupported."
+        },
+        "by_backend_type": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/backendIOStats" }
+        },
+        "analysis": { "$ref": "#/$defs/analysis" },
+        "stats_reset_s": { "type": ["number", "null"] }
+      }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}

package/schemas/K001.schema.json

@@ -0,0 +1,161 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "K001 report schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["checkId", "checkTitle", "timestamptz", "nodes", "results"],
+  "properties": {
+    "contract_version": { "type": ["string", "null"] },
+    "summary": { "type": "object", "additionalProperties": false, "required": ["status", "message"], "properties": { "status": { "enum": ["ok", "warning", "info"] }, "message": { "type": "string" } } },
+    "version": { "type": ["string", "null"] },
+    "build_ts": { "type": ["string", "null"] },
+    "generation_mode": { "type": ["string", "null"] },
+    "checkId": { "const": "K001" },
+    "checkTitle": { "const": "Globally aggregated query metrics" },
+    "timestamptz": { "type": "string" },
+    "nodes": { "$ref": "#/$defs/nodes" },
+    "results": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": { "$ref": "#/$defs/nodeResult" }
+    }
+  },
+  "$defs": {
+    "nodes": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["primary", "standbys"],
+      "properties": {
+        "primary": { "type": "string" },
+        "standbys": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "postgresVersion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "server_version_num", "server_major_ver", "server_minor_ver"],
+      "properties": {
+        "version": { "type": "string" },
+        "server_version_num": { "type": "string" },
+        "server_major_ver": { "type": "string" },
+        "server_minor_ver": { "type": "string" }
+      }
+    },
+    "queryMetric": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "queryid",
+        "database",
+        "user",
+        "duration_seconds",
+        "calls",
+        "calls_per_sec",
+        "calls_per_call",
+        "total_time",
+        "total_time_per_sec",
+        "total_time_per_call",
+        "rows",
+        "rows_per_sec",
+        "rows_per_call",
+        "shared_blks_hit",
+        "shared_blks_hit_per_sec",
+        "shared_blks_hit_per_call",
+        "shared_blks_read",
+        "shared_blks_read_per_sec",
+        "shared_blks_read_per_call",
+        "shared_blks_dirtied",
+        "shared_blks_dirtied_per_sec",
+        "shared_blks_dirtied_per_call",
+        "shared_blks_written",
+        "shared_blks_written_per_sec",
+        "shared_blks_written_per_call",
+        "blk_read_time",
+        "blk_read_time_per_sec",
+        "blk_read_time_per_call",
+        "blk_write_time",
+        "blk_write_time_per_sec",
+        "blk_write_time_per_call"
+      ],
+      "properties": {
+        "queryid": { "type": "string" },
+        "database": { "type": "string" },
+        "user": { "type": "string" },
+        "duration_seconds": { "type": "number" },
+        "calls": { "type": "number" },
+        "calls_per_sec": { "type": "number" },
+        "calls_per_call": { "type": "number" },
+        "total_time": { "type": "number" },
+        "total_time_per_sec": { "type": "number" },
+        "total_time_per_call": { "type": "number" },
+        "rows": { "type": "number" },
+        "rows_per_sec": { "type": "number" },
+        "rows_per_call": { "type": "number" },
+        "shared_blks_hit": { "type": "number" },
+        "shared_blks_hit_per_sec": { "type": "number" },
+        "shared_blks_hit_per_call": { "type": "number" },
+        "shared_blks_read": { "type": "number" },
+        "shared_blks_read_per_sec": { "type": "number" },
+        "shared_blks_read_per_call": { "type": "number" },
+        "shared_blks_dirtied": { "type": "number" },
+        "shared_blks_dirtied_per_sec": { "type": "number" },
+        "shared_blks_dirtied_per_call": { "type": "number" },
+        "shared_blks_written": { "type": "number" },
+        "shared_blks_written_per_sec": { "type": "number" },
+        "shared_blks_written_per_call": { "type": "number" },
+        "blk_read_time": { "type": "number" },
+        "blk_read_time_per_sec": { "type": "number" },
+        "blk_read_time_per_call": { "type": "number" },
+        "blk_write_time": { "type": "number" },
+        "blk_write_time_per_sec": { "type": "number" },
+        "blk_write_time_per_call": { "type": "number" }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "total_queries",
+        "total_calls",
+        "total_time_ms",
+        "total_rows",
+        "time_range_minutes",
+        "start_time",
+        "end_time"
+      ],
+      "properties": {
+        "total_queries": { "type": "integer" },
+        "total_calls": { "type": "number" },
+        "total_time_ms": { "type": "number" },
+        "total_rows": { "type": "number" },
+        "time_range_minutes": { "type": "integer" },
+        "start_time": { "type": "string" },
+        "end_time": { "type": "string" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["query_metrics", "summary"],
+      "properties": {
+        "query_metrics": { "type": "array", "items": { "$ref": "#/$defs/queryMetric" } },
+        "summary": { "$ref": "#/$defs/summary" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/dbEntry" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+

package/schemas/K003.schema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "K003 report schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["checkId", "checkTitle", "timestamptz", "nodes", "results"],
+  "properties": {
+    "contract_version": { "type": ["string", "null"] },
+    "summary": { "type": "object", "additionalProperties": false, "required": ["status", "message"], "properties": { "status": { "enum": ["ok", "warning", "info"] }, "message": { "type": "string" } } },
+    "version": { "type": ["string", "null"] },
+    "build_ts": { "type": ["string", "null"] },
+    "generation_mode": { "type": ["string", "null"] },
+    "checkId": { "const": "K003" },
+    "checkTitle": { "const": "Top queries by total time (total_exec_time + total_plan_time)" },
+    "timestamptz": { "type": "string" },
+    "nodes": { "$ref": "#/$defs/nodes" },
+    "results": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": { "$ref": "#/$defs/nodeResult" }
+    }
+  },
+  "$defs": {
+    "nodes": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["primary", "standbys"],
+      "properties": {
+        "primary": { "type": "string" },
+        "standbys": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "postgresVersion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "server_version_num", "server_major_ver", "server_minor_ver"],
+      "properties": {
+        "version": { "type": "string" },
+        "server_version_num": { "type": "string" },
+        "server_major_ver": { "type": "string" },
+        "server_minor_ver": { "type": "string" }
+      }
+    },
+    "queryMetric": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "queryid",
+        "database",
+        "user",
+        "duration_seconds",
+        "calls",
+        "calls_per_sec",
+        "calls_per_call",
+        "total_time",
+        "total_time_per_sec",
+        "total_time_per_call",
+        "rows",
+        "rows_per_sec",
+        "rows_per_call",
+        "shared_blks_hit",
+        "shared_blks_hit_per_sec",
+        "shared_blks_hit_per_call",
+        "shared_blks_read",
+        "shared_blks_read_per_sec",
+        "shared_blks_read_per_call",
+        "shared_blks_dirtied",
+        "shared_blks_dirtied_per_sec",
+        "shared_blks_dirtied_per_call",
+        "shared_blks_written",
+        "shared_blks_written_per_sec",
+        "shared_blks_written_per_call",
+        "blk_read_time",
+        "blk_read_time_per_sec",
+        "blk_read_time_per_call",
+        "blk_write_time",
+        "blk_write_time_per_sec",
+        "blk_write_time_per_call"
+      ],
+      "properties": {
+        "queryid": { "type": "string" },
+        "database": { "type": "string" },
+        "user": { "type": "string" },
+        "duration_seconds": { "type": "number" },
+        "calls": { "type": "number" },
+        "calls_per_sec": { "type": "number" },
+        "calls_per_call": { "type": "number" },
+        "total_time": { "type": "number" },
+        "total_time_per_sec": { "type": "number" },
+        "total_time_per_call": { "type": "number" },
+        "rows": { "type": "number" },
+        "rows_per_sec": { "type": "number" },
+        "rows_per_call": { "type": "number" },
+        "shared_blks_hit": { "type": "number" },
+        "shared_blks_hit_per_sec": { "type": "number" },
+        "shared_blks_hit_per_call": { "type": "number" },
+        "shared_blks_read": { "type": "number" },
+        "shared_blks_read_per_sec": { "type": "number" },
+        "shared_blks_read_per_call": { "type": "number" },
+        "shared_blks_dirtied": { "type": "number" },
+        "shared_blks_dirtied_per_sec": { "type": "number" },
+        "shared_blks_dirtied_per_call": { "type": "number" },
+        "shared_blks_written": { "type": "number" },
+        "shared_blks_written_per_sec": { "type": "number" },
+        "shared_blks_written_per_call": { "type": "number" },
+        "blk_read_time": { "type": "number" },
+        "blk_read_time_per_sec": { "type": "number" },
+        "blk_read_time_per_call": { "type": "number" },
+        "blk_write_time": { "type": "number" },
+        "blk_write_time_per_sec": { "type": "number" },
+        "blk_write_time_per_call": { "type": "number" }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "queries_returned",
+        "total_calls",
+        "total_time_ms",
+        "total_rows",
+        "time_range_minutes",
+        "start_time",
+        "end_time",
+        "limit"
+      ],
+      "properties": {
+        "queries_returned": { "type": "integer" },
+        "total_calls": { "type": "number" },
+        "total_time_ms": { "type": "number" },
+        "total_rows": { "type": "number" },
+        "time_range_minutes": { "type": "integer" },
+        "start_time": { "type": "string" },
+        "end_time": { "type": "string" },
+        "limit": { "type": "integer" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["top_queries", "summary"],
+      "properties": {
+        "top_queries": { "type": "array", "items": { "$ref": "#/$defs/queryMetric" } },
+        "summary": { "$ref": "#/$defs/summary" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/dbEntry" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+