README

Vigilant Magento Healthchecks

A module that adds healthchecks to any Magento 2 application and integrates seamlessly with Vigilant.

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 can use these metrics to notify you of spikes or quickly increasing metrics.

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

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

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:

<type name="Vigilant\MagentoHealthchecks\HealthCheckRegistry">
    <arguments>
        <argument name="checks" xsi:type="array">
            <item name="my_custom_check" xsi:type="object">Vendor\Module\Checks\MyCustomCheck</item>
        </argument>
        <argument name="metrics" xsi:type="array">
            <item name="my_custom_metric" xsi:type="object">Vendor\Module\Checks\Metrics\MyCustomMetric</item>
        </argument>
    </arguments>
</type>

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 Metrics

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

Run the quality checks:

composer quality

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.