Caution
This is a very early prototype
email_error_reporter
uses the new Rails error reporting API to send emails whenever an exception is being reported. It works out of the box with HTTP requests, jobs and the rails runner.
Add the gem:
bundle add email_error_reporter
and configure the email addresses that should receive an email in the case of an exception:
# application.rb
config.email_error_reporter.to = ["[email protected]"]
email_error_reporter
will reuse your environment specific ActionMailer configuration for delivering emails.
All exceptions are reported automatically. No additional code required.
Please consult the official guides for an introduction to the error reporting API.
Set a custom from address.
# default: "[email protected]"
config.email_error_reporter.from = "[email protected]"
Disables the email reports for specific environments.
# e.g. in development.rb
# default: true
config.email_error_reporter.enabled = false
You can use the built-in rake task rake email_error_reporter:check
to check if everything works correctly in your setup.
If you're using Kamal, you can run the following command to test the setup in production:
kamal app exec -p 'bundle exec rake email_error_reporter:test_email'
If everything is setup correctly, this rake task will send a demo email to your configured to
address with a sample exception.
The gem is available as open source under the terms of the MIT License.