Function system

Returns Promise<
    {
        status: string;
        components: {
            database: | {
                status: string;
                latency: number;
                timestamp: string;
                error?: undefined;
            }
            | {
                latency?: undefined;
                status: string;
                error: string;
                timestamp: string;
            };
            cache: { status: string; stats: CacheStats; timestamp: string };
            memory: {
                status: string;
                usage: { heapUsedMB: number; heapTotalMB: number; externalMB: number };
                timestamp: string;
            };
        };
        uptime: number;
        timestamp: string;
    },
>

Comprehensive system health status

const systemHealth = await healthChecks.system();
console.log(`System status: ${systemHealth.status}`);
console.log(`Uptime: ${systemHealth.uptime} seconds`);
console.log('Component status:', systemHealth.components);
Copy

// Use for Kubernetes readiness probe
app.get('/ready', async (req, res) => {
  const health = await healthChecks.system();
  const statusCode = health.status === 'healthy' ? 200 : 503;
  res.status(statusCode).json(health);
});
Copy