Weave Code
Healthcheck Laravel Package
zanichelli/healthcheck
A configurable health-check endpoint for Laravel applications. It runs registered checks and returns a clear JSON status, helping load balancers, uptime monitors, and deployment tools verify that your service and its dependencies are healthy.
zanichelli/healthcheck adds a configurable health-check endpoint to your Laravel application, letting load balancers, uptime monitors and orchestrators verify that the app and its dependencies are actually healthy. Checks are registered through configuration and resolved from Laravel's container, keeping setup minimal and idiomatic.
- Ready-to-use HTTP endpoint with correct 200/503 status codes
- Pluggable checks for database, cache, queue and custom services
- Config-driven, container-aware check registration
- Structured JSON responses for monitoring tools
- Native Laravel integration with simple configuration
Frequently asked questions about Healthcheck
- How do I install zanichelli/healthcheck in a Laravel app?
- Install it with Composer using composer require zanichelli/healthcheck, then follow the package setup to publish configuration and register the healthcheck route. The assessment describes this as a standard Composer, config publish, and route registration flow. After that, choose middleware for public, internal-only, or token-gated access. Verify the package Composer constraints against your Laravel and PHP 8.x baseline before pinning.
- Which services can the Laravel healthcheck check?
- The package is described as exposing diagnostic checks for critical services such as the database, cache, storage, and queues. That makes it useful as a readiness probe target for dependency failures. The exact checks enabled by default and whether outbound HTTP is included should be confirmed in the package configuration. Map each dependency failure to a non-200 response if you rely on it for routing decisions.
- Does zanichelli/healthcheck support separate liveness and readiness endpoints?
- The overview mentions configurable endpoints, but it does not explicitly document separate liveness and readiness routes. Treat that as a verification item: confirm whether you can register distinct paths or must derive readiness from the single health payload. For Kubernetes, liveness should answer whether the process is alive, while readiness should answer whether dependencies are usable. If the package cannot separate them, put a small route or middleware wrapper in front.
- What does the healthcheck endpoint return, and can I hide sensitive metadata?
- The assessment warns that a health endpoint may echo environment, driver, build, or version metadata, which is useful for fingerprinting. It does not confirm a built-in filter for a bare status ok body. Audit the response in staging before exposing the route beyond the cluster. If the package does not offer response filtering, wrap the route or customize the controller so production returns only the minimum status payload.
- Is zanichelli/healthcheck safe to expose in production?
- Do not expose it publicly without review. Health endpoints are common reconnaissance targets, and the assessment flags possible information disclosure plus per-request dependency load under frequent probing. Restrict the route with middleware, network policy, or a token, and confirm the response body is minimal. Also check whether a light or cached mode exists for high-frequency probes.
- How do I test the healthcheck route in Laravel?
- Add a feature test that calls the route and asserts the expected HTTP status and payload for both healthy and failing dependencies. Mock or disable each dependency check so you can force database, cache, storage, and queue failures independently. Because the package has zero Packagist dependents, your own integration coverage is the main safety net. Include an assertion that production filtering does not leak metadata.
- What are the Laravel and PHP version requirements?
- The technical assessment positions the package for Laravel applications on a supported PHP 8.x line, but it does not list exact Laravel version constraints. Check the package composer.json on Packagist or GitHub before adopting it, and test against your current Laravel baseline. If the constraints do not intersect cleanly, vendor a fork or choose a maintained alternative.
- Who maintains zanichelli/healthcheck, and what is the license?
- It is published by ZanichelliEditore, and the assessment describes the license as MIT, which is permissive and allows forking or vendoring. The project has low public adoption, with 4 stars and zero Packagist dependents, so there is no broad ecosystem evidence of maintenance or compatibility. There is no stated maintenance commitment in the assessment, and a future-dated release is a metadata flag to reconcile. Plan for the possibility that you may need to maintain a fork.
- What are alternatives to a custom Laravel healthcheck route?
- Alternatives include Laravel's built-in /up endpoint in recent versions, Spatie's laravel-health package, or a small custom route that checks only the dependencies you care about. The right choice depends on whether you need separate liveness and readiness semantics, response filtering, and integration with your existing probes. zanichelli/healthcheck is narrow and removable, so it is reasonable to trial it behind a feature flag and compare responses with your incumbent route.
- How should I roll out a new healthcheck package without breaking Kubernetes probes?
- Run the package endpoint on a distinct path behind a feature flag for at least one release cycle, then diff its responses against your existing health route. Keep the old route active until the new one proves stable, and cut the Kubernetes probe over with a one-line configuration change so rollback is trivial. Use the parallel period to complete the security review of the response body and access controls. Retire the legacy route only after the new probe has been observed in production.
Weaver
How can I help you explore Laravel packages today?