cboxdk/laravel-health

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

dev-main 2026-03-03 11:18 UTC

Requires

• php: ^8.3
• cboxdk/system-metrics: ^2.1
• illuminate/contracts: ^11.0|^12.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.8
• orchestra/testbench: ^10.0||^9.0
• pestphp/pest: ^4.0
• pestphp/pest-plugin-arch: ^4.0
• pestphp/pest-plugin-laravel: ^4.0
• phpstan/extension-installer: ^1.4
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0

MIT

• Sylvester Damgaard

• monitoring
• Metrics
• health
• laravel
• kubernetes
• prometheus
• health-check
• cbox

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
• 11 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.