Weave Code
Laravel Health Checker Laravel Package
arquivei/laravel-health-checker
Laravel Health Checker by Arquivei adds ready-to-use health check endpoints to your Laravel app, so you can monitor critical dependencies like database, cache, queue, and storage. Ideal for uptime checks, load balancers, and container orchestration probes.
Laravel Health Checker
Frequently asked questions about Laravel Health Checker
- What is arquivei/laravel-health-checker used for?
- It is a Laravel package by Arquivei that adds ready-to-use health check endpoints to your application. Those endpoints report on critical dependencies such as the database, cache, queue, and storage, so uptime monitors, load balancers, and container orchestration probes can tell whether the app is healthy. It is meant for operational liveness and readiness checks rather than business logic.
- How do I install arquivei/laravel-health-checker?
- Install it with Composer using composer require arquivei/laravel-health-checker. Laravel package auto-discovery should register the service provider in most setups; if your application disables discovery, register the provider manually in config/app.php. After installing, request the health route to confirm it responds. Confirm the exact route path and any required configuration against the package README, since documentation was not included in the material reviewed.
- Which Laravel and PHP versions does version 4.0.4 support?
- The material reviewed did not include a dependency manifest, so the exact Laravel and PHP constraints for 4.0.4 are unconfirmed. Check the require block in the package composer.json and compare it against your application's locked versions before adopting it. Verify compatibility against the specific Laravel minor version you run in production, not just the major, and confirm the CI matrix covers it.
- What health checks does it provide out of the box?
- It ships ready-to-use checks for the dependencies most Laravel applications rely on: database, cache, queue, and storage. That gives you a single endpoint that fails when a backing service is unreachable. You can typically extend or restrict the set of checks to match your own infrastructure.
- Can I use it for Kubernetes liveness and readiness probes or load balancer checks?
- Point the probe at the package health endpoint and treat a non-2xx response as unhealthy. That gives Kubernetes, ECS, or an ELB a single URL to poll instead of custom scripts per service. Keep probe timeouts and check latency in mind, since probes that hit the database or queue add load on every interval.
- Does the package require database migrations or published config files?
- That detail could not be verified from the material provided for version 4.0.4. Before integrating, check the README and package source for publishable config or asset tags and for any migrations. If it only registers routes and a service provider, integration stays lightweight.
- How do I test the health check endpoint in my test suite?
- Make a request to the endpoint in a feature test and assert the expected status code. For failure paths, point the check at a broken connection or mock the underlying service so the endpoint reports unhealthy. Keeping a test around the endpoint protects you during future upgrades.
- Does the health endpoint expose sensitive information?
- Health endpoints typically reveal which dependencies are up or down, and detailed output can disclose hostnames or connection details. Review the response payload before exposing the route publicly, and restrict it to internal networks or authenticated access where appropriate. IP allowlisting or rate limiting in front of the route is a reasonable safeguard.
- What changed in version 4.0 and how do I upgrade from 3.x?
- The 4.0.4 release reviewed shipped with an empty changelog and no upgrade guide was available in the material, so breaking changes across the 4.x line are unconfirmed. If you already run a 3.x version, read the diff between tags or open an issue asking for release notes before scheduling the upgrade. For net-new adoption, treat it as a timeboxed evaluation rather than a committed migration.
- Is arquivei/laravel-health-checker actively maintained, and what are the alternatives?
- Maintenance activity was not verifiable from the material reviewed, so check the repository for commit cadence, contributor concentration, and open-issue response times before depending on it. Alternatives include Spatie's laravel-health or a small custom controller that checks each dependency. Given the undocumented 4.x release, weigh the cost of adopting a package against a few dozen lines of in-house checks.
Weaver
How can I help you explore Laravel packages today?