Show exception ids on error pages and headers, so users or support can track them down faster
Install
gem 'sentry-user_informer'Usage
# Gemfile
gem 'sentry-user_informer'
# config/initializers/sentry.rb
Sentry.configure do |config|
... regular config ...
end
# optional: customize placeholder (make sure it matches public/500.html)
# Sentry::UserInformer.placeholder = '<!-- SENTRY-USER-INFORMER -->'
# optional: customize template
# Sentry::UserInformer.template = # replaces `placeholder` on 500 pages
# "<br/><br/>Error number: <a href='https://sentry.io/organizations/foo/issues/?query=%{event_id}'>%{event_id}</a>"
# public/500.html
<!-- SENTRY-USER-INFORMER -->Details
- adds a new middleware to render placeholder
- modifies
Sentry::Rails::Middlewareto store the exceptions it sends to sentry
middleware basically ends up like this:
use Sentry::UserInformer::ExceptionRenderer # replace placeholder
use ActionDispatch::ShowExceptions # render 500.html
use Sentry::Rails::CaptureExceptions # store exception
Development
- run tests:
bundle && rake default integration(github actions cannot run integration tests) - example app:
cd example && bundle && rails sthen go tolocalhost:3000orlocalhost:3000/error
Author
Michael Grosser
michael@grosser.it
License: MIT