Stratum DevHealthCheck

A Magento 2 CLI module that runs a colour-coded, sectioned health check of your environment and deployment configuration, and scores overall system health on a 0–100 scale.

╔════════════════════════════════════════╗
║   Magento Environment Health Check    ║
╚════════════════════════════════════════╝

[PHP]
    ✓  PHP Version          8.3.4
    ✓  PHP Extensions       all required extensions loaded
    –  OPcache              opcache_get_configuration() not available (CLI SAPI restriction)

[Deploy & Mode]
    ✓  Deploy Mode          production
    ✓  Maintenance Mode     disabled
    ✓  Static Assets        12 locale/theme directories deployed
    ✓  Generated Code       present and non-empty

[Filesystem]
    ✓  Writable Directories  var, pub/media, pub/static, generated
    ⚠  env.php Permissions   permissions 644 — world-readable
    ✓  Disk Space            48.2GB free of 500.0GB (96%)

[Database]
    ✓  DB Connection         connected
    ✓  DB Version            MySQL 8.0.36
    ✓  Pending Upgrades      all modules up to date

[Cache]
    ✓  Cache Types           all 12 types enabled
    ✓  Cache Backend         Redis (Cm_Cache_Backend_Redis)
    ✓  Redis Connectivity    connected to 127.0.0.1:6379

[Indexers]
    ✓  Indexer Status        all 11 indexers valid
    –  Indexer Mode          mode check only relevant in production

[Environment]
    ✓  Crypt Key             present
    ⚠  Base URL              http://localhost/
    ⚠  Admin URL             /backend
    –  Cookie Security       cookie security check only relevant in production
    –  HTTPS Redirect        HTTPS check only relevant in production

[Cron]
    ✓  Cron Last Run         last run 2 minutes ago
    ✓  Cron Error Jobs       no errors in last 60 minutes
    ✓  Cron Backlog          0 stale pending jobs
    ✓  Stuck Cron Jobs       no stuck jobs detected
    ✓  Duplicate Cron Entries no duplicate scheduled entries

[Search]
    ✓  Search Engine         elasticsearch8
    ✓  Search Connectivity   connected to 127.0.0.1:9200 (elasticsearch8)

[Security]
    ✓  .git in Webroot       .git/ not inside pub/
    ✓  PHP Info Files        no phpinfo files found in pub/
    ✗  Two-Factor Auth       Magento_TwoFactorAuth is disabled
    –  Webroot Location      document root not available from CLI
    ✓  Log Dir Exposure      var/log and var/report outside pub/

[Performance]
    –  Asset Minification    minification check only relevant in production
    ⚠  Flat Catalog          flat tables disabled for: products, categories
    ✓  Module Count          142 enabled modules
    ✓  MySQL Query Cache      query cache removed in MySQL 8 (no action needed)
    ✓  Full Page Cache       Varnish

[Logging]
    ✓  Exception Log         0.1MB — last modified 142 minutes ago
    ✓  Error Reports         0 error report files
    –  Debug Logging         log level check only relevant in production

[Storage]
    ✓  Media Size            2.4GB
    ✓  Var Directory Size    0.8GB

[Config Integrity]
    ✓  config.php Sync       all 142 modules present in config.php
    ✓  Store Code in URL     disabled

[Extensions]
    ✓  Class Rewrites        8 <preference> rewrites
    ✓  Duplicate Modules     no identity conflicts between app/code/ and vendor/

[Infrastructure]
    ✓  RequireJS Config      24 RequireJS config file(s) deployed
    ✓  Session Backend       Redis

────────────────────────────────────────────
  Summary:  35 OK  |  4 WARN  |  1 FAIL  |  7 SKIP
  Score:    82/100  Grade: B
────────────────────────────────────────────

Requirements

• Magento 2.4.x
• PHP 8.2+

Installation

Via Composer:

composer require stratum-tech/module-dev-healthcheck
bin/magento module:enable Stratum_DevHealthCheck
bin/magento setup:upgrade

Manual:

# Copy to app/code/Stratum/DevHealthCheck, then:
bin/magento module:enable Stratum_DevHealthCheck
bin/magento setup:upgrade

Usage

# Run all checks
bin/magento dev:healthcheck

# Run a single section
bin/magento dev:healthcheck --section="Security"

# Show detail messages (verbose)
bin/magento dev:healthcheck -v

# JSON output
bin/magento dev:healthcheck --format=json

# Exit with code 2 if any WARNs exist (useful in CI)
bin/magento dev:healthcheck --fail-on-warn

Exit codes

Scoring

Every check contributes to a weighted 0–100 health score. Sections have different weights based on their impact on production stability and security:

Points are split equally among checks within each section. SKIP checks are excluded entirely and do not affect the score. WARN results earn 50% of their available points; FAIL earns 0%.

Checks

Adding a custom check

1. Create a class implementing Stratum\DevHealthCheck\Model\Check\CheckInterface
2. Register it in your module's di.xml:

<type name="Stratum\DevHealthCheck\Model\HealthCheckRunner">
    <arguments>
        <argument name="checks" xsi:type="array">
            <item name="myCheck" xsi:type="object">Vendor\Module\Model\Check\MyCheck</item>
        </argument>
    </arguments>
</type>

License

MIT — see LICENSE