Skip to content

A Magento 2 module which captures JavaScript errors for later review by website administrators.

Notifications You must be signed in to change notification settings

fredden/magento2-module-javascript-error-reporting

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7376b7b · Aug 30, 2024

History

62 Commits
Mar 21, 2023
Mar 21, 2023
Mar 21, 2023
Mar 22, 2023
Mar 21, 2023
Mar 21, 2023
Apr 21, 2023
Mar 21, 2023
Mar 21, 2023
Oct 6, 2023
Apr 21, 2023
Mar 22, 2023
Aug 30, 2024
Mar 21, 2023

Repository files navigation

JavaScript error reporting for Magento 2

Latest stable version Total downloads Code quality alerts

Overview

A Magento 2 module which captures JavaScript errors for later review by website administrators. JavaScript errors are kept for up to 180 days (configurable) and available via Magento's administration back-end.

Screen-shot of summary view in admin area

Features

  • JavaScript errors are recorded for later review
    • JavaScript error message
    • File (URL), line number, column number of exception if available
    • Stack trace of exception if available
  • Limited browser information which might be useful for debugging (but hopefully not for fingerprinting / identifying individual users) is recorded
    • Current URL when error occurred
    • User agent
    • Viewport width & height
  • Errors are kept for up to 180 days (configurable) and automatically deleted after this period
  • Errors are available for review in Magento's back-end
    • Admin -> Reports -> JavaScript Error Reporting
  • Errors can be marked as ignored to help reduce noise / focus on new errors
  • Module can be enabled / disabled via configuration
    • Admin -> Stores -> Settings -> Configuration -> Advanced -> System -> JavaScript Error Reporting

Installation

This module is available on packagist.org and installable via composer:

composer require fredden/magento2-module-javascript-error-reporting

This module uses semantic versioning (semver).

Compatibility

Version Magento Open Source Adobe Commerce
2.0.x unsupported unsupported
2.1.x unsupported unsupported
2.2.x ✅ Yes ^0.1 ✅ Yes ^0.1
2.3.x ✅ Yes ^1.2.2 ✅ Yes ^1.2.2
2.4.x ✅ Yes ^1.0.1 ✅ Yes ^1.0.1
2.4.4 ✅ Yes ^1.0.1 || ^2.0 ✅ Yes ^1.0.1 || ^2.0
2.4.5 ✅ Yes ^1.0.1 || ^2.0 ✅ Yes ^1.0.1 || ^2.0
2.4.6 ✅ Yes ^1.0.1 || ^2.0 ✅ Yes ^1.0.1 || ^2.0

PHP version 7.1 or better is required.

No third-party libraries nor services are required.

Contributing

Community contributions are welcome. Please open a pull request on GitHub if you have a code suggestion, or an issue on GitHub if you are encountering a problem with this module. Please note that issues relating to the problems that this module highlights in others' code are out of scope for support here.

Future development ideas

  • filter grid by date and time range
  • details of "errors like this" (same hash) on details page.
    • perhaps links for: first, last, next, previous
    • maybe a chart of this error over time
      • show same charts as statistics page, but specifically for this error
  • statistics page, link for details should go to latest not first instance of error
  • charts on statistics page, click node to go to details pane with this time filter applied

About

A Magento 2 module which captures JavaScript errors for later review by website administrators.

Topics

Resources

Stars

Watchers

Forks