postgresai 0.16.0-rc.4 → 0.16.0

package/schemas/F009.schema.json

@@ -0,0 +1,155 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "F009 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": "F009" },
+    "checkTitle": { "const": "Xmin horizon and blockers" },
+    "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" }
+      }
+    },
+    "blocker": {
+      "type": ["object", "null"],
+      "additionalProperties": true
+    },
+    "component": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["age_tx", "count", "top_blocker"],
+      "properties": {
+        "age_tx": { "type": "number", "minimum": 0 },
+        "count": { "type": "number", "minimum": 0 },
+        "top_blocker": { "$ref": "#/$defs/blocker" }
+      }
+    },
+    "components": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "pg_stat_activity",
+        "pg_replication_slots",
+        "pg_replication_slots_catalog",
+        "pg_stat_replication",
+        "pg_prepared_xacts"
+      ],
+      "properties": {
+        "pg_stat_activity": { "$ref": "#/$defs/component" },
+        "pg_replication_slots": { "$ref": "#/$defs/component" },
+        "pg_replication_slots_catalog": { "$ref": "#/$defs/component" },
+        "pg_stat_replication": { "$ref": "#/$defs/component" },
+        "pg_prepared_xacts": { "$ref": "#/$defs/component" }
+      }
+    },
+    "dominantHolder": {
+      "type": ["object", "null"],
+      "additionalProperties": false,
+      "required": ["source", "component", "horizon_type", "age_tx", "detail"],
+      "properties": {
+        "source": { "enum": ["slot", "prepared", "activity", "replication"] },
+        "component": {
+          "enum": [
+            "pg_stat_activity",
+            "pg_replication_slots",
+            "pg_replication_slots_catalog",
+            "pg_stat_replication",
+            "pg_prepared_xacts"
+          ]
+        },
+        "horizon_type": { "enum": ["data", "catalog"] },
+        "age_tx": { "type": "number", "minimum": 0 },
+        "detail": { "type": "object", "additionalProperties": true }
+      }
+    },
+    "history": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["available", "source", "message"],
+      "properties": {
+        "available": { "const": true },
+        "source": { "type": "string" },
+        "message": { "type": "string" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "skipped",
+        "skip_reason",
+        "snapshot_xmin",
+        "data_horizon_age_tx",
+        "catalog_horizon_age_tx",
+        "autovacuum_freeze_max_age",
+        "severity",
+        "data_horizon_severity",
+        "catalog_horizon_severity",
+        "visibility",
+        "query_preview_captured",
+        "components",
+        "dominant_holder",
+        "conclusions",
+        "recommendations"
+      ],
+      "properties": {
+        "skipped": { "type": "boolean" },
+        "skip_reason": { "type": ["string", "null"] },
+        "snapshot_xmin": { "type": ["number", "null"] },
+        "data_horizon_age_tx": { "type": "number", "minimum": 0 },
+        "catalog_horizon_age_tx": { "type": "number", "minimum": 0 },
+        "autovacuum_freeze_max_age": { "type": "number", "minimum": 0 },
+        "severity": { "enum": ["OK", "NOTICE", "WARNING", "CRITICAL"] },
+        "data_horizon_severity": { "enum": ["OK", "NOTICE", "WARNING", "CRITICAL"] },
+        "catalog_horizon_severity": { "enum": ["OK", "NOTICE", "WARNING", "CRITICAL"] },
+        "visibility": { "enum": ["full", "limited"] },
+        "query_preview_captured": { "type": "boolean" },
+        "components": { "$ref": "#/$defs/components" },
+        "dominant_holder": { "$ref": "#/$defs/dominantHolder" },
+        "conclusions": { "type": "array", "items": { "type": "string" } },
+        "recommendations": { "type": "array", "items": { "type": "string" } },
+        "history": { "$ref": "#/$defs/history" }
+      }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}

