The Exception Notifier plugin provides a mailer object and a default set of templates for sending email notifications when errors occur in a Rails application. The plugin is configurable, allowing programmers to specify:
-
the sender address of the email
-
the recipient addresses
-
the text used to prefix the subject line
The email includes information about the current request, session, and environment, and also gives a backtrace of the exception.
First, include the ExceptionNotifiable mixin in whichever controller you want to generate error emails (typically ApplicationController):
class ApplicationController < ActionController::Base include ExceptionNotifiable ... end
Then, specify the email recipients in your environment:
ExceptionNotifier.exception_recipients = %w(joe@schmoe.com bill@schmoe.com)
And that’s it! The defaults take care of the rest.
You can tweak other values to your liking, as well. In your environment file, just set any or all of the following values:
# defaults to exception.notifier@default.com ExceptionNotifier.sender_address = %("Application Error" <app.error@myapp.com>) # defaults to "[ERROR] " ExceptionNotifier.email_prefix = "[APP] "
By default, the notification email includes four parts: request, session, environment, and backtrace (in that order). You can customize how each of those sections are rendered by placing a partial named for that part in your app/views/exception_notifier directory (e.g., _session.rhtml). Each partial has access to the following variables:
-
@controller: the controller that caused the error
-
@request: the current request object
-
@exception: the exception that was raised
-
@backtrace: a sanitized version of the exception’s backtrace
-
@data: a hash of optional data values that were passed to the notifier
-
@sections: the array of sections to include in the email
You can reorder the sections, or exclude sections completely, by altering the ExceptionNotifier.sections variable. You can even add new sections that describe application-specific data–just add the section’s name to the list (whereever you’d like), and define the corresponding partial. Then, if your new section requires information that isn’t available by default, make sure it is made available to the email using the exception_data macro:
class ApplicationController < ActionController::Base
before_filter :log_additional_data
...
protected
def log_additional_data
request.env["exception_notifier.exception_data"] = {
:document => @document,
:person => @person
}
end
...
end
In the above case, @document and @person would be made available to the email renderer, allowing your new section(s) to access and display them. See the existing sections defined by the plugin for examples of how to write your own.
Copyright © 2005 Jamis Buck, released under the MIT license