postgresai 0.16.0-rc.4 → 0.16.0

package/schemas/F001.schema.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F001 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": "F001" },
+    "checkTitle": { "const": "Autovacuum: current settings" },
+    "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" }
+      }
+    },
+    "setting": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["setting", "unit", "category", "context", "vartype", "pretty_value"],
+      "properties": {
+        "setting": { "type": "string" },
+        "unit": { "type": "string" },
+        "category": { "type": "string" },
+        "context": { "type": "string" },
+        "vartype": { "type": "string" },
+        "pretty_value": { "type": "string" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/setting" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+

package/schemas/F002.schema.json

@@ -0,0 +1,108 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F002 report schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["checkId", "checkTitle", "timestamptz", "nodes", "results"],
+  "properties": {
+    "version": { "type": ["string", "null"] },
+    "build_ts": { "type": ["string", "null"] },
+    "contract_version": { "type": ["string", "null"] },
+    "generation_mode": { "type": ["string", "null"], "enum": ["full", "express", null] },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["status", "message"],
+      "properties": {
+        "status": { "enum": ["ok", "warning", "info"] },
+        "message": { "type": "string" }
+      }
+    },
+    "checkId": { "const": "F002" },
+    "checkTitle": { "const": "Autovacuum: transaction ID and MultiXact wraparound" },
+    "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" }
+      }
+    },
+    "settings": {
+      "type": "object", "additionalProperties": false,
+      "required": ["autovacuum_freeze_max_age", "vacuum_freeze_min_age", "vacuum_freeze_table_age", "autovacuum_multixact_freeze_max_age", "vacuum_multixact_freeze_min_age", "vacuum_multixact_freeze_table_age", "vacuum_failsafe_age", "vacuum_multixact_failsafe_age"],
+      "properties": {
+        "autovacuum_freeze_max_age": { "type": "number" }, "vacuum_freeze_min_age": { "type": "number" },
+        "vacuum_freeze_table_age": { "type": "number" }, "autovacuum_multixact_freeze_max_age": { "type": "number" },
+        "vacuum_multixact_freeze_min_age": { "type": "number" }, "vacuum_multixact_freeze_table_age": { "type": "number" },
+        "vacuum_failsafe_age": { "type": ["number", "null"] }, "vacuum_multixact_failsafe_age": { "type": ["number", "null"] }
+      }
+    },
+    "risk": {
+      "type": "object", "additionalProperties": false,
+      "required": ["age", "emergency_age", "failsafe_age", "pct_towards_wraparound", "pct_towards_emergency", "pct_towards_failsafe", "severity"],
+      "properties": {
+        "age": { "type": "number" }, "emergency_age": { "type": "number" }, "failsafe_age": { "type": ["number", "null"] },
+        "pct_towards_wraparound": { "type": "number" }, "pct_towards_emergency": { "type": "number" },
+        "pct_towards_failsafe": { "type": ["number", "null"] },
+        "severity": { "type": "string", "enum": ["info", "warning", "high", "critical"] }
+      }
+    },
+    "database": {
+      "type": "object", "additionalProperties": false, "required": ["database_name", "xid", "multixact"],
+      "properties": { "database_name": { "type": "string" }, "xid": { "$ref": "#/$defs/risk" }, "multixact": { "$ref": "#/$defs/risk" } }
+    },
+    "table": {
+      "type": "object", "additionalProperties": false,
+      "required": ["database_name", "schema_name", "table_name", "ranked_by", "table_size_bytes", "table_size_pretty", "xid", "multixact"],
+      "properties": {
+        "database_name": { "type": "string" }, "schema_name": { "type": "string" }, "table_name": { "type": "string" },
+        "ranked_by": { "type": "array", "items": { "type": "string", "enum": ["xid", "multixact"] } },
+        "table_size_bytes": { "type": "number" }, "table_size_pretty": { "type": "string" },
+        "xid": { "$ref": "#/$defs/risk" }, "multixact": { "$ref": "#/$defs/risk" }
+      }
+    },
+    "thresholds": {
+      "type": "object", "additionalProperties": false,
+      "required": ["wraparound_limit", "critical_age", "failsafe_high_pct", "table_limit_per_age"],
+      "properties": {
+        "wraparound_limit": { "type": "number" }, "critical_age": { "type": "number" },
+        "failsafe_high_pct": { "type": "number" }, "table_limit_per_age": { "type": "integer" }
+      }
+    },
+    "multixactSize": {
+      "type": "object", "additionalProperties": false, "required": ["bytes", "size_pretty", "status_code"],
+      "properties": {
+        "bytes": { "type": ["number", "null"] }, "size_pretty": { "type": ["string", "null"] },
+        "status_code": { "type": "integer" }
+      }
+    },
+    "data": {
+      "type": "object", "additionalProperties": false,
+      "required": ["settings", "settings_available", "databases", "tables", "multixact_size", "severity", "thresholds", "conclusions", "recommendations"],
+      "properties": {
+        "settings": { "$ref": "#/$defs/settings" }, "settings_available": { "type": "boolean" },
+        "databases": { "type": "array", "items": { "$ref": "#/$defs/database" } },
+        "tables": { "type": "array", "items": { "$ref": "#/$defs/table" } },
+        "multixact_size": { "$ref": "#/$defs/multixactSize" },
+        "severity": { "type": "string", "enum": ["info", "warning", "high", "critical"] },
+        "thresholds": { "$ref": "#/$defs/thresholds" },
+        "conclusions": { "type": "array", "items": { "type": "string" } },
+        "recommendations": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "nodeResult": {
+      "type": "object", "additionalProperties": false, "required": ["data"],
+      "properties": { "data": { "$ref": "#/$defs/data" }, "postgres_version": { "$ref": "#/$defs/postgresVersion" } }
+    }
+  }
+}

