Weave Code
Laravel Healthcheck Laravel Package
chocofamilyme/laravel-healthcheck
A Laravel package that adds healthcheck endpoints so monitoring systems can verify your app and its dependencies are up. Reports on services such as database, cache, and queue, making it easy to integrate with uptime checks and alerting tools.
At a glance
Frequently asked questions about Laravel Healthcheck
- What is chocofamilyme/laravel-healthcheck and what does it do?
- It is a Laravel package that adds healthcheck endpoints so monitoring systems can verify your application and its dependencies are running. It reports on services such as the database, cache, and queue, which makes it easy to wire into uptime checks and alerting tools. It installs through Composer like any other Laravel package.
- How do I install chocofamilyme/laravel-healthcheck in a Laravel app?
- Install it with Composer, using the ^4.0 constraint if you are on Laravel 10, then confirm package discovery registered the service provider. Publish any config the package ships, set the services you want reported, and request the healthcheck endpoint to confirm it responds. Do the first install in a branch and run your test suite before merging.
- Does this package support Laravel 10?
- Yes, release 4.0.0 explicitly adds Laravel 10 support, so it is positioned for Laravel 10 projects. Check the composer.json constraints to confirm the PHP floor and whether Laravel 9 or earlier is still allowed. If you are not yet on Laravel 10, verify compatibility in a branch or stay on the 3.x line.
- Which dependencies does the healthcheck actually check?
- The package reports on services such as the database, cache, and queue, which are the failure points monitoring systems usually care about most. Whether each check is enabled by default and how it is configured should be confirmed against the repository config and README. Keep the checks you enable focused on what your alerting actually needs.
- How do I configure the healthcheck endpoint and routes?
- Typically you publish the package config, choose the services to report, and then point your monitor at the exposed endpoint. Because the README excerpt was not available in this evaluation, review the repository for the exact route path, middleware, and config keys before rolling it out. Consider restricting the route by middleware or IP allowlist if it is publicly reachable.
- Is version 4.0.0 a breaking change from version 3?
- 4.0.0 is a major version bump, and the release notes only mention Laravel 10 support, so treat it as potentially breaking until proven otherwise. Review the changelog and the composer.json diff for dropped Laravel or PHP versions, dependency changes, and API or config changes. Branch, upgrade, and run static analysis and integration tests before adopting it.
- What PHP version does chocofamilyme/laravel-healthcheck require?
- Laravel 10 itself requires PHP 8.1 or higher, so a package supporting Laravel 10 will normally sit at or above that baseline. The package's own constraint should be verified in composer.json rather than assumed. If you run Laravel 9 or earlier, the PHP floor may differ, so confirm against the version you plan to use.
- How do I integrate it with uptime monitoring and alerting tools?
- Expose the healthcheck endpoint and configure your uptime tool to poll it on a schedule, alerting when the response is not a healthy status. The package's per-service reporting lets you distinguish an app outage from a database, cache, or queue failure. Keep the endpoint lightweight so frequent polling does not itself add load.
- What should I watch out for in production?
- Pin the package version and avoid floating major constraints unless CI covers compatibility, since 4.x is a major release with limited upgrade documentation. Make sure the endpoint does not expose sensitive infrastructure details publicly, and confirm the checks you enable do not run heavy queries or jobs on every poll. Review release cadence and issue-tracker activity so you know how quickly fixes land.
- How do I test the healthcheck endpoint in my Laravel test suite?
- Write a feature test that requests the endpoint and asserts the expected healthy response, then simulate failures by breaking a dependency such as the cache or queue connection. This gives you confidence that alerts fire for the right reasons instead of only confirming the happy path. Add the test to CI so future upgrades of the package cannot silently change behaviour.
Weaver
How can I help you explore Laravel packages today?