Weave Code
Health Check Bundle Laravel Package
softwax/health-check-bundle
A health check bundle for PHP applications that adds ready-to-use endpoints for monitoring service status. Define custom checks for databases, caches, and external services, then expose results for load balancers, uptime monitors, and container orchestrators.
At a glance
Frequently asked questions about Health Check Bundle
- How do I install softwax/health-check-bundle in a Laravel application?
- Install it with Composer using composer require softwax/health-check-bundle, then check whether the package ships a Laravel service provider or a framework-agnostic bridge because the bundle naming is Symfony-flavored. Inspect composer.json for Laravel and PHP constraints before assuming auto-discovery. Publish any configuration file and mount the health routes according to the package docs or service provider.
- Which Laravel and PHP versions does softwax/health-check-bundle support?
- The supplied release information does not declare a Laravel or PHP support matrix, so inspect composer.json constraints before installing. Confirm whether Laravel 10, 11, and 12 plus PHP 8.1 through 8.4 are covered if your estate needs them. Do not rely on aspirational README claims without matching Composer constraints.
- Does softwax/health-check-bundle work with Laravel 11's built-in /up health endpoint?
- Laravel 11 ships a built-in /up route, and the package's release notes do not state which routes it registers by default. Inspect the service provider and configuration to see whether default routes are enabled and whether paths are configurable. If both expose /up, disable one or namespace the package route before deploying.
- How do I create a custom health check for a database or external API?
- The package is described as supporting custom checks for databases, caches, and external services, but the release notes do not document the exact interface. Look for a check class contract or tag-based registration in the source and configuration. Implement a check that returns a status and message, then register it in the appropriate liveness or readiness group if grouping is supported.
- Can I configure the health check response format and HTTP status codes?
- The default response schema is not documented in the supplied release notes, so verify it against your existing probe contract. Check whether the configuration publishes response fields, HTTP status mapping, and JSON structure. If the schema is not configurable, wrap or adapt the endpoint before pointing load balancers at it.
- Is softwax/health-check-bundle safe to expose publicly in production?
- Health endpoints can leak dependency topology through error bodies, and the release notes do not describe authentication or IP allowlisting. Put the route behind middleware, an IP allowlist, or internal-only ingress before exposing it. Also separate liveness from deep readiness checks so a database outage does not cause an orchestrator to kill healthy pods.
- Should health checks include deep dependency probes for databases and caches?
- Deep checks are useful for readiness but risky for liveness because a partial dependency outage can cascade and restart healthy containers. Use shallow liveness checks that only confirm the PHP process responds, and reserve database, cache, and external API probes for readiness or monitoring endpoints. Confirm the package lets you tag or separate checks into those groups.
- How do I test softwax/health-check-bundle health endpoints in Laravel?
- Use Laravel's HTTP test helpers to assert the route status, JSON schema, and behavior when a check fails. Mock or fake the dependencies behind custom checks so tests do not require a live database or external API. Add a test that confirms the endpoint is not publicly reachable if you rely on middleware or IP restrictions.
- How does softwax/health-check-bundle compare to spatie/laravel-health or Laravel's built-in health route?
- Laravel 11+ includes a basic /up route, and spatie/laravel-health is an established package with documented checks and release history. SoftWax's bundle is only at 1.0.0 with a bare changelog, so treat it as a replacement decision rather than an additive one if you already have probes. Pilot it on one service and compare response contracts before migrating.
- Is softwax/health-check-bundle actively maintained and stable for production?
- The only release artifact supplied is 1.0.0 with a changelog link and no described features, backward compatibility guarantees, or migration notes. A first major release from a small vendor is a weak stability signal until the API has downstream usage. Check issue and PR latency, the license, and whether a security disclosure policy exists before adopting it widely.
Weaver
How can I help you explore Laravel packages today?