Weave Code
Laravel Health Check Laravel Package
letsgoi/laravel-health-check
A Laravel package for adding configurable health checks and a status endpoint to your app. Monitor database, cache, storage, queue, and custom checks, returning JSON for uptime and readiness probes.
At a glance
Frequently asked questions about Laravel Health Check
- What can I monitor with letsgoi/laravel-health-check?
- The package is built for configurable Laravel health checks covering database, cache, storage, queue, and custom checks. It exposes a status endpoint that returns JSON for uptime and readiness probes. You can use it to verify that core application dependencies are reachable and behaving as expected.
- How do I install letsgoi/laravel-health-check in a Laravel app?
- Install it with Composer using composer require letsgoi/laravel-health-check, then follow the README to publish any configuration and register the status endpoint. For version 4.0.0, confirm your application is on Laravel 12 before adopting it. Laravel 10 applications should pin to the latest 3.x release instead.
- How do I configure which health checks run and where the status endpoint is exposed?
- The package is designed around configurable checks, so you define which database, cache, storage, queue, or custom checks should run and expose them through a status endpoint. Publish the package configuration and review the README for the available check options and endpoint settings. Validate the generated JSON in a non-production environment before enabling it on production probes.
- Does letsgoi/laravel-health-check support Laravel 11 and Laravel 12?
- Version 4.0.0 aligns with the Laravel 12 component line, so it is the intended choice for Laravel 12 applications. The changelog does not clearly confirm whether Laravel 11 remains supported, so treat Laravel 11 adoption as conditional until you verify it. Laravel 10 support was removed in 4.0.0.
- Will upgrading letsgoi/laravel-health-check to 4.0.0 break my Laravel 10 application?
- Yes, version 4.0.0 drops Laravel 10 support, so a Laravel 10 application should not adopt it without first upgrading Laravel. Pin to the latest 3.x release or upgrade the host application to Laravel 12 before moving to 4.x. Also check PHP and Illuminate constraints, and run regression tests because the changelog may not list all runtime changes.
- How should I test the health check endpoint before production?
- Run the package's checks against your target Laravel version and hit the status endpoint in a staging environment. Verify the JSON response for healthy and unhealthy scenarios by simulating database, cache, storage, or queue failures. Add this coverage to your integration test suite and confirm the endpoint does not expose sensitive configuration details.
- Is letsgoi/laravel-health-check suitable for Kubernetes readiness and liveness probes?
- It is intended for JSON uptime and readiness probes, which fits Kubernetes readiness checks. Use liveness probes carefully: they should confirm the process is alive rather than depend on every downstream service. Configure checks and timeouts so a slow database or queue does not cause unnecessary pod restarts.
- Can I add custom health checks for external services?
- Yes, the package supports custom checks in addition to built-in database, cache, storage, and queue checks. Use custom checks to verify third-party APIs, internal services, or application-specific invariants. Keep custom checks fast and side-effect free so the status endpoint remains reliable for probes.
- What are alternatives to letsgoi/laravel-health-check?
- Alternatives include Laravel's built-in health route and other Laravel health-check packages, depending on the check coverage and JSON format you need. Compare Laravel version support, maintenance activity, custom check support, and probe-friendly output before choosing. If you need database, cache, storage, queue, and custom checks in one endpoint, evaluate this package against those requirements.
- Is letsgoi/laravel-health-check 3.x still maintained and security-patched?
- The provided changelog does not state how long 3.x will remain maintained or receive security patches after 4.0.0. Because 4.0.0 removes Laravel 10 support, teams staying on Laravel 10 should pin 3.x and confirm the maintenance policy with the maintainer. Track the repository releases and plan a dated exit from 3.x.
Weaver
How can I help you explore Laravel packages today?