Checks and adapters

​

CheckConfig

Each check is a CheckConfig entry in the checks array on the root config:

​

AdapterResult

Each adapter.check() resolves to:

• status: "ok" | "degraded" | "fail".
• error: Optional Error or string (included in the serialized check unless output.exposeError is false).
• metadata: Optional object merged into the check result.

Thrown errors from adapter.check() are treated as fail, with the error message captured when exposeError is true.

​

Official adapters

This monorepo publishes optional packages that return a HealthAdapter for common infrastructure: queues, databases, storage, search, and HTTP endpoints. For anything else, use a custom adapter.check() implementation.

​

Queues

• RabbitMQ — @healthzkit/rabbitmq
• Kafka — @healthzkit/kafka

​

Databases

• Redis — @healthzkit/redis
• Valkey — @healthzkit/valkey
• Postgres — @healthzkit/postgres
• CockroachDB — @healthzkit/cockroach
• MySQL — @healthzkit/mysql
• MongoDB — @healthzkit/mongo
• SQLite — @healthzkit/sqlite
• DynamoDB — @healthzkit/dynamo
• Drizzle ORM — @healthzkit/drizzle
• Prisma — @healthzkit/prisma

​

Storage

• S3 — @healthzkit/s3
• MinIO — @healthzkit/minio

​

Search

• Elasticsearch — @healthzkit/elasticsearch

​

HTTP

• HTTP endpoints — @healthzkit/http