@radzor/health-check

Health check endpoint with dependency monitoring. Register dependencies (databases, APIs, caches), run periodic checks, and expose a unified health report. Zero dependencies.

v0.1.0typescriptpythonServerhealthmonitoringuptimedependencyreadinesslivenessby Radzor

Install

View source on GitHub →

$npx radzor@latest add health-check

⚠ Constraints: Each dependency check is wrapped in a timeout — a check that takes longer than `timeout` ms is considered failed. The checker function must return a Promise<boolean>. The auto-check interval timer is unref'd and won't keep the process alive.

Inputs

Name	Type	Default	Description
intervalMs	number	30000	Interval in ms between automatic health checks.
timeout	number	5000	Timeout in ms for each individual dependency check.
historySize	number	100	Number of historical check results to retain per dependency.

intervalMsnumber

Interval in ms between automatic health checks.

default: 30000

timeoutnumber

Timeout in ms for each individual dependency check.

default: 5000

historySizenumber

{ "llm": { "constraints": "Each dependency check is wrapped in a timeout — a check that takes longer than `timeout` ms is considered failed. The checker function must return a Promise<boolean>. The auto-check interval timer is unref'd and won't keep the process alive.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/health-check", "tags": [ "health", "monitoring", "uptime", "dependency", "readiness", "liveness" ], "events": [ { "name": "onHealthy", "payload": { "status": "string", "checkedAt": "number" }, "description": "Fired when all dependencies are healthy." }, { "name": "onUnhealthy", "payload": { "status": "string", "checkedAt": "number", "failedDependencies": "string[]" }, "description": "Fired when one or more dependencies are unhealthy." } ], "inputs": [ { "name": "intervalMs", "type": "number", "default": 30000, "required": false, "description": "Interval in ms between automatic health checks." }, { "name": "timeout", "type": "number", "default": 5000, "required": false, "description": "Timeout in ms for each individual dependency check." }, { "name": "historySize", "type": "number", "default": 100, "required": false, "description": "Number of historical check results to retain per dependency." } ], "radzor": "1.0.0", "actions": [ { "name": "check", "params": [], "returns": "Promise<HealthReport>", "description": "Run all dependency health checks and return the aggregated report." }, { "name": "registerDependency", "params": [ { "name": "name", "type": "string", "description": "Unique name for the dependency (e.g. 'postgres', 'redis', 'stripe-api')." }, { "name": "checker", "type": "() => Promise<boolean>", "description": "Async function that returns true if the dependency is healthy." }, { "name": "critical", "type": "boolean", "required": false, "description": "If true, a failure makes the overall status 'unhealthy'. If false, status is 'degraded'." } ], "returns": "void", "description": "Register a dependency with its health check function." }, { "name": "removeDependency", "params": [ { "name": "name", "type": "string", "description": "Name of the dependency to remove." } ], "returns": "void", "description": "Unregister a dependency." }, { "name": "getHistory", "params": [ { "name": "name", "type": "string", "description": "Dependency name to get history for." } ], "returns": "DependencyCheckResult[]", "description": "Get the historical check results for a specific dependency." } ], "outputs": [ { "name": "healthReport", "type": "HealthReport", "fields": [ { "name": "status", "type": "'healthy' | 'degraded' | 'unhealthy'", "description": "Overall system health status." }, { "name": "dependencies", "type": "DependencyReport[]", "description": "Per-dependency health details." }, { "name": "checkedAt", "type": "number", "description": "Timestamp of the health check." }, { "name": "uptimeMs", "type": "number", "description": "Process uptime in ms." } ], "description": "Aggregated health status of all registered dependencies." } ], "runtime": "server", "version": "0.1.0", "category": "monitoring", "languages": [ "typescript", "python" ], "description": "Health check endpoint with dependency monitoring. Register dependencies (databases, APIs, caches), run periodic checks, and expose a unified health report. Zero dependencies.", "dependencies": { "radzor": [], "packages": {} }, "composability": { "connectsTo": [ { "event": "onUnhealthy", "description": "Alert when service dependencies are unhealthy", "compatibleWith": [ "@radzor/notification-hub.action.send.body", "@radzor/slack-bot.action.sendMessage.text", "@radzor/email-send.action.send.message" ] }, { "output": "healthReport", "mapField": "status", "compatibleWith": [ "@radzor/log-aggregator.action.info.message" ] } ] } }

@radzor/health-check

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json