I wrote code to send mail when error occurs in Rails 4.
Environment
- Ubuntu 15.05 (64bit)
- Ruby 2.2.2
- Rails 4.1.8
Old Way
In Rails 3, I could use rescue_in_public
method in ApplicationController
and send error notification mail.
1 2 3 4 5 6 7 8 9 10 11 12 |
class ApplicationController < ActionController::Base protected def rescue_action_in_public(exception) SystemMailer.system_error( current_user, self, request, exception).deliver super(exception) end def local_request? false end end |
current_user
returns user who logging in. It’s defined in devise gem.
But in rails 4, it doesn’t work.
Solution
I used rescue_from
, which also exists in Rails 3.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
class ApplicationController < ActionController::Base rescue_from Exception, :handle_exception private # handle exception # ==== Parameter # * +exception+ def handle_exception(exception) send_error_mail(exception) raise exception end # send error mail # ==== Parameter # * +exception+ def send_error_mail(exception) if !Rails.env.development? SystemMailer.error_mail( exception, current_user, self, request) end end end |
rescue_from Exception
catches all exception occurs in controller, but rescue_from StandardError
doesn’t. It is because RuntimeError
, for example, is inherits Exception
but doesn’t inherit StandardError
, which is raised by raise "exception!"
simply. And, syntax error like 0 = 1
couldn’t be caught. Error caught by rescue_from Exception
is errors occurs in running program. And errors occur before controller procedure can’t be caught.
The point is raise exception
in handle_exception
method. I don’t want to erase exception by handle_exception
, but want only to send notification mail. It is like AOP. In the above, add method into application_controller.rb
simply.
current_user
in send_error_mail
method returns logging in user, which is defined in the gem, devise. self
is used for reporting in which controller the error occurs. request
is for reporting request url, etc. The code !Rails.env.development?
should be replace to config
value. I heard that we can use custom configuration in Rails 4.2, so it is the issue after rails upgrading.
Attention
Exceptions before controller procedure should be reported by other way.
I know handling exception outside of controller is a way, but there are variables can be referred in controller and objects useful in controller, I thought, so I wrote code into applicatoin_controller.rb
.