README

Health checks, Kubernetes probes, Prometheus metrics, and system monitoring for Laravel.

Quick Start

composer require cboxdk/laravel-health
php artisan vendor:publish --tag="health-config"
curl http://localhost/health

Features

• Kubernetes Probes — liveness, readiness, and startup endpoints out of the box
• Prometheus Metrics — /health/metrics with health check status and system metrics
• 10 Built-in Checks — database, cache, queue, storage, Redis, environment, schedule, CPU, memory, disk space
• System Metrics — CPU load, memory, disk, network via cboxdk/system-metrics
• Container Aware — automatic cgroup detection for Docker/Kubernetes
• JSON Metrics API — structured system metrics at /health/metrics/json
• HTML Dashboard — optional real-time status UI
• Token & IP Auth — protect endpoints with bearer tokens and IP allowlists
• Response Caching — configurable TTL to reduce check overhead
• Fully Extensible — implement HealthCheck contract to add custom checks

Requirements

• PHP 8.3+
• Laravel 11.x or 12.x

Documentation

Full documentation is available in the docs/ directory.

Testing

composer test
composer analyse
composer format

Credits

• Sylvester Damgaard

License

The MIT License (MIT). Please see License File for more information.