package/schemas/F003.schema.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F003 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": "F003" },
+    "checkTitle": { "const": "Autovacuum: dead tuples" },
+    "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" }
+      }
+    },
+    "deadTuplesTable": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "n_live_tup",
+        "n_dead_tup",
+        "dead_pct",
+        "last_autovacuum",
+        "last_autovacuum_epoch",
+        "last_vacuum",
+        "last_vacuum_epoch",
+        "autovacuum_count",
+        "vacuum_count",
+        "autovacuum_disabled",
+        "table_size_bytes",
+        "table_size_pretty",
+        "exceeds_dead_tuple_thresholds",
+        "autovacuum_disabled_flagged"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "n_live_tup": { "type": "number" },
+        "n_dead_tup": { "type": "number" },
+        "dead_pct": { "type": "number" },
+        "last_autovacuum": { "type": ["string", "null"] },
+        "last_autovacuum_epoch": { "type": "number" },
+        "last_vacuum": { "type": ["string", "null"] },
+        "last_vacuum_epoch": { "type": "number" },
+        "autovacuum_count": { "type": "number" },
+        "vacuum_count": { "type": "number" },
+        "autovacuum_disabled": { "type": "boolean" },
+        "table_size_bytes": { "type": "number" },
+        "table_size_pretty": { "type": "string" },
+        "exceeds_dead_tuple_thresholds": { "type": "boolean" },
+        "autovacuum_disabled_flagged": { "type": "boolean" }
+      }
+    },
+    "thresholds": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["dead_tuples_min", "dead_pct_min", "autovacuum_disabled_min_rows"],
+      "properties": {
+        "dead_tuples_min": { "type": "number" },
+        "dead_pct_min": { "type": "number" },
+        "autovacuum_disabled_min_rows": { "type": "number" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "dead_tuples_tables",
+        "total_count",
+        "flagged_count",
+        "autovacuum_disabled_count",
+        "autovacuum_disabled_flagged_count",
+        "total_dead_tuples",
+        "thresholds",
+        "conclusions",
+        "recommendations",
+        "database_size_bytes",
+        "database_size_pretty"
+      ],
+      "properties": {
+        "dead_tuples_tables": { "type": "array", "items": { "$ref": "#/$defs/deadTuplesTable" } },
+        "total_count": { "type": "integer" },
+        "flagged_count": { "type": "integer" },
+        "autovacuum_disabled_count": { "type": "integer" },
+        "autovacuum_disabled_flagged_count": { "type": "integer" },
+        "total_dead_tuples": { "type": "number" },
+        "thresholds": { "$ref": "#/$defs/thresholds" },
+        "conclusions": { "type": "array", "items": { "type": "string" } },
+        "recommendations": { "type": "array", "items": { "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/F004.schema.json

@@ -0,0 +1,125 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F004 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": "F004" },
+    "checkTitle": { "const": "Autovacuum: heap bloat (estimated)" },
+    "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" }
+      }
+    },
+    "bloatedTable": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "real_size",
+        "extra_size",
+        "extra_pct",
+        "bloat_size",
+        "bloat_pct",
+        "fillfactor",
+        "last_vacuum",
+        "last_vacuum_epoch",
+        "real_size_pretty",
+        "extra_size_pretty",
+        "bloat_size_pretty"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "real_size": { "type": "number" },
+        "extra_size": { "type": "number" },
+        "extra_pct": { "type": "number" },
+        "bloat_size": { "type": "number" },
+        "bloat_pct": { "type": "number" },
+        "fillfactor": { "type": "number" },
+        "last_vacuum": { "type": ["string", "null"] },
+        "last_vacuum_epoch": { "type": "number" },
+        "real_size_pretty": { "type": "string" },
+        "extra_size_pretty": { "type": "string" },
+        "bloat_size_pretty": { "type": "string" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bloated_tables",
+        "total_count",
+        "total_bloat_size_bytes",
+        "total_bloat_size_pretty",
+        "database_size_bytes",
+        "database_size_pretty"
+      ],
+      "properties": {
+        "status": { "$ref": "#/$defs/status" },
+        "bloated_tables": { "type": "array", "items": { "$ref": "#/$defs/bloatedTable" } },
+        "total_count": { "type": "integer" },
+        "total_bloat_size_bytes": { "type": "number" },
+        "total_bloat_size_pretty": { "type": "string" },
+        "database_size_bytes": { "type": "number" },
+        "database_size_pretty": { "type": "string" }
+      }
+    },
+    "status": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ok", "reason", "error"],
+      "properties": {
+        "ok": { "type": "boolean" },
+        "reason": {
+          "enum": [null, "missing_schema", "missing_view", "missing_grant", "query_error"]
+        },
+        "error": { "type": ["string", "null"] }
+      }
+    },
+    "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/F005.schema.json

