Panth Error Monitor
Records PHP exceptions and storefront JavaScript errors in Magento 2 database tables and groups repeats into one row with a counter. The daily summary email stays off until you switch it on and add a recipient.
- Free
composer require mage2kishan/module-error-monitor
- Package requirementsRead the source documentation
- Developer profileView Upwork profile
- Themes listedCheck the selected release
- PHP versions listedCheck the selected release
- Installation questionsDiscuss your store setup
What it does for your store
The main features, as listed in the module documentation.
-
PHP errors from the system logger
A Monolog handler stores log records at or above the severity you choose, with class, file, line and stack trace.
-
Storefront JavaScript errors
A deferred plain script reports uncaught errors and unhandled promise rejections and works under a strict Content-Security-Policy.
-
Grouping by fingerprint
Numbers, IDs, URLs and paths are replaced before hashing, so near-identical errors land in one group with a counter.
-
Noise filters
Bot traffic, browser extension errors and known third-party noise are dropped by default, plus your own ignore list.
-
Daily summary email
One email per UTC day, sent by cron, listing groups seen in the last 24 hours above a severity threshold.
-
Privacy and retention
Client IPs are stored anonymised by default, sensitive query values are redacted, and old events are deleted daily.
Installation
Example commands from the Magento root. Follow the package instructions and your staging and deployment process.
- 1Check the releaseMatch Magento, PHP, theme and dependency requirements.
- 2Install on stagingReview Composer changes and follow the package instructions.
- 3Configure and verifyUse the documented settings and test the affected features.
$ composer require mage2kishan/module-error-monitor $ bin/magento setup:upgrade $ bin/magento setup:di:compile $ bin/magento setup:static-content:deploy -f $ bin/magento cache:clean
Listed requirements
These are the details supplied in this listing. Confirm the selected release supports your Magento edition, PHP and storefront.
| Composer package | mage2kishan/module-error-monitor |
|---|
Documentation
Product details and setup guidance. Check the package repository for release-specific instructions.
Errors stored inside Magento
Panth Error Monitor records PHP exceptions and storefront JavaScript errors in database tables inside Magento. Each error is reduced to a fingerprint, so repeats of the same problem become one group with a counter, first seen and last seen times. Errors stay in your Magento database; the module does not send them to any third-party service.
What it captures
- PHP: a Monolog handler on the Magento system logger stores records at or above a minimum severity (default Error), from web requests, cron, CLI and API calls.
- JavaScript: a deferred, non-inline collector reports uncaught errors and unhandled promise rejections. It works under a strict Content-Security-Policy, with a sample rate, per-IP and global limits and a body size cap.
- Repeats within a coalesce window (default 60 seconds) cost one database write per group.
Less noise
- Bot and crawler User-Agents, browser extension errors, private-mode storage errors and client-safe GraphQL errors are filtered by default. The filter lists are editable.
- An ignore list of message substrings, and an optional IP or network filter.
- Capture pauses during maintenance mode and for 5 minutes after a deploy is detected.
Reviewing errors
An admin grid lists error groups with keyword search, filters, export and Resolve, Ignore and Delete actions. The detail page shows the most frequent URLs and the stored occurrences with stack traces.
Summary email
When Send Email Alerts is on and a recipient is set, cron sends one summary per UTC day after the hour you choose. It lists groups with occurrences in the last 24 hours, sorted by count, up to 50 groups. Mail is never sent during the request that recorded the error.
Privacy and retention
- Client IPs are stored with the last IPv4 octet or the last 80 bits of an IPv6 address removed. Storing the IP can be switched off.
- Query values with names such as token, password, email or phone are replaced with "redacted".
- Events are kept 30 days and resolved groups 90 days by default.
- Behind Cloudflare or another proxy, list its ranges under Trusted Proxy IPs / Networks. The list is empty by default.
Requirements
- Magento Open Source or Adobe Commerce 2.4.4 to 2.4.8.
- PHP 8.1, 8.2, 8.3 or 8.4.
- mage2kishan/module-core, installed by Composer.
- Magento cron for the summary email and cleanup, and working mail for the email.
Free and open source under the MIT License.
Developer notes
- Module
Panth_ErrorMonitor, PHP namespacePanth\ErrorMonitor. It loads afterPanth_Core,Magento_Store,Magento_Config,Magento_Backend,Magento_Cron,Magento_EmailandMagento_Ui. - Custom code can record an error by building a
Service\ErrorPayload(source, severity, type, message, file, line, stackTrace, url, referer, userAgent, ip, httpMethod, context, storeId) and callingService\ErrorRecorder::record(). It filters, fingerprints, throttles and stores the error and returns the group ID, or null when nothing was stored. Model\ErrorGroupconstants:STATUS_NEW0,STATUS_RESOLVED1,STATUS_IGNORED2,SOURCE_PHP,SOURCE_JS. Event prefixes:panth_error_groupandpanth_error_event.- Cron jobs:
panth_errormonitor_dispatch_notificationsandpanth_errormonitor_cleanup. - After an upgrade that changes the fingerprint rules, the admin notice from
Model\System\Message\RefingerprintPendingstays while the flagpanth_errormonitor_refingerprint_pendingis set. Apanth:errormonitor:refingerprintrun without--dry-runclears it. - Console commands:
panth:errormonitor:status(--reset-auto-detect),pause(--minutesor-m, default 60),resume,cleanup,send-summary(--dry-run),refingerprint(--dry-run) andregroup(deprecated, runsrefingerprint). - Routes: admin
panth_errormonitor, and frontendpanth_errormonitorfor the JavaScript collectorJs/Collect. - ACL resources:
Panth_ErrorMonitor::errors,Panth_ErrorMonitor::view,Panth_ErrorMonitor::manage,Panth_ErrorMonitor::configandPanth_ErrorMonitor::system_config. - Database tables:
panth_error_group(one row per fingerprint),panth_error_event(occurrences, with a cascading foreign key to the group),panth_error_group_hourly(hourly counts, removed after 35 days by the cleanup cron),panth_error_rate_limit(collector counters) andpanth_error_filter_hourly(hourly counts per filter reason). - Flags in the
flagtable:panth_errormonitor_capture_paused_until,panth_errormonitor_autopause_until,panth_errormonitor_deploy_mtimesand onepanth_errormonitor_summary_<date>per emailed day. - Email template:
panth_errormonitor_alert_template(view/frontend/email/error_alert.html), area frontend.
Questions before you install?
Send me your composer.json and I will check for conflicts first. Free. Installation is +$45, custom work is quoted first.