inpvlsa / magento-clockwork
inpvlsa/magento-clockwork
Development tool for Magento 2 with timeline, database queries, cache, templates, and more. Built on Clockwork.
⚙️ Clockwork for Magento 2
A powerful development tool that brings advanced debugging and profiling capabilities to Magento 2.
Track timeline events, database queries, cache operations, template rendering, and more - all through an intuitive interface built on ⚙️ Clockwork.
🚀 Key Features
- Comprehensive Timeline: View and filter all page events by type or text
- Interactive Toolbar: Quick access to debugging tools
- Detailed Profiling: Track a wide range of timeline events:
- Routing processes
- Layout rendering
- Event dispatching
- Observer execution
- Collection loading
- Database Monitoring
- SQL query inspection with syntax highlighting
- Sort, search, and analyze database operations
- Template Insights: Track template rendering performance
- Cache Inspection: Monitor cache operations with identifiers, data, tags, and TTL
- Request Analysis: Examine Magento-specific and HTTP request data
- Search Integration: Track all OpenSearch/ElasticSearch queries and responses
- AJAX Support: Monitor all HTTP requests in the frontend area
📋 Requirements
- PHP 7.4+
- Magento 2 (Community Edition)
- Tested on versions:
- 2.4.3 (PHP 7.4, with 3rd party extensions)
- 2.4.6 (PHP 8.1, Hyva, 3rd party extensions)
- 2.4.7 (PHP 8.3, clean installation)
Note: Minimum tested Magento version is 2.4.3. Enterprise Edition compatibility not yet verified.
📦 Installation
# Recommended for development environments only
composer require inpvlsa/magento-clockwork --dev
# For dev/stage environments (see Authentication section)
composer require inpvlsa/magento-clockwork
You are free now to install it to non-local instances (with no
--dev), check the Authentication section. But I strongly recommend not adding packages to production environments and use--devflag.
⚙️ Configuration
Enable the module and turn on Clockwork writing mode:
php bin/magento module:enable Inpvlsa_Clockwork
php bin/magento config:set dev/clockwork/enabled 1
Storage options
By default, data is stored in files. You can change the storage method:
- Via admin panel: Stores → Advanced → Developer → Clockwork
- Or using CLI:
php bin/magento config:set dev/clockwork/data_storage file|redis
Redis Configuration Note
- Pre-set configuration of Redis storage requires Magento session storage to be configured for Redis
- The module retrieves Redis connection data from Magento deployment config if not a "custom" redis credential is set in module configuration tab
- Check logs after switching to Redis - errors will cause fallback to file storage
For detailed Redis configuration, see Redis Documentation.
🔐 Authentication
Authentication is automatically configured for local development environments.
If you can't access the /clockwork URL, add your IP to the maintenance mode whitelist.
For detailed authentication options, see Authentication Documentation.
🧩 Usage
- Navigate to
/clockworkfrom your Magento root URL - Explore timeline events grouped by type
- Use text filters to search specific information
- Utilize the button on the right of the search input for additional sorting options
- Explore logs, database queries, cache operations, collections tab, enjoy!
📸 Feature Showcase
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.1.3 | stable | Fail | Magento 2.4.7-2.4.9 Details | 2025-06-11 11:46:22 |
| 1.1.2 | stable | Not tested | Not yet tested Details | 2025-04-30 13:00:50 |
| 1.1.1 | stable | Not tested | Not yet tested Details | 2025-03-28 18:17:05 |
| 1.1.0 | stable | Not tested | Not yet tested Details | 2025-03-27 18:05:51 |
| 1.0.3 | stable | Not tested | Not yet tested Details | 2025-03-25 23:50:42 |
| 1.0.2 | stable | Not tested | Not yet tested Details | 2025-03-24 20:24:47 |
| 1.0.1 | stable | Not tested | Not yet tested Details | 2025-03-23 22:33:12 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2025-03-23 22:04:11 |
Requires 3
| Package | Constraint |
|---|---|
| php | ^7.4||^8.1||^8.2||^8.3||^8.4 |
| magento/framework | ^101.0.0 || ^102.0.0 || ^103.0.0 |
| itsgoingd/clockwork | ^5.3 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — 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 | 78 | 2 errors, 76 warnings (ruleset: Magento2) — 6 auto-fixable with phpcbf |
| PHPMD | Warning | 13 | 13 rule violations (UnusedFormalParameter:12, EmptyCatchBlock:1) |
| Cpd | Pass | 0 | |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
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
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.