Performance Review CLI for Magento 2

Performance Review CLI for Magento 2

Run a full performance health check on any Magento 2 installation in under a minute. This n98-magerun2 plugin analyses 11 performance categories and produces a colour-coded, prioritised report with actionable recommendations — no external SaaS, no data leaves your server.

Usage

# Full audit
n98-magerun2.phar performance:review

# Single category
n98-magerun2.phar performance:review --category=database

# Save full report to file
n98-magerun2.phar performance:review --details --output-file=report.txt

# Skip a specific analyser
n98-magerun2.phar performance:review --skip-analyzer=redis

11 Analysis Categories

Category	What It Checks
config	Application mode, cache backend type, JS/CSS minification, session storage
database	DB size (warns at 20/50 GB), large tables, URL rewrite bloat, log table sizes
modules	Third-party module count, known performance-affecting extensions, disabled modules
codebase	Generated content, var/ cleanup, core file modifications, unoptimised media
frontend	JS/CSS/HTML optimisation, WebP image usage, lazy loading, active theme count
indexing	Indexer status, cron health, stuck index jobs, message queue processing
php	PHP version (recommends 8.1+), memory limit (2 GB min / 4 GB recommended), OPcache configuration, required extensions
mysql	MySQL/MariaDB version, InnoDB buffer pool size, query cache status, slow query log
redis	Redis detection, database separation (cache vs. sessions), compression, phpredis vs. Predis
api	Active API integrations, OAuth token count, async API configuration, rate limiting
thirdparty	Known problematic extensions, development tools in production, security flags

CI/CD Integration

The tool returns machine-readable exit codes — pipe it into your deployment pipeline:

• Exit 0 — no high-priority issues found
• Exit 1 — one or more high-priority issues require attention

Custom Analysers

Extend the tool by implementing AnalyzerCheckInterface and registering via n98-magerun2.yaml. A gold-standard example (UnusedIndexAnalyzer with 21 unit tests) is included as a reference implementation.

Installation

# Clone into the n98-magerun2 modules directory:
mkdir -p ~/.n98-magerun2/modules
git clone https://github.com/magendooro/n98-magerun2-performance-review \
  ~/.n98-magerun2/modules/performance-review

# Verify the command is available:
n98-magerun2.phar list performance

Requirements

• n98-magerun2 v7.0.0 or higher
• Magento 2.3.x – 2.4.7, Mage-OS, or Adobe Commerce
• PHP 7.4+ (PHP 8.1+ recommended)
• 2 GB server memory minimum

License: MIT  |  View on GitHub

Compatibility & Installation

• n98-magerun2: v7.0.0 or higher
• Magento: 2.3.x – 2.4.7 (incl. Mage-OS and Adobe Commerce)
• PHP: 7.4+ (8.1+ recommended)
• License: MIT

mkdir -p ~/.n98-magerun2/modules
git clone https://github.com/magendooro/n98-magerun2-performance-review \
  ~/.n98-magerun2/modules/performance-review

GitHub repository

Key Features

• Full performance audit of a Magento 2, Mage-OS, or Adobe Commerce installation in under a minute — 11 analysis categories spanning configuration, database, modules, codebase, frontend, indexing & cron, PHP, MySQL, Redis, API, and third-party extensions
• Colour-coded, prioritised report (high / medium / low) with current vs. recommended values
• Flexible runs: --category, --skip-analyzer, --details, --output-file, --no-color, --list-analyzers
• CI/CD-ready exit codes — 0 when clean, 1 when high-priority issues are found
• Custom analysers without touching the core module: implement AnalyzerCheckInterface, register in n98-magerun2.yaml
• Bundled example analysers: UnusedIndexAnalyzer (21 unit tests), RedisMemoryAnalyzer, ElasticsearchHealthAnalyzer
• Runs entirely on your server — no SaaS, no data leaves the machine

Last updated: November 2025 · be1d07b