oneup / contao-sentry-bundle
This bundle provides an easy integration of sentry.io for Contao 4.4.x and newer.
Installs: 8 867
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 3
Forks: 2
Open Issues: 0
Type:contao-bundle
Requires
- php: ^7.1 || ^8.0
- contao/core-bundle: ^4.4 || ^5.0
- sentry/sentry-symfony: ^4.0
- twig/twig: ^2.7 || ^3.0
Requires (Dev)
- contao/manager-plugin: ^2.0
- friendsofphp/php-cs-fixer: ^2.13
- phpstan/phpstan: ^1.10
- sentry/sentry: ^3.0
- symfony/config: ^4.0 || ^5.0 || ^6.0
- symfony/dependency-injection: ^4.0 || ^5.0 || ^6.0
- symfony/http-kernel: ^4.0 || ^5.0 || ^6.0
README
This Contao bundle provides an easy integration of sentry.io for Contao 4.4.x and newer.
--
In the first place, this is an "wrapper extension" for the sentry/sentry-symfony
bundle. Therefore, you need to
configure this bundle as you would configure the sentry/sentry-symfony
bundle: Documentation
Recommended configuration
If you also want to report the system log errors to Sentry, this is the recommended configuration:
sentry: dsn: "https://xyz@sentry.io/xy" register_error_listener: false Sentry\Monolog\Handler: arguments: $hub: '@Sentry\State\HubInterface' $level: !php/const Monolog\Logger::ERROR # Can be one of https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#log-levels, but System::log() only uses INFO or ERROR $bubble: false monolog: handlers: sentry: type: service id: Sentry\Monolog\Handler priority: 100 # Higher priority than ContaoTableHandler which will stop handling afterwards (bubbling is set to true) bubble: false # Use bubble: true if you don't want the logs to show up in the system log (bubbling means, no monolog handlers will run afterwards)
User feedback
On the other hand you might want to implement the User feedback feature of sentry. The user feedback is primarily useful to let the users know that you've gotten notified about the issue and to let users give the opportunity to add some comments.
In order to integrate this feature, you have to alter the error page template. Place a copy of
vendor/contao/core-bundle/src/Resources/views/Error/layout.html.twig
in the directory
app/Resources/ContaoCoreBundle/views/Error/
.
Modify the copied template and place the following snippet just before the closing </body>
tag:
{% set sentry_id = ''|sentry_last_event_id %} {% if sentry_id %} <script src="https://browser.sentry-cdn.com/5.7.1/bundle.min.js" integrity="sha384-KMv6bBTABABhv0NI+rVWly6PIRvdippFEgjpKyxUcpEmDWZTkDOiueL5xW+cztZZ" crossorigin="anonymous"></script> <script> Sentry.init({dsn: '{{ ''|sentry_dsn }}'}); Sentry.showReportDialog({eventId: '{{ sentry_id }}'}) // You can also bind the "show" method to an event, e.g. to open the modal on button click {#document.querySelector('.btn-report').addEventListener('click', function (e) {#} {# e.preventDefault();#} {# Sentry.showReportDialog({eventId: '{{ sentry_id }}'})#} {#});#} </script> {% endif %}