Magento 2 Sentry Logger

This Magento 2 module integrates Sentry into magento 2.
Depending on the log level configured in the backend of magento 2, notifications and errors can be sent to sentry.

Features

• Send exceptions and logs to Sentry
• Show detailed context on thrown exceptions (Like Magento user/api consumer id)
• Easily control which events get sent to Sentry
• Backend and frontend error reporting
• Performance sampling (tracing & profiling)
  • Database Queries (Detect N+1 queries)
  • Events
  • Template rendering
  • Cache monitoring
  • Queue monitoring
• Cron Monitoring
• Session replay
• Logrocket support
• Sentry feedback form after an error

Installation

• composer require justbetter/magento2-sentry
• bin/magento module:enable JustBetter_Sentry
• bin/magento setup:upgrade
• bin/magento setup:di:compile
• bin/magento setup:static-content:deploy

Configuration

For configuration with Adobe Cloud, check below.

This module uses the Magento Deployment Configuration for most it's configuration. This means that you need to add this array to your app/etc/env.php:

'sentry' => [
    'dsn' => 'example.com',
    'logrocket_key' => 'example/example',
    'environment' => null,
    'log_level' => \Monolog\Level::Warning,
    'error_types' => E_ALL,
    'ignore_exceptions' => [],
    'mage_mode_development' => false,
    'js_sdk_version' => \JustBetter\Sentry\Block\SentryScript::CURRENT_VERSION,
    'tracing_enabled' => true,
    'traces_sample_rate' => 0.5,
    'disable_default_integrations' => [
        \Sentry\Integration\ModulesIntegration::class,
    ],
    'performance_tracking_enabled' => true,
    'performance_tracking_excluded_areas' => [\Magento\Framework\App\Area::AREA_ADMINHTML, \Magento\Framework\App\Area::AREA_CRONTAB],
    'profiles_sample_rate' => 0.5,
    'ignore_js_errors' => [],
    'enable_csp_report_url' => true,
]

Next to that there are some configuration options under Stores > Configuration > JustBetter > Sentry.

Configuration values

Configuration for Adobe Cloud

Since Adobe Cloud doesn't allow you to add manually add content to the env.php file, the configuration can be done
using the "Variables" in Adobe Commerce using the following variables:

The following configuration settings can be overridden in the Magento admin. This is limited to ensure that changes to
particular config settings can only be done on server level and can't be broken by changes in the admin.

Please note, that it is not possible to use profiling within the Adobe Cloud.

Optional error page configuration

• Optional you can configure custom error pages in pub/errors. You can use the sentry feedback form and insert here the sentry log ID. The Sentry Log Id is captured in de customer session and can be retrieved in processor.php.

Sending additional data to Sentry when logging errors

• When calling any function from the Psr\Log\LoggerInterface you can pass any data to the parameter $context and it will be send to Sentry as 'Custom context'.

Change / Filter events

This module has an event called sentry_before_send that is dispatched before setting the config before_send. This provides the means to edit / filter events. You could for example add extra criteria to determine if the exception should be captured to Sentry. To prevent the Exception from being captured you can set the event to null or unset it completly.

public function execute(\Magento\Framework\Event\Observer $observer)
{
    $observer->getEvent()->getSentryEvent()->unsEvent();
}

Example: https://github.com/justbetter/magento2-sentry-filter-events

This same thing is the case for

Compatibility

The module is tested on Magento version 2.4.x with sentry sdk version 4.x. feel free to fork this project or make a pull request.

Ideas, bugs or suggestions?

Please create a issue or a pull request.

Contributing

Contributing? Awesome! Thank you for your help improving the module!

Please see CONTRIBUTING for details.

Most importantly:

• When making a PR please add a description what you've added, and if relevant why.
• To save time on codestyle feedback, please run
  • composer install
  • composer run codestyle
  • composer run analyse

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.

Changelog

[4.5.2] - 2025-11-27

Fixed

