Namespace healthChecks

Comprehensive health check utilities for system component monitoring.

Collection of health check functions that monitor critical system components including database connectivity, cache performance, memory usage, and overall system health. Designed for use with container orchestration systems (Kubernetes readiness/liveness probes) and monitoring infrastructure. Each check returns standardized health status information with timestamps and relevant metrics.

healthChecks

Example

// Check overall system health (Kubernetes readiness probe)
const systemHealth = await healthChecks.system();
if (systemHealth.status === 'healthy') {
  console.log('All systems operational');
}

Example

// Individual component health checks
const dbHealth = await healthChecks.database();
const cacheHealth = await healthChecks.cache();
const memoryHealth = await healthChecks.memory();

Example

// Use in health check endpoint
app.get('/health', async (req, res) => {
  const health = await healthChecks.system();
  const statusCode = health.status === 'healthy' ? 200 : 503;
  res.status(statusCode).json(health);
});

Functions

database
cache
memory
system

Namespace healthChecks

Example

Example

Example

Functions

Settings

On This Page