package/schemas/G001.schema.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "G001 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": "G001" },
+    "checkTitle": { "const": "Memory-related 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" }
+      }
+    },
+    "estimatedTotalMemoryUsageFull": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "shared_buffers_bytes",
+        "shared_buffers_pretty",
+        "wal_buffers_bytes",
+        "wal_buffers_pretty",
+        "shared_memory_total_bytes",
+        "shared_memory_total_pretty",
+        "work_mem_per_connection_bytes",
+        "work_mem_per_connection_pretty",
+        "max_work_mem_usage_bytes",
+        "max_work_mem_usage_pretty",
+        "maintenance_work_mem_bytes",
+        "maintenance_work_mem_pretty",
+        "effective_cache_size_bytes",
+        "effective_cache_size_pretty"
+      ],
+      "properties": {
+        "shared_buffers_bytes": { "type": "number" },
+        "shared_buffers_pretty": { "type": "string" },
+        "wal_buffers_bytes": { "type": "number" },
+        "wal_buffers_pretty": { "type": "string" },
+        "shared_memory_total_bytes": { "type": "number" },
+        "shared_memory_total_pretty": { "type": "string" },
+        "work_mem_per_connection_bytes": { "type": "number" },
+        "work_mem_per_connection_pretty": { "type": "string" },
+        "max_work_mem_usage_bytes": { "type": "number" },
+        "max_work_mem_usage_pretty": { "type": "string" },
+        "maintenance_work_mem_bytes": { "type": "number" },
+        "maintenance_work_mem_pretty": { "type": "string" },
+        "effective_cache_size_bytes": { "type": "number" },
+        "effective_cache_size_pretty": { "type": "string" }
+      }
+    },
+    "estimatedTotalMemoryUsageEmpty": {
+      "type": "object",
+      "additionalProperties": false,
+      "maxProperties": 0
+    },
+    "analysis": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["estimated_total_memory_usage"],
+      "properties": {
+        "estimated_total_memory_usage": {
+          "oneOf": [
+            { "$ref": "#/$defs/estimatedTotalMemoryUsageEmpty" },
+            { "$ref": "#/$defs/estimatedTotalMemoryUsageFull" }
+          ]
+        }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["settings", "analysis"],
+      "properties": {
+        "settings": {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/setting" }
+        },
+        "analysis": { "$ref": "#/$defs/analysis" }
+      }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+

package/schemas/G003.schema.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "G003 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": "G003" },
+    "checkTitle": { "const": "Timeouts, locks, deadlocks" },
+    "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" }
+      }
+    },
+    "deadlockStats": {
+      "type": ["object", "null"],
+      "additionalProperties": false,
+      "required": ["deadlocks", "conflicts", "stats_reset"],
+      "properties": {
+        "deadlocks": { "type": "number" },
+        "conflicts": { "type": "number" },
+        "stats_reset": { "type": ["string", "null"] }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["settings", "deadlock_stats"],
+      "properties": {
+        "settings": {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/setting" }
+        },
+        "deadlock_stats": { "$ref": "#/$defs/deadlockStats" },
+        "deadlock_stats_error": { "type": "string" }
+      }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}

package/schemas/H001.schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "H001 report schema",
+  "description": "Invalid indexes report with remediation decision tree recommendations",
+  "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": "H001" },
+    "checkTitle": { "const": "Invalid 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" }
+      }
+    },
+    "invalidIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "index_name",
+        "relation_name",
+        "index_size_bytes",
+        "index_size_pretty",
+        "index_definition",
+        "supports_fk",
+        "is_pk",
+        "is_unique",
+        "constraint_name",
+        "table_row_estimate",
+        "has_valid_duplicate",
+        "valid_duplicate_name",
+        "valid_duplicate_definition"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "index_name": { "type": "string" },
+        "relation_name": { "type": "string" },
+        "index_size_bytes": { "type": "number" },
+        "index_size_pretty": { "type": "string" },
+        "index_definition": {
+          "type": "string",
+          "description": "Full CREATE INDEX statement from pg_get_indexdef()"
+        },
+        "supports_fk": { "type": "boolean" },
+        "is_pk": {
+          "type": "boolean",
+          "description": "True if this index backs a PRIMARY KEY constraint"
+        },
+        "is_unique": {
+          "type": "boolean",
+          "description": "True if this is a UNIQUE index (includes PK indexes)"
+        },
+        "constraint_name": {
+          "type": ["string", "null"],
+          "description": "Name of the constraint this index backs, or null if none"
+        },
+        "table_row_estimate": {
+          "type": "integer",
+          "description": "Estimated row count of the table from pg_class.reltuples"
+        },
+        "has_valid_duplicate": {
+          "type": "boolean",
+          "description": "True if there is a valid index on the same column(s)"
+        },
+        "valid_duplicate_name": {
+          "type": ["string", "null"],
+          "description": "Name of the valid duplicate index if one exists"
+        },
+        "valid_duplicate_definition": {
+          "type": ["string", "null"],
+          "description": "Full CREATE INDEX statement of the valid duplicate index from pg_get_indexdef()"
+        }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invalid_indexes",
+        "total_count",
+        "total_size_bytes",
+        "total_size_pretty",
+        "database_size_bytes",
+        "database_size_pretty"
+      ],
+      "properties": {
+        "invalid_indexes": { "type": "array", "items": { "$ref": "#/$defs/invalidIndex" } },
+        "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/H002.schema.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "H002 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": "H002" },
+    "checkTitle": { "const": "Unused 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" }
+      }
+    },
+    "unusedIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema_name",
+        "table_name",
+        "index_name",
+        "index_definition",
+        "reason",
+        "idx_scan",
+        "index_size_bytes",
+        "idx_is_btree",
+        "supports_fk",
+        "index_size_pretty"
+      ],
+      "properties": {
+        "schema_name": { "type": "string" },
+        "table_name": { "type": "string" },
+        "index_name": { "type": "string" },
+        "index_definition": { "type": "string" },
+        "reason": { "type": "string" },
+        "idx_scan": { "type": "number" },
+        "index_size_bytes": { "type": "number" },
+        "idx_is_btree": { "type": "boolean" },
+        "supports_fk": { "type": "boolean" },
+        "index_size_pretty": { "type": "string" }
+      }
+    },
+    "statsReset": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "stats_reset_epoch",
+        "stats_reset_time",
+        "days_since_reset",
+        "postmaster_startup_epoch",
+        "postmaster_startup_time"
+      ],
+      "properties": {
+        "stats_reset_epoch": { "type": ["number", "null"] },
+        "stats_reset_time": { "type": ["string", "null"] },
+        "days_since_reset": { "type": ["integer", "null"] },
+        "postmaster_startup_epoch": { "type": ["number", "null"] },
+        "postmaster_startup_time": { "type": ["string", "null"] },
+        "postmaster_startup_error": { "type": "string" }
+      }
+    },
+    "dbEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "unused_indexes",
+        "total_count",
+        "total_size_bytes",
+        "total_size_pretty",
+        "database_size_bytes",
+        "database_size_pretty",
+        "stats_reset"
+      ],
+      "properties": {
+        "unused_indexes": { "type": "array", "items": { "$ref": "#/$defs/unusedIndex" } },
+        "total_count": { "type": "integer" },
+        "total_size_bytes": { "type": "number" },
+        "total_size_pretty": { "type": "string" },
+        "database_size_bytes": { "type": "number" },
+        "database_size_pretty": { "type": "string" },
+        "stats_reset": { "$ref": "#/$defs/statsReset" }
+      }
+    },
+    "data": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#/$defs/dbEntry" }
+    },
+    "nodeResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["data"],
+      "properties": {
+        "data": { "$ref": "#/$defs/data" },
+        "postgres_version": { "$ref": "#/$defs/postgresVersion" }
+      }
+    }
+  }
+}
+
+