PHPackages                             govigilant/drupal-healthchecks - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. govigilant/drupal-healthchecks

ActiveDrupal-module[Utility & Helpers](/categories/utility)

govigilant/drupal-healthchecks
==============================

A Drupal module that exposes Vigilant-compatible health information.

1.0.0(4mo ago)00MITPHPPHP ^8.2CI passing

Since Dec 26Pushed 4mo agoCompare

[ Source](https://github.com/govigilant/drupal-healthchecks)[ Packagist](https://packagist.org/packages/govigilant/drupal-healthchecks)[ Docs](https://govigilant.io)[ RSS](/packages/govigilant-drupal-healthchecks/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (5)Versions (2)Used By (0)

[ ![Banner](./art/banner.png)](https://github.com/govigilant/vigilant "Vigilant")Vigilant Drupal Healthchecks
============================

[](#vigilant-drupal-healthchecks)

 [![Tests](https://camo.githubusercontent.com/756159b5b1fe1af20ccfddeaacad761f13f912352fd7eb39a5ee16874e7f555b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f676f766967696c616e742f64727570616c2d6865616c7468636865636b732f74657374732e796d6c3f6c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/govigilant/drupal-healthchecks) [![Analysis](https://camo.githubusercontent.com/7531d0bcbd00551cea3b9369d41f42deb54925ac760d92a3fecceea5c305eee5/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f676f766967696c616e742f64727570616c2d6865616c7468636865636b732f616e616c7973652e796d6c3f6c6162656c3d616e616c79736973267374796c653d666c61742d737175617265)](https://github.com/govigilant/drupal-healthchecks) [![Total downloads](https://camo.githubusercontent.com/867c45e5e9b7d5f04fb9d7d4aaec56d13274975ccc9a499e55f28e913fa67f14/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f676f766967696c616e742f64727570616c2d6865616c7468636865636b733f636f6c6f723d626c7565267374796c653d666c61742d737175617265)](https://packagist.org/packages/govigilant/drupal-healthchecks)

A package that adds healthchecks to any Drupal application and integrates seamlessly with [Vigilant](https://github.com/govigilant/vigilant).

Installation
------------

[](#installation)

Install the module with Composer:

```
composer require govigilant/drupal-healthchecks
```

Enable the module via the Drupal UI or with Drush:

```
drush en vigilant_healthchecks -y && drush cr
```

Configure the bearer token and thresholds at **Configuration → System → Vigilant Healthchecks** once the module is enabled.

Usage
-----

[](#usage)

### Accessing the health endpoint

[](#accessing-the-health-endpoint)

After configuring a bearer token, the health payload is available at:

```
POST /vigilant/health

```

Example curl request:

```
curl -X POST "https://your-drupal-site.test/vigilant/health" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

Available Checks
----------------

[](#available-checks)

CheckDescription**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
-----------------

[](#available-metrics)

MetricDescription**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
---------

[](#extending)

You can register your own health checks or metrics by tagging services with `vigilant_healthchecks.check` or `vigilant_healthchecks.metric`.

1. Create a class that extends `Vigilant\HealthChecksBase\Checks\Check` (or `Metric`) and implement `run()`/`measure()` plus `available()`.
2. Define the service in `MODULE.services.yml` and add the appropriate tag.
3. Inject any dependencies as usual; the `HealthCheckRegistry` automatically discovers tagged services.

```
services:
  my_module.check.custom_backend:
    class: Drupal\my_module\Checks\CustomBackendCheck
    arguments:
      - '@my.service'
    tags:
      - { name: vigilant_healthchecks.check }
```

Development Environment
-----------------------

[](#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 . 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
-------

[](#quality)

Run the quality checks locally:

```
composer quality
```

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Vincent Boon](https://github.com/VincentBean)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE) for more information.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance75

Regular maintenance activity

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

136d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f21e3a721fc25c880371c5d3af4925fe83e4b9d425bf50a2cbce18ee1af45931?d=identicon)[vincentbean](/maintainers/vincentbean)

---

Top Contributors

[![VincentBean](https://avatars.githubusercontent.com/u/3906942?v=4)](https://github.com/VincentBean "VincentBean (4 commits)")

---

Tags

drupalhealthchecksvigilant

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/govigilant-drupal-healthchecks/health.svg)

```
[![Health](https://phpackages.com/badges/govigilant-drupal-healthchecks/health.svg)](https://phpackages.com/packages/govigilant-drupal-healthchecks)
```

###  Alternatives

[tripal/tripal

Tripal is a toolkit to facilitate construction of online genomic, genetic (and other biological) websites.

709.9k9](/packages/tripal-tripal)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)