Skip to content
This repository has been archived by the owner on Jan 27, 2023. It is now read-only.

Rack middleware to send email when exceptions are raised

License

Notifications You must be signed in to change notification settings

alphagov/rack-exception_notifier

 
 

Repository files navigation

rack-exception_notifier Build Status

Rack-exception_notifier is a piece of simple rack middleware that will rescue exceptions and send email using the mail gem. This gem is based on Rack::MailExceptions in rack-contrib.

Usage

First include rack-exception_notifier in your Gemfile:

gem 'rack-exception_notifier'

Next configure the mail gem, by default mail will send email via SMTP to port 25 on localhost. If you would like to change that you can configure the gem according to their documentation.

Then you need to configure rack to use the middleware. Below is an example for sinatra:

enable :raise_errors
use Rack::ExceptionNotifier,
  :to => 'me@example.com',
  :from => 'app@example.com',
  :subject => '[ERROR] %s'

Options

  • :to - destination for email exceptions (required)
  • :from - address to originate email exceptions from (default: running username)
  • :subject - subject line for emails, %s will be interpolated with the exception #to_s (default: [ERROR] %s)
  • :include_body - should the body of the request be included in the email (default: false)

About

Rack middleware to send email when exceptions are raised

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%