PHPackages govigilant/magento2-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/magento2-healthchecks ActiveMagento2-module[Utility & Helpers](/categories/utility) govigilant/magento2-healthchecks ================================ A Magento 2 module that exposes application health information compatible with Vigilant. 1.0.0(4mo ago)021MITPHPPHP ^8.2 Since Dec 23Pushed 4mo agoCompare [ Source](https://github.com/govigilant/magento2-healthchecks)[ Packagist](https://packagist.org/packages/govigilant/magento2-healthchecks)[ Docs](https://govigilant.io)[ RSS](/packages/govigilant-magento2-healthchecks/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (4)Versions (2)Used By (0) [ ![Banner](./art/banner.png)](https://github.com/govigilant/vigilant "Vigilant")Vigilant Magento Healthchecks ============================= [](#vigilant-magento-healthchecks) [![Analysis](https://camo.githubusercontent.com/4edb0b0f462148582283db5fca1e0e6a06a040284534abe79ff338d38d6ba110/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f676f766967696c616e742f6d6167656e746f322d6865616c7468636865636b732f616e616c7973652e796d6c3f6c6162656c3d616e616c79736973267374796c653d666c61742d737175617265)](https://github.com/govigilant/magento2-healthchecks) [![Total downloads](https://camo.githubusercontent.com/277822710a3566f62dbaa6565be51bdd3ad9aa3b41ea4530080ae6b07bb74f92/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f676f766967696c616e742f6d6167656e746f322d6865616c7468636865636b733f636f6c6f723d626c7565267374796c653d666c61742d737175617265)](https://packagist.org/packages/govigilant/magento2-healthchecks) A module that adds healthchecks to any Magento 2 application and integrates seamlessly with [Vigilant](https://github.com/govigilant/vigilant). Features -------- [](#features) This package providers an API endpoint to check the health of your Magento 2 store. It returns two types of checks, health checks and metrics. Healthchecks are checks that indicate whether a specific part of your application is functioning correctly, while metrics provide numeric values that give insights on health over time. [Vigilant](https://github.com/govigilant/vigilant) can use these metrics to notify you of spikes or quickly increasing metrics. Installation ------------ [](#installation) Install the package via Composer: ``` composer require govigilant/magento2-healthchecks ``` After installation, enable the module and run the usual Magento maintenance commands: ``` bin/magento module:enable Vigilant_MagentoHealthchecks bin/magento setup:upgrade ``` Configuration ------------- [](#configuration) Create an integration with access to the `Health Endpoint` resource in your Magento admin panel and use the access token as bearer token to access the health endpoint. You can also disable individual checks or metrics from **Stores → Configuration → General → Vigilant Healthchecks** by using the new multiselects under *Checks & Metrics*. Disabled entries are skipped entirely when the health payload is generated. Usage ----- [](#usage) ### Adding Custom Checks and Metrics [](#adding-custom-checks-and-metrics) Create checks by extending `\Vigilant\HealthChecksBase\Checks\Check` and implementing the `run()` method to return a `ResultData` instance containing the type, status, message, and any optional data payload. Metrics extend `\Vigilant\HealthChecksBase\Checks\Metric` and implement `measure()` to return a `MetricData` object with a numeric value and unit. Register your implementations by wiring them into `Vigilant\MagentoHealthchecks\HealthCheckRegistry` inside your module's `etc/di.xml`: ``` Vendor\Module\Checks\MyCustomCheck Vendor\Module\Checks\Metrics\MyCustomMetric ``` ### Accessing the Health Endpoint [](#accessing-the-health-endpoint) Once installed, the health check endpoint is available with your configured bearer token at: ``` POST /rest/V1/vigilant/health ``` Or using `curl`: ``` curl -X POST "YOUR_URL_HERE/rest/V1/vigilant/health" \ -H "Authorization: Bearer YOUR_BEARER_TOKEN" \ -H "Content-Type: application/json" ``` Available Checks ---------------- [](#available-checks) CheckDescription**CacheCheck**Performs a write/read/delete probe against the configured cache backend to verify it stores data correctly.**SearchEngineCheck**Connects to the configured Elasticsearch/OpenSearch cluster and reports its cluster health status.**DatabaseCheck**Runs a lightweight query to ensure the primary Magento database connection is reachable.**MessageQueueCheck**Validates AMQP connections when configured or falls back to inspecting the database queue tables for failures.**CronCheck**Ensures the cron heartbeat has been updated within the configured time window, indicating cron is running.**RedisCheck**Discovers Redis-backed caches/sessions from deployment config and pings each server to confirm connectivity.**DebugModeCheck**Warns when the application is running in developer mode to avoid leaking sensitive debug output in production.Available Metrics ----------------- [](#available-metrics) MetricDescription**MemoryUsageMetric**Reports overall system memory usage percentage to track saturation.**CpuLoadMetric**Captures the current CPU load average to highlight processor spikes.**DiskUsageMetric**Measures disk space consumption of the configured filesystem.**IndexerMetric (invalid)**Counts indexers currently marked as invalid and awaiting reindex.**IndexerMetric (working)**Counts indexers that are actively running.**IndexerMetric (valid)**Counts indexers that are up-to-date and valid.**IndexerWorkingMinutesMetric**Tracks the longest-running indexer by reporting its time in the working state in minutes.Development Environment ----------------------- [](#development-environment) A ready-to-use Docker-based development environment lives in `devenv/`. Ensure Docker is running, then start the stack: `docker compose -f devenv/docker-compose.yml up --build`. This will create a Magento 2 application on port `8080` with this module installed. Access the Magento admin panel at `http://localhost:8080/admin` (default credentials: `admin` / `Admin123!`). Quality ------- [](#quality) Run the quality checks: ``` 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 35 — LowBetter than 80% of packages Maintenance75 Regular maintenance activity Popularity3 Limited adoption so far Community7 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 140d 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 magentohealthchecksvigilant ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/govigilant-magento2-healthchecks/health.svg) ``` [![Health](https://phpackages.com/badges/govigilant-magento2-healthchecks/health.svg)](https://phpackages.com/packages/govigilant-magento2-healthchecks) ``` ### Alternatives [yireo/magento2-webp2 Magento 2 module to add WebP support to the Magento frontend 2091.2M7](/packages/yireo-magento2-webp2)[yireo/magento2-googletagmanager2 Add Google Tag Manager to Magento 167930.4k5](/packages/yireo-magento2-googletagmanager2)[opengento/module-gdpr Gdpr Compliance Module for Magento 2 14481.5k](/packages/opengento-module-gdpr)[run-as-root/magento2-prometheus-exporter Magento2 Prometheus Exporter 69344.4k](/packages/run-as-root-magento2-prometheus-exporter)[yireo/magento2-extensionchecker Scan the code of a Magento module 96151.6k3](/packages/yireo-magento2-extensionchecker)[baldwin/magento2-module-less-js-compiler Allows Magento 2 to compile less files using the less nodejs compiler 2348.6k](/packages/baldwin-magento2-module-less-js-compiler) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)