Weave Code
Statamic Healthchecks Laravel Package
govigilant/statamic-healthchecks
Statamic Healthchecks adds health monitoring to your Statamic site, running configurable checks for app, database, cache, storage, and more so you can spot issues early from a clear dashboard.
A Statamic addon to integrate healthchecks to your application which are compatible with Vigilant
Frequently asked questions about Statamic Healthchecks
- How do I install statamic-healthchecks in a Laravel Statamic app?
- Install the add-on with Composer using govigilant/statamic-healthchecks, then follow the add-on registration and configuration publishing steps from the repository. You should review the exact service provider and route registration behavior for your Statamic version before deploying. Validate the healthcheck endpoint in staging before wiring it into production monitoring.
- Does statamic-healthchecks support Statamic 6 and Laravel?
- Release 1.1.0 explicitly adds Statamic 6 support, making it the version to evaluate for teams standardizing on the latest Statamic major. The exact Laravel and PHP version constraints should be confirmed from the package composer.json and changelog before upgrading. Pin versions and document the supported matrix for each application.
- What health checks are included in this Statamic healthchecks addon?
- The add-on runs configurable checks for the application, database, cache, storage, and additional checks described in the package overview. You should review the published configuration to see the full list and determine which checks can be customized or disabled. Avoid putting expensive dependency checks in the critical path of frequently called probes.
- Is the healthcheck endpoint public or should it be protected?
- The package exposes healthcheck routes that can be used by uptime monitors, load balancers, or Kubernetes probes, but the authentication model and intended exposure should be confirmed before production use. Many teams restrict the endpoint to internal monitoring networks or protect it with middleware. Avoid accidentally exposing detailed dependency status publicly.
- Should I use version 1.0.x for Statamic 5 or upgrade to 1.1.0?
- Version 1.1.0 is primarily a compatibility update that targets Statamic 6, while 1.0.x may remain relevant for Statamic 5 applications. Confirm the supported version matrix and changelog before choosing a release line. For Statamic 5 to 6 upgrades, update Statamic, Laravel, and PHP dependencies first, then adopt the add-on version that matches.
- How do I configure healthchecks for monitoring and alerting?
- Publish the add-on configuration and define which checks should run, then point your monitoring system at the healthcheck endpoint. Confirm the exact response contract, status codes, and timeout expectations so alerts are reliable. Update probes and alerting rules after any package or Statamic upgrade.
- Can I customize or disable individual health checks?
- The add-on is described as using configurable checks, so you should review the published configuration for enable, disable, and customization options. Confirm which checks are safe to run on every request and which should be reserved for less frequent monitoring. This is especially important if downstream services are slow or unreliable.
- How should I test statamic-healthchecks before production deployment?
- Install and configure the add-on in a staging environment that matches your target Statamic, Laravel, and PHP versions. Verify route registration, authentication behavior, response format, and each enabled health check. Then roll out to a canary or low-risk application first and keep rollback instructions and the previous Composer lock state available.
- What are the alternatives to statamic-healthchecks for Laravel apps?
- This add-on is specifically suited to Laravel applications using Statamic, while non-Statamic Laravel apps may need a different healthcheck package. Evaluate alternatives based on whether you need Statamic-aware checks, Vigilant compatibility, and Statamic 6 support. Compare endpoint security, response contracts, and maintenance activity before choosing.
- What maintenance and upgrade risks come with statamic-healthchecks?
- The package is small and release 1.1.0 is mainly a compatibility update, so ongoing maintenance is likely low. The main risks are version mismatch boot failures, route conflicts, changed service-provider behavior, and false negatives from dependency checks. Track Statamic and Laravel major releases, pin Composer versions where necessary, and review the changelog before upgrading.
Weaver
How can I help you explore Laravel packages today?