Weave Code
Laravel Health Check Laravel Package
ans-group/laravel-health-check
A Laravel package for monitoring application health. It provides configurable checks for services such as database, cache, queue, and storage, with routes and commands to verify readiness and liveness in production.
A package for checking the health of your Laravel & Lumen applications
Frequently asked questions about Laravel Health Check
- What does ans-group/laravel-health-check do?
- It is a Laravel and Lumen package that monitors the health of your application by running configurable checks against services such as the database, cache, queue, and storage. It exposes routes for liveness and readiness probes and ships artisan commands so you can verify status from a terminal or scheduler. This makes it useful for load balancers, uptime monitors, and Kubernetes-style deployments.
- How do I install laravel-health-check with Composer?
- Run composer require ans-group/laravel-health-check and let Laravel package auto-discovery register the service provider. Then publish the configuration file with the vendor:publish command so you can enable and tune the individual checks. On v3.0.0 Composer will enforce Laravel 12+ and PHP 8.2+, so installation fails on older stacks.
- Which Laravel and PHP versions does version 3.0.0 support?
- Version 3.0.0 requires Laravel 12.0 or higher and PHP 8.2 or higher, with forward compatibility indicated for Laravel 13 and PHP 8.5. The major release drops support for older framework and PHP versions rather than adding new features. Teams on Laravel 10 or 11 must upgrade the framework first, or stay on the 2.x line.
- Can I use this package on Lumen?
- Yes, the package is described as suitable for both Laravel and Lumen applications. In Lumen you may need to register the service provider and routes manually since Lumen does not use the same auto-discovery and routing conventions as Laravel. Check that your Lumen version is compatible with the package's Laravel 12 and PHP 8.2 requirements.
- How do I configure which health checks run?
- Publish the package configuration file and enable or disable individual checks such as database, cache, queue, and storage. Each check can typically be tuned to match your environment, for example choosing which cache store or disk to probe. Keep the checks lightweight so probes stay fast when called frequently by load balancers.
- What is the difference between liveness and readiness endpoints?
- Liveness endpoints confirm the application process is running and can respond, while readiness endpoints verify that dependencies such as the database, cache, and queue are actually usable. Load balancers and orchestrators use liveness to decide whether to restart a container and readiness to decide whether to send it traffic. The package provides routes so you can wire both patterns into your infrastructure.
- Are there artisan commands for running health checks?
- Yes, the package includes console commands that let you run the checks manually or from a scheduler. This is useful for smoke tests during deployment, cron-based alerting, or debugging a failing dependency without hitting an HTTP route. You can run the commands in staging before promoting a release.
- Is upgrading to v3.0.0 a breaking change for my application?
- The release is primarily a compatibility update that drops support for older Laravel and PHP versions, with no new features or API changes indicated. The main risk is installation failure on older stacks, since Composer constraints will block the upgrade. After upgrading, verify your health endpoints in staging to confirm behavior is unchanged.
- What are alternatives if I cannot upgrade to Laravel 12 yet?
- You can remain on the 2.x line of this package while planning your framework upgrade, but note that v2.x is likely to receive limited or no further bug and security fixes. Other community health-check packages exist with broader version ranges, or you can implement a simple custom endpoint that checks the database and cache. Treat any alternative as a stopgap until you can move to a supported stack.
- Is the package actively maintained and safe for production use?
- The current v3.0.0 release tracks modern Laravel and PHP versions, which suggests active maintenance and alignment with Laravel's support policy. Health checks are lightweight and typically invoked by load balancers or monitoring systems, so they introduce no scaling concerns. As with any dependency, pin a version, review the changelog, and test endpoints after each upgrade.
Weaver
How can I help you explore Laravel packages today?