@@ -0,0 +1,131 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F005 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": "F005" },
+    "checkTitle": { "const": "Autovacuum: index bloat (estimated)" },
+    "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" }
+      }
+    },
+    "bloatedIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "index_name",
+        "real_size",
+        "table_size",
+        "extra_size",
+        "extra_pct",
+        "bloat_size",
+        "bloat_pct",
+        "fillfactor",
+        "last_vacuum",
+        "last_vacuum_epoch",
+        "real_size_pretty",
+        "table_size_pretty",
+        "extra_size_pretty",
+        "bloat_size_pretty"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "index_name": { "type": "string" },
+        "real_size": { "type": "number" },
+        "table_size": { "type": "number" },
+        "extra_size": { "type": "number" },
+        "extra_pct": { "type": "number" },
+        "bloat_size": { "type": "number" },
+        "bloat_pct": { "type": "number" },
+        "fillfactor": { "type": "number" },
+        "last_vacuum": { "type": ["string", "null"] },
+        "last_vacuum_epoch": { "type": "number" },
+        "real_size_pretty": { "type": "string" },
+        "table_size_pretty": { "type": "string" },
+        "extra_size_pretty": { "type": "string" },
+        "bloat_size_pretty": { "type": "string" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bloated_indexes",
+        "total_count",
+        "total_bloat_size_bytes",
+        "total_bloat_size_pretty",
+        "database_size_bytes",
+        "database_size_pretty"
+      ],
+      "properties": {
+        "status": { "$ref": "#/$defs/status" },
+        "bloated_indexes": { "type": "array", "items": { "$ref": "#/$defs/bloatedIndex" } },
+        "total_count": { "type": "integer" },
+        "total_bloat_size_bytes": { "type": "number" },
+        "total_bloat_size_pretty": { "type": "string" },
+        "database_size_bytes": { "type": "number" },
+        "database_size_pretty": { "type": "string" }
+      }
+    },
+    "status": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ok", "reason", "error"],
+      "properties": {
+        "ok": { "type": "boolean" },
+        "reason": {
+          "enum": [null, "missing_schema", "missing_view", "missing_grant", "query_error"]
+        },
+        "error": { "type": ["string", "null"] }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/dbEntry" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}