* Fixed undefined message properties on queues (https://github.com/justbetter/magento2-sentry/pull/221)
* Fixed error thrown on new setup:install (https://github.com/justbetter/magento2-sentry/pull/223)
* Fixed activating sentry with invalid DSN (https://github.com/justbetter/magento2-sentry/pull/222)

[4.5.1] - 2025-11-11

Added

* Set Magento BP as default prefix

[4.5.0] - 2025-11-04

Added

* Added Logger support (https://github.com/justbetter/magento2-sentry/pull/201)
* Added support for manual release defnition (https://github.com/justbetter/magento2-sentry/pull/204)
* Added custom SDK identifier to module (https://github.com/justbetter/magento2-sentry/pull/208)
* Added Cache instrumentation (https://github.com/justbetter/magento2-sentry/pull/206)
* Added Queue instrumentation (https://github.com/justbetter/magento2-sentry/pull/210)
* add csp report-uri if none is configured (https://github.com/justbetter/magento2-sentry/pull/216) thanks to https://github.com/rommelfreddy 

Changed

* Replaced deprecated \Monolog\Logger::Warning (https://github.com/justbetter/magento2-sentry/pull/214) thanks to https://github.com/GeKVe
* use configured dsn-hostname for csp connect-src policy (https://github.com/justbetter/magento2-sentry/pull/215) thanks to https://github.com/rommelfreddy 

[4.4.0] - 2025-07-14

Fixed

* Catch zend db adapter errors when database is missing (https://github.com/justbetter/magento2-sentry/pull/193)
* Fix logrocket key type

Added

* Add the ability to select job codes using regex (https://github.com/justbetter/magento2-sentry/pull/197)
* Added support for [spotlight](https://spotlightjs.com/) (https://github.com/justbetter/magento2-sentry/pull/195)

[4.3.0] - 2025-06-24

Fixed

* Catch The default website isnt defined when getting store (https://github.com/justbetter/magento2-sentry/pull/188)

Added

* Add sentry logger by hooking into monolog setHandlers (https://github.com/justbetter/magento2-sentry/pull/184)
* Added support for cron check-ins (https://github.com/justbetter/magento2-sentry/pull/182)

[4.2.0] - 2025-06-11

Added

* Add performance sampling by (https://github.com/justbetter/magento2-sentry/pull/178) thanks to https://github.com/indykoning, https://github.com/barryvdh and https://github.com/rommelfreddy
* Automatically pass all supported sentry config (https://github.com/justbetter/magento2-sentry/pull/177)

[4.1.0] - 2025-06-04

Added

* Clean up the Magento stacktrace before sending it to Sentry (https://github.com/justbetter/magento2-sentry/pull/171)
* Pass config also relevant to sentry (https://github.com/justbetter/magento2-sentry/pull/172)

Fixed

* Gather ip from Magento instead of server variable (https://github.com/justbetter/magento2-sentry/pull/174)

[4.0.1] - 2025-05-06

Fixed

* Load customerSession in SentryLog via proxy (Fixing https://github.com/justbetter/magento2-sentry/issues/160) (https://github.com/justbetter/magento2-sentry/pull/169) thanks to https://github.com/brosenberger

[4.0.0] - 2025-04-23

Added

* Moved sentry logging to a monolog handler (https://github.com/justbetter/magento2-sentry/pull/165)
* Added support for Magento 2.4.8
* Added support for Monolog V3

Changed

* Dynamically add sentry and logrocket domains to CSP whitelist (https://github.com/justbetter/magento2-sentry/pull/156) thanks to https://github.com/brosenberger
* Use secureRenderer for including sentry frontend js (https://github.com/justbetter/magento2-sentry/pull/157) thanks to https://github.com/brosenberger

[3.9.0] - 2025-01-31

Added

* Raised PHPStan level to 5 (https://github.com/justbetter/magento2-sentry/pull/149)
* Added user context to logging and errors when possible (https://github.com/justbetter/magento2-sentry/pull/133 & https://github.com/justbetter/magento2-sentry/pull/152)
* Allow overriding some config per store (https://github.com/justbetter/magento2-sentry/pull/155) thanks to https://github.com/bruno-blackbird

[3.8.0] - 2024-08-09

Added

* Added option to exclude default-integrations (https://github.com/justbetter/magento2-sentry/pull/146) thanks to https://github.com/rommelfreddy

Removed

* Removed promise-polyfill (https://github.com/justbetter/magento2-sentry/pull/142) thanks to https://github.com/rommelfreddy

[3.7.2] - 2024-07-04

Fixed

* fix initialisation of replay integration (https://github.com/justbetter/magento2-sentry/pull/143) thanks to https://github.com/rommelfreddy

[3.7.1] - 2024-06-25

Fixed

* Fix CSP after Polyfill changes (https://github.com/justbetter/magento2-sentry/pull/141) thanks to https://github.com/sprankhub

[3.7.0] - 2024-06-25

Fixed

* Replace polyfill CDN with fastly (https://github.com/justbetter/magento2-sentry/pull/140) thanks to https://github.com/barryvdh

Added

* Enable INP when tracing is enabled (https://github.com/justbetter/magento2-sentry/pull/137) thanks to https://github.com/amenk

[3.6.0] - 2024-03-29

This release drops support for php 7.4 as it has been completely EOL for over a year. https://www.php.net/supported-versions.php

Fixed

* Check if Sentry is defined before running init (https://github.com/justbetter/magento2-sentry/pull/129) thanks to https://github.com/netzkollektiv

Changed

* Use property promotions (https://github.com/justbetter/magento2-sentry/pull/130) thanks to https://github.com/cirolosapio
* Raised sentry/sdk version to 4.0+

[3.5.2] - 2024-03-18

Fixed

* Fix start errors without database connection (https://github.com/justbetter/magento2-sentry/pull/125) thanks to https://github.com/fredden

[3.5.1] - 2023-12-21

Fixed

* Fix getting SCOPE_STORES from incorrect ScopeInterface (https://github.com/justbetter/magento2-sentry/pull/123) thanks to https://github.com/peterjaap
* Improve extendibility by changing self to static (https://github.com/justbetter/magento2-sentry/pull/122) thanks to https://github.com/peterjaap

[3.5.0] - 2023-12-20

Added

* Added support for configuration using System Configuration (https://github.com/justbetter/magento2-sentry/pull/121) thanks to https://github.com/ArjenMiedema

[3.4.0] - 2023-06-14

Added

* Added `sentry_before_send` event (https://github.com/justbetter/magento2-sentry/pull/117) thanks to https://github.com/rbnmulder
* Added support to ignore javascript errors (https://github.com/justbetter/magento2-sentry/pull/102) thanks to https://github.com/rommelfreddy

[3.3.1] - 2023-03-15

Fixed

* Fixed PHP 8.2 deprecation errors (https://github.com/justbetter/magento2-sentry/pull/114) thanks to https://github.com/peterjaap

[3.3.0] - 2023-03-01

Added

* Added Session Replay functionality

[3.2.0] - 2022-07-07

Fixed

* Changed addAlert to addRecord for Test error (https://github.com/justbetter/magento2-sentry/pull/98) thanks to https://github.com/peterjaap

Added

* Send context data top Sentry as Custom Data (https://github.com/justbetter/magento2-sentry/pull/97) thanks to https://github.com/oneserv-heuser

[3.1.0] - 2022-06-14

Fixed

* Update addRecord function for Monolog 2.7+ (https://github.com/justbetter/magento2-sentry/pull/92) thanks to https://github.com/torhoehn

[3.0.2] - 2022-06-14

Added

* Added sentry_before_init event to GlobalExceptionCatcher (https://github.com/justbetter/magento2-sentry/pull/90) thanks to https://github.com/peterjaap

[3.0.1] - 2022-05-10

Fixed

* Fix problems with logout during product edit in admin panel when Chrome DevTools is open (https://github.com/justbetter/magento2-sentry/pull/86) thanks to https://github.com/trungpq2711

[3.0.0] - 2022-04-13

Breaking: New version (2.0.0+) for Monolog will be required.

Fixed

* Fixed PHP 8.1 support with monolog 2.0.0+ (https://github.com/justbetter/magento2-sentry/pull/85) thanks to https://github.com/peterjaap

[2.6.1] - 2022-04-13

Changed

* Updated constraints for monolog versions lower than 2.0.0

[2.6.0] - 2021-04-08

Added

* Add option to filter the severity of ErrorExceptions being sent to Sentry
* Add option to ignore specific Exception classes

[2.5.4] - 2021-02-10

Fixed

* Fixed capital in dataHelper (https://github.com/justbetter/magento2-sentry/pull/74) thanks to https://github.com/peterjaap

[2.5.3] - 2021-02-03

Added

* Add option to strip static content version and store code from urls that get sent to Sentry (https://github.com/justbetter/magento2-sentry/pull/73) thanks to https://github.com/peterjaap

[2.5.2] - 2021-01-18

Fixed

* Fix monolog plugin still adding monolog as argument

[2.5.1] - 2021-01-18

Fixed

* Merged PR - Use isset to check for custom_tags in context (https://github.com/justbetter/magento2-sentry/pull/71) thanks to https://github.com/matthiashamacher

[2.5.0] - 2021-01-15

Changed

* Merged PR - Remove monolog class in function, add custom tag functionality (https://github.com/justbetter/magento2-sentry/pull/66) thanks to https://github.com/matthiashamacher
This is a breaking change on SentryLog::send(), the function required monolog before, this has been removed

[2.4.0] - 2020-12-07

Added

* Merged PR - Add csp_whitelist.xml (https://github.com/justbetter/magento2-sentry/pull/65) thanks to https://github.com/matthiashamacher

Changed

* Merged PR - Update Sentry version (https://github.com/justbetter/magento2-sentry/pull/64) thanks to https://github.com/matthiashamacher

[2.3.2] - 2020-11-30

Added

* Merged PR - Adding environment to js integration (https://github.com/justbetter/magento2-sentry/pull/62) thanks to https://github.com/matthiashamacher

[2.3.1] - 2020-07-31

Added

* Merged PR - Add option to enable or disable Php error tracking (https://github.com/justbetter/magento2-sentry/pull/59) thanks to https://github.com/t9toqwerty

[2.3.0] - 2020-06-29

Added

* Merged PR - Added version tagging to JavaScript (https://github.com/justbetter/magento2-sentry/pull/54) thanks to https://github.com/JKetelaar
* Added LogRocket support

Changed

* Better feedback if configuration prevents the module from running

[2.2.3] - 2020-02-25

Fixed

* Merged PR - Release version should be string (https://github.com/justbetter/magento2-sentry/pull/49) thanks to https://github.com/DominicWatts

[2.2.2] - 2020-02-11

Changed

* Merged PR - Change behavior to check of script tag can be used (https://github.com/justbetter/magento2-sentry/pull/48) thanks to https://github.com/adamj88
* Updated changelog format to folow more closely to https://keepachangelog.com/

[2.2.1] - 2019-12-12

Changed

* Merged PR - fix for requirements sdk (https://github.com/justbetter/magento2-sentry/pull/42) thanks to https://github.com/jupiterhs

[2.2.0] - 2019-12-12

Changed

* Merged PR (https://github.com/justbetter/magento2-sentry/pull/37) thanks to https://github.com/DominicWatts
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/38) thanks to https://github.com/matthiashamacher

[2.1.0] - 2019-11-22

Changed

* Merged PR (https://github.com/justbetter/magento2-sentry/pull/33) thanks to https://github.com/DominicWatts
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/35) thanks to https://github.com/peterjaap
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/36) thanks to https://github.com/peterjaap
* Refactor of proxy classes in di.xml

Fixed

* Fixed all PHPcs warnings and errors

[2.0.0] - 2019-11-19

Changed

* Merged PR (https://github.com/justbetter/magento2-sentry/pull/29) thanks to https://github.com/michielgerritsen
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/26) thanks to https://github.com/JosephMaxwell
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/27) thanks to https://github.com/DominicWatts

[0.8.0] - 2019-08-29

Changed

* Merged PR (https://github.com/justbetter/magento2-sentry/pull/24) thanks to https://github.com/kyriog
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/22) thanks to https://github.com/fredden
* Merged PR (https://github.com/justbetter/magento2-sentry/pull/21) thanks to https://github.com/erikhansen

[0.7.2] - 2019-06-19

Changed

* Reverted async attribute

[0.7.1] - 2019-06-19

Added

* Added async and crossorigin attribute to script tags

[0.7.0] - 2019-04-23

Fixed

* Merged pull request avoiding magento crash (https://github.com/justbetter/magento2-sentry/pull/19)

[0.6.2] - 2019-04-05

Fixed

* Fixed issues useing referenceBlock when adding scripts (https://github.com/justbetter/magento2-sentry/issues/18)

[0.6.1] - 2019-02-14

Added

* Added missing files of PR 13 (https://github.com/justbetter/magento2-sentry/pull/16)

[0.6.0] - 2019-02-14

Added

* Added Sentry script tag to catch javascript errors (https://github.com/justbetter/magento2-sentry/pull/13)

[0.5.1] - 2019-02-13

Added

* Support for setting environment (https://github.com/justbetter/magento2-sentry/pull/12)

[0.5.0] - 2018-12-07

Added

* Send extra parameters to sentry (https://github.com/justbetter/magento2-sentry/issues/11)
* Added Magento 2.3.x support & dropped 2.1.x support

Fixed

* Fixed area code not set or already set

[0.4.2] - 2018-10-17

Fixed

* Bugfix with area code already set - removed area code from constructor with causes problems at random cases. (https://github.com/justbetter/magento2-sentry/issues/10)

Changed

* Removed info level - this log level is not useable in sentry.

[0.4.1] - 2018-08-15

Fixed

* Removed plugin in di.xml to prevent fatal crash on storefrontend
* Restored preference in di.xml

[0.4.0] - 2018-08-10

Added

* Added user context
* Added message context
* Added extra magento store parameters

Changed

* Refactor of overwrite to plugin with monolog
* Refactor of ExceptionCatcher to use same SentryLogger
* Refactor a lot of code
* PSR2 compliance

Fixed

* Bugfix area code not set

[0.2.1] - 2018-04-30

Changed

* downgraded requirement monolog for magento 2.1.x

[0.2.0] - 2018-04-30

Added

* Feature request to test sentry in development mode (https://github.com/justbetter/magento2-sentry/issues/4)
* Added mage deploy mode to sentry in context_tags

[0.1.0] - 2018-04-17

Added

* Feature request for sending test events (https://github.com/justbetter/magento2-sentry/issues/3)
* Added ACL roles for editing sentry config

[0.0.6] - 2018-03-25

Fixed

* Bugfix wrong file commit

[0.0.5] - 2018-03-17

Added

* Initial commit module - basic working module