# integer-net/magento2-health-check

> Magento 2 Health Check

`composer require integer-net/magento2-health-check`

Canonical URL: https://packagento.com/integer-net/magento2-health-check

## At a glance

- **Vendor**: integer-net (https://packagento.com/integer-net.md)
- **Latest version**: 1.1.0 — released 2025-11-18
- **Pricing**: Free
- **Package type**: Magento 2 component
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/integer-net/magento2-health-check and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require integer-net/magento2-health-check:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento 2 Health Check

## README

### Installation

#### Using composer

When this package is installed into a Magento 2 project (with the default `magento/magento-composer-installer` plugin present), it will auto install the required files into the `pub/` directory of Magento 2

```
composer require integer-net/magento2-health-check
```

#### Manual

Copy the file `src/health_check.php` into your Magento 2 directory into `pub/` (replace the original `health_check.php` from Magento 2)

### Configuration

The health check can be configured by creating the file `pub/check/config.php`. All configuration options can be found in the provided default configuration, which will be installed into `pub/check/config.dist.php`.
When a `config.php` is present, it will be loaded instead of the `config.dist.php`.

The contents of the file should look like this:
```php
<?php

declare(strict_types=1);

use IntegerNet\Healthcheck\Configuration;

return (new Configuration)
    // Default timezone: Europe/Berlin
    // ->setTimezone('Antarctica/Troll')
    // Default output format: Configuration::FORMAT_PLAIN
    // Available output formats: Configuration::FORMAT_JSON & Configuration::FORMAT_PLAIN
    // ->setOutputFormat(Configuration::FORMAT_JSON)
    ->testProductionMode(/* enabled: true */)
    ->testDatabaseConnections(/* enabled: true, connections: ['default', 'erp'] */)
    ->testCacheAvailability(/* enabled: true, caches: ['configuration', 'full_page'] */)
    ->testIndexerTriggersExist(/* enabled: true, indexers: ['catalogsearch_fulltext', 'catalogrule_rule'] */)
    ->testCronjobsAreRunning(/* enabled: true, */ groups: [
        ['group' => 'index', 'maxOffset' => 5], // 'maxOffset' in minutes since last run
        ['group' => 'default', 'maxOffset' => 5],
        ['group' => 'consumers', 'maxOffset' => 5],
    ])
;
```

See `config.dist.php` for a list of all possible configurations and their parameters

#### Output format

Allowed formats: `plain`, `json`

The default output format can be changed by using the method `setOutputFormat` in the configuration file (`pub/check/config.php`) or by setting the environment variable `HEALTHCHECK_OUTPUT_FORMAT`.

Example usage:
```shell
HEALTHCHECK_OUTPUT_FORMAT=plain php pub/health_check.php
```

### Supported checks

- Production mode is set
- Database availability
- Cache backend availability (if backend is not 'file')
- Indexer triggers exist in database
- Cronjobs are running (per group)
- Search backend/engine availability
- Queue backend availability (if amqp is used)

## Recent Versions

| Version | Released |
|---|---|
| 1.1.0 | 2025-11-18 |
| 1.0.0 | 2025-06-26 |
| 1.0.0-rc2 | 2025-06-26 |
| 1.0.0-rc1 | 2025-06-26 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/magento-composer-installer | * |
| php | ~8.1.0 \|\| ~8.2.0 \|\| ~8.3.0 \|\| ~8.4.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| ergebnis/composer-normalize | * |

## Quality

Latest release (1.1.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | not tested |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 66 | 21 errors, 45 warnings (ruleset: Magento2) — 8 auto-fixable with phpcbf |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 12 | 12 | – | – |
| 2.4.8 | – | 12 | 12 | – |
| 2.4.9 | – | – | 12 | N/A |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["integer-net/magento2-health-check"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

integer-net is a Magento 2 vendor on Packagento. See https://packagento.com/integer-net.md for their full catalogue.