home / skills / proxiblue / claude-skills / magento-diagnostic

magento-diagnostic skill

/magento-diagnostic

This skill performs a comprehensive Magento 2 diagnostic to reveal system health, performance metrics, and actionable remediation guidance.

npx playbooks add skill proxiblue/claude-skills --skill magento-diagnostic

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.0 KB
---
name: magento-diagnostic
description: Comprehensive Magento 2 system diagnostic skill that gathers cache status, index status, module information, configuration, logs, and performance metrics for rapid troubleshooting.
---

This skill automates comprehensive Magento 2 system diagnostics for troubleshooting and performance analysis.

## What This Skill Does

1. **System Status Check**
   - Deploy mode (developer/production/default)
   - Magento version information
   - PHP version and extensions
   - Database connection and version
   - File system permissions

2. **Cache Analysis**
   - Cache type status (enabled/disabled)
   - Cache backend configuration (Redis/File/Database)
   - Full Page Cache (FPC) status and backend
   - Cache hit/miss rates (if available)
   - Cache invalidation history

3. **Index Status**
   - All indexer status and mode (Update on Save/Schedule)
   - Index backlog and last update times
   - Index lock status
   - Changelog table sizes
   - Indexer performance metrics

4. **Module Information**
   - Enabled/disabled modules list
   - Module version information
   - Module dependencies and conflicts
   - Custom vs vendor modules
   - Recently updated modules

5. **Configuration Analysis**
   - Critical system configurations
   - Performance-related settings
   - Security configurations
   - Multi-store setup details
   - Third-party integration status

6. **Log Analysis**
   - Recent error log entries (var/log/system.log)
   - Exception log review (var/log/exception.log)
   - Debug log analysis (if enabled)
   - Web server error logs
   - Database slow query logs

7. **Performance Metrics**
   - Current system resource usage
   - Queue status and backlog
   - Cron job status and schedule
   - Recent cron execution logs
   - Database table sizes

## Bash Commands Used

```bash
bin/magento deploy:mode:show
bin/magento cache:status
bin/magento indexer:status
bin/magento module:status
bin/magento config:show
bin/magento cron:list
bin/magento queue:consumers:list
tail -n 100 var/log/system.log
tail -n 100 var/log/exception.log
```

## MCP Integration

Leverages:
- **magento2-dev MCP**: Magento-specific commands
- **database MCP**: Database query analysis
- **filesystem**: Log file reading

## Output

The skill provides:
- **Executive Summary**: High-level system health status
- **Critical Issues**: Immediate problems requiring attention
- **Warnings**: Potential issues to monitor
- **Performance Report**: System performance metrics
- **Recommendations**: Prioritized action items

## Report Format

1. **Health Score**: Overall system health (0-100)
2. **Issue Classification**:
   - 🔴 Critical: Immediate action required
   - 🟡 Warning: Monitor and plan resolution
   - 🟢 Info: System operating normally
3. **Detailed Findings**: Per-category analysis
4. **Action Plan**: Prioritized remediation steps

## When to Use

- Initial issue investigation
- Performance troubleshooting
- Before/after deployment validation
- Regular health check monitoring
- Customer-reported issues
- Proactive system maintenance
- Pre-upgrade assessment

Overview

This skill performs a comprehensive Magento 2 system diagnostic to speed up troubleshooting and performance tuning. It collects cache and indexer status, module and configuration data, logs, and runtime performance metrics and presents a concise health report. The output highlights critical issues, warnings, and prioritized remediation steps for rapid action.

How this skill works

The skill runs Magento CLI commands and reads key log and database sources to extract system state: deploy mode, versioning, cache backends, indexer modes, module lists, cron and queue status, and recent log entries. It correlates findings into an executive summary, computes a health score, classifies issues by severity, and generates a prioritized action plan. Optional integrations allow deeper database and filesystem analysis for slow queries, table sizes, and log parsing.

When to use it

  • Investigating a sudden site outage or critical errors
  • Diagnosing performance degradation or slow page loads
  • Validating system health before or after a deployment
  • Routine health checks and proactive maintenance
  • Preparing for Magento upgrades or major module changes

Best practices

  • Run diagnostics from the Magento application user with correct file permissions
  • Collect reports before and after changes to compare state and impact
  • Enable relevant logs (debug only when needed) to avoid noise and performance impact
  • Schedule regular checks and archive reports for trend analysis
  • Address critical issues first (cron, cron queues, indexer locks, cache misconfiguration)

Example use cases

  • Customer reports slow catalog pages: gather cache hit/miss, FPC backend, indexer backlog, and recent exceptions
  • Post-deploy validation: confirm deploy mode, module versions, cron executions, and no new error log entries
  • Pre-upgrade audit: export module list, custom vs vendor modules, DB version, and table sizes to assess upgrade readiness
  • Regular maintenance run: health score, warnings for configuration drift, and a prioritized action plan for the week

FAQ

How long does a full diagnostic take?

Typical runs complete in a few seconds to a couple of minutes depending on log sizes and database responsiveness.

Can this run on production safely?

Yes, diagnostics are read-only when run with standard Magento CLI commands and log reads. Avoid enabling verbose debug logging in production while diagnosing.