Weave Code
Laravel Health Check Laravel Package
ukfast/laravel-health-check
Laravel health check package that exposes a configurable endpoint for monitoring app health. Run checks on database, cache, queue, storage, Redis and custom services, returning JSON output and proper HTTP status codes for load balancers, Kubernetes probes and uptime monitors.
A package for checking the health of your Laravel & Lumen applications
Frequently asked questions about Laravel Health Check
- What is ukfast/laravel-health-check and what does it do?
- It is a Composer package for Laravel and Lumen applications that exposes a health check endpoint for monitoring. The endpoint runs configurable checks against services such as the database, cache, queue, storage and Redis, plus any custom checks you register, then returns a JSON payload with an appropriate HTTP status code. That makes it directly consumable by load balancers, Kubernetes liveness and readiness probes, uptime monitors and deploy gates.
- How do I install ukfast/laravel-health-check in a Laravel app?
- Install it with Composer, publish the configuration file, and register the route or command that serves the health endpoint. There are no database migrations, queue workers, auth changes or external service contracts to set up, so the integration surface is shallow. The real effort is usually meeting the PHP 8.2+ and Laravel 12+ requirement of v3, not wiring up the package itself.
- Which Laravel and PHP versions does version 3.x support?
- v3.0.0 supports Laravel 12.x and 13.x and PHP 8.2 through 8.5. It explicitly drops Laravel 11 and below and PHP 8.1 and below, deliberately mirroring Laravel's own policy of supporting only versions that still receive bug and security fixes. Applications that must stay on older Laravel or PHP need to remain pinned to the 2.x line.
- Can I use ukfast/laravel-health-check on Laravel 10 or Laravel 11?
- Not with v3.x, which requires Laravel 12 or 13 and PHP 8.2+. You would need to stay on the 2.x branch, and you should confirm in writing how long that branch continues to receive security fixes before depending on it. The blocker is your platform version, not the complexity of the package itself.
- How do I add a custom health check?
- Custom checks let you extend the endpoint beyond the built-in database, cache, queue, storage and Redis checks. You define your own check class and register it in the published configuration so the endpoint reports your service status alongside the shipped checks. Keep custom checks fast and side-effect free, because they run on every probe request.
- What does the health check endpoint return and which HTTP status codes does it use?
- The endpoint returns a JSON body describing the result of each configured check, plus HTTP status codes that reflect overall health so load balancers and orchestrators can act without parsing the body. Integrators that parse the JSON should confirm the response shape against a real response when upgrading, since a major version bump can change defaults even when the changelog shows no functional delta. Never assume the shape is unchanged just because the release is described as platform support only.
- Is it suitable for Kubernetes liveness and readiness probes or load balancer health checks?
- Yes, that is the primary use case: a lightweight HTTP endpoint returning JSON and correct status codes for orchestrator probes and target group health checks. Because it sits in the operational control plane, treat any change to the route path, check timeouts or status codes as high blast radius for every deploy. Validate probe behaviour in staging before rolling an upgrade to production.
- Does it work with Lumen?
- The package is described as supporting both Laravel and Lumen applications. Lumen uses a slimmer bootstrap, so route and configuration registration differ slightly from a full Laravel install. Check the README for the Lumen-specific registration steps before adding it to a Lumen service.
- Does the package work with config:cache, Laravel Octane or a read-only container filesystem?
- Those are common production constraints for an infrastructure package, but they are not addressed in the v3.0.0 release notes. Because a major bump that touches composer.json can still alter autoloading, service-provider registration or default config, verify with a diff rather than relying on the changelog. Test with config:cache enabled, under Octane and on a read-only filesystem before promoting the upgrade.
- Is ukfast/laravel-health-check actively maintained, and what changed in v3.0.0?
- v3.0.0 is a platform-support release: no new checks, no new endpoint features and no documented configuration additions. Its real impact is the new floor of Laravel 12+ and PHP 8.2+, so the maintainer's supported-version policy is the most important fact about the release. It is a single-vendor package on the critical deploy path, so pin the version and review release notes carefully before upgrading.
Weaver
How can I help you explore Laravel packages today?