Download the PHP package govigilant/drupal-healthchecks without Composer
On this page you can find all versions of the php package govigilant/drupal-healthchecks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download govigilant/drupal-healthchecks
More information about govigilant/drupal-healthchecks
Files in govigilant/drupal-healthchecks
Package drupal-healthchecks
Short Description A Drupal module that exposes Vigilant-compatible health information.
License MIT
Homepage https://govigilant.io
Informations about the package drupal-healthchecks
Vigilant Drupal Healthchecks
A package that adds healthchecks to any Drupal application and integrates seamlessly with Vigilant.
Installation
Install the module with Composer:
Enable the module via the Drupal UI or with Drush:
Configure the bearer token and thresholds at Configuration → System → Vigilant Healthchecks once the module is enabled.
Usage
Accessing the health endpoint
After configuring a bearer token, the health payload is available at:
Example curl request:
Available Checks
| Check | Description |
|---|---|
| DatabaseCheck | Executes a lightweight query to confirm the default database connection responds. |
| CacheCheck | Writes and reads a payload using the cache backend to ensure it can store, retrieve, and delete items. |
| QueueCheck | Pushes a probe job through Drupal's queue backend to verify processing behavior and report backlog snapshots. |
| CronCheck | Ensures Drupal cron has executed within the configurable threshold stored in vigilant_healthchecks.settings. |
| SecurityUpdatesCheck | Uses the Update Manager data to flag projects with outstanding security advisories. |
Available Metrics
| Metric | Description |
|---|---|
| CacheEfficiencyMetric | Aggregates hit/miss ratios for the cache bins listed in vigilant_healthchecks.settings. |
| ErrorLogMetric | Counts watchdog error entries recorded within the configurable rolling window. |
Extending
You can register your own health checks or metrics by tagging services with vigilant_healthchecks.check or vigilant_healthchecks.metric.
- Create a class that extends
Vigilant\HealthChecksBase\Checks\Check(orMetric) and implementrun()/measure()plusavailable(). - Define the service in
MODULE.services.ymland add the appropriate tag. - Inject any dependencies as usual; the
HealthCheckRegistryautomatically discovers tagged services.
Development Environment
A ready-to-use Docker Compose setup lives in devenv/.
Start the stack: docker compose -f devenv/docker-compose.yml up --build.
This provisions Drupal 11 with MariaDB, installs this module automatically, and exposes the site on http://localhost:8000. The default admin credentials are admin / secret and the bearer token is preset to testing.
Stop everything with docker compose -f devenv/docker-compose.yml down -v when you're done.
Quality
Run the quality checks locally:
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Vincent Boon
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of drupal-healthchecks with dependencies
drupal/core Version ^10.2 || ^11.0
govigilant/vigilant-healthchecks-base Version ^1.1