Exception Notification Gem and Rails 3

Question

I'm trying to get this up and running, but I see "uninitialized constant ExceptionNotifier" whenever I start my server.

http://github.com/rails/exception_notification

In my Gemfile I have

gem "exception_notification", :git => "http://github.com/rails/exception_notification.git", :branch => "master"

I've tried putting the configuration as shown in the github readme inside of config/application.rb, config/environment.rb, and config.ru. I replaced "Whatever" with my application name.

See Sebastian Martinez's comment below. He maintains the official plugin, which is now at a new location (https://github.com/smartinez87/exception_notification). It works flawlessly in Rails 3. — gtd, Nov 11 '11 at 15:59

score 57 · Answer 1 · edited Dec 22 '11 at 19:37

57

All previous answers are outdated, you can now simply add this to your gemfile:

gem 'exception_notification', :require => 'exception_notifier'

And edit your production.rb config file as indicated in the readme:

config.middleware.use ExceptionNotifier,
  :email_prefix => "[Exception] ",
  :sender_address => %{"Exception Notifier" <support@example.com>},
  :exception_recipients => %w{you@me.com}

edited Dec 22 '11 at 19:37

BvuRVKyUVlViVIc7

11,641
9
59
111

answered Jan 27 '11 at 15:50

Jan M

2,205
21
14

7

I think this is a fork of the main project, you can just use gem 'exception_notification', :require => 'exception_notifier' – Braden Becker Mar 13 '11 at 21:47
3

Braden's right - `gem 'exception_notification', :require => 'exception_notifier'` works now – William Denniss Apr 01 '11 at 08:11

score 21 · Answer 2 · answered Apr 06 '11 at 00:09

21

Latest version of official gem works with Rails 3, you can find it here: https://github.com/smartinez87/exception_notification.

Next gem release will make the :require => 'exception_notifier' option unnecessary.

answered Apr 06 '11 at 00:09

Sebastian Martinez

484
3
8

score 13 · Answer 3 · answered Sep 25 '10 at 00:56

Ok, its working now for me:

# Gemfile
gem "exception_notification", :git => "git://github.com/rails/exception_notification", :require => 'exception_notifier'

# application.rb, inside the config block
config.middleware.use ::ExceptionNotifier,
  :email_prefix => "ApplicationName-Errors: ",
  :sender_address => %w{office@application.com},
  :exception_recipients => %w{office@application.com}

Saqib R. · Answer 4 · 2014-01-17T13:19:51.603

10

Keep it simple silly

In gemfile

gem 'exception_notification', :require => 'exception_notifier'

In application.rb file

  config.middleware.use ExceptionNotifier,
 :email_prefix => "[ERROR] ",
 :sender_address => %{"Exception Notifier" <Dummy_email@exapmle.com>},
 :exception_recipients => %w{Dummy_email@example.com}

Your are Done.. :*

edited Jan 17 '14 at 13:19

answered Sep 07 '11 at 13:15

Saqib R.

2,919
2
26
21

Sure, but this catches all the exceptions. It won't render anything. – PabloJimeno Jul 24 '13 at 11:11

score 4 · Answer 5 · answered Aug 19 '10 at 17:22

It seems that Rails 3 can't use this plugin in gem form. Maybe rack apps can't be loaded from gems? I installed it as a plugin instead and changed the config syntax to:

config.middleware.use "::ExceptionNotifier"

instead of

config.middleware.use ExceptionNotifier

score 4 · Answer 6 · answered Mar 30 '11 at 18:33

The official repo on github is now: https://github.com/smartinez87/exception_notification

In the Gemfile

gem "exception_notification", :require => 'exception_notifier', :git => "https://github.com/smartinez87/exception_notification.git"

In config\initializers\exception_notification.rb

Rails.application.config.middleware.use ExceptionNotifier,
  :email_prefix => "[Whatever] ",
  :sender_address => %{"notifier" <notifier@example.com>},
  :exception_recipients => %w{exceptions@example.com}

score 3 · Answer 7 · answered May 13 '12 at 00:56

If you are doing a rescue_from Exception, with: :render_500 to handle showing a 500 template/page it no longer sends an email with just this

    config.middleware.use ExceptionNotifier,
  :email_prefix => "[some prefix] ",
  :sender_address => %{"Notifier" <notify@domain.com>},
  :exception_recipients => %w{recipient@domain.com}

You'll need to manually send it in the method that handles the exception

def render_500(exception)
    # email an error email if there's a 500 in production mode
    if Rails.env.production?
        ExceptionNotifier::Notifier.exception_notification(request.env, exception).deliver
    end
end

So put the config stuff in your environment (production.rb) and the Exception handling code in your application controller.

score 3 · Answer 8 · answered Sep 14 '10 at 08:38

3

Actually, now, it is much easier. In your Gemfile you need to write:

gem "exception_notification", :git => "http://github.com/rails/exception_notification.git", :require => 'exception_notifier'

And all should be fixed. The :require option is crucial (i guess because the names differ you have to specify explicitly). All other patches mentioned before have been merged i presume.

answered Sep 14 '10 at 08:38

nathanvda

49,707
13
117
139

Yes definitely. I use the above line in my Gemfile, and in my application.rb i have the `config.middleware.use ...` and that's all i needed to do. Do you still have the uninitialized constant error? – nathanvda Sep 25 '10 at 16:03
The `:git` part is also crucial. The latest published gem (2.3.3.0 right now) does not work with Rails 3. – Steve Madsen Oct 14 '10 at 03:09

score 3 · Answer 9 · answered Nov 18 '10 at 23:08

I was able to get it to work with the following in production.rb:

config.after_initialize do
 config.middleware.use ExceptionNotifier,
      :email_prefix => "[Whatever] ",
      :sender_address => %{"notifier" <notifier@example.com>},
      :exception_recipients => %w{exceptions@example.com}
end

score 3 · Answer 10 · answered Jun 28 '11 at 17:39

3

https://github.com/smartinez87/exception_notification

This gem has been updated for rails 3.x and I just tested on 3.0.7 and the installation is much simpler.

Gemfile:

gem 'exception_notification'

Initializer:

Rails.application.config.middleware.use ExceptionNotifier,
  :email_prefix => "[Whatever] ",
  :sender_address => %{"notifier" <notifier@example.com>},
  :exception_recipients => %w{exceptions@example.com}

answered Jun 28 '11 at 17:39

Brian Samson

610
6
6

Initializer? What file/where is this? – sscirrus Sep 16 '11 at 01:29
1

@sscirrus Just create a file named whatever you want in config/initializers/ – gtd Nov 11 '11 at 15:58

score 2 · Answer 11 · answered Aug 03 '12 at 05:31

till now ( 2012-Aug-03) the official site is : https://github.com/smartinez87/exception_notification, and according the README, it support Rails3 perfectly.

step1. edit your Gemfile:

gem 'exception_notification'

step2.

As of Rails 3 ExceptionNotification is used as a rack middleware, so you can configure its options on your config.ru file, or in the environment you want it to run. In most cases you would want ExceptionNotification to run on production. You can make it work by
Whatever::Application.config.middleware.use ExceptionNotifier,
  :email_prefix => "[Whatever] ",
  :sender_address => %{"notifier" <notifier@example.com>},
  :exception_recipients => %w{exceptions@example.com}

score 2 · Answer 12 · edited Jul 27 '11 at 06:07

It took a bit of work but I got Exception Notifier working with Rails 3.0.0:

1- rails plugin install http://github.com/sickill/exception_notification.git

(If you don't want to use this fork, just apply his patch manually to the original Rails plugin: it is only 3 lines.) It fixes the 'undefined method controller_name error'

2- In application.rb:

config.middleware.use "::ExceptionNotifier" , :email_prefix => "[Whatever] ",
                           :sender_address => %{"notifier" <notifier@example.com>},
                           :exception_recipients => %w{whoever@example.com}

3- Apply Lawrence Pit's patch. (UPDATE: This link appears to be broken) It fixes the uninitialized constant ActiveRecord::RecordNotFound error as documented here.

That's it.

Fredrik Boström · Answer 13 · 2010-12-10T10:54:57.710

I had the same problem just now and resolved it this way:

Gemfile

source 'http://rubygems.org'
gem 'exception_notification_rails3', :require => 'exception_notifier'

application.rb

config.middleware.use ExceptionNotifier,
  :email_prefix => "[some prefix] ",
  :sender_address => %{"Notifier" <notify@domain.com>},
  :exception_recipients => %w{recipient@domain.com}

I'm refactoring a Rails 2.3 project to 3.0, so I haven't tried this on a fresh install.

Edit:

It might actually be better (or "more correct") to put the ExceptionNotifier initialization in a separate initializer file in config/initializers/ instead of application.rb.

config/initializers/exception_notifier.rb

MyApp::Application.config.middleware.use ExceptionNotifier,
  :email_prefix => "[some prefix] ",
  :sender_address => %{"Notifier" <notify@domain.com>},
  :exception_recipients => %w{recipient@domain.com}

score 2 · Answer 14 · answered Mar 05 '11 at 20:47

Using Rails 3.0.3 this works for me:

gem "exception_notification", :git => "https://github.com/sickill/exception_notification.git", :require => 'exception_notifier'

:git part is imported because its a patched version to get around the 'undefined method controller_name error' and :require to require the right lib.

Then in my production.rb environment file i only have this (from the manual)

  config.middleware.use ExceptionNotifier,
    :email_prefix => "[MyApp] ",
    :sender_address => %{"notifier" <email@example.com>},
    :exception_recipients => %w{email@example.com}

Seems like there are many different ways to get this to work, but this was my way.

Cheers!

score 1 · Answer 15 · answered Mar 11 '14 at 21:34

UPDATED ANSWER as of 3/14...

You just need to do gem exception_notification in your gem file. No 'require' needed.

Also, other changes just straight from the docs...

"As of 4.x version the configuration syntax has changed. All email related options MUST BE nested under the :email key."

like so...

Whatever::Application.config.middleware.use ExceptionNotification::Rack,
  :email => {
    :email_prefix => "[Whatever] ",
    :sender_address => %{"notifier" <notifier@example.com>},
    :exception_recipients => %w{exceptions@example.com}
  }

score 1 · Answer 16 · answered Feb 19 '11 at 17:31

I am using rails 3.0.4 and had the same issue as above. The only solution that worked for me was to install the v1.2 of the exception_notification for rails 3 (make sure you use the correct branch/version) as a PLUGIN

rails plugin install https://github.com/railsware/exception_notification.git

and use in production.rb the code everyone mentions:

config.middleware.use ExceptionNotifier,
  :email_prefix => "[some prefix] ",
  :sender_address => %{"Notifier" <notify@domain.com>},
  :exception_recipients => %w{recipient@domain.com}

It definitely did not work for me as a gem and the readme does say " Exception Notifier Plugin for Rails " and mentions nothing about installing it as gem.

Harry

score 0 · Answer 17 · answered Jul 23 '13 at 19:08

I copied and pasted the exception_notification config from old app to new one and it failed. It brought me here and none of the above answers were up-to-date. Since 4.x version the middleware was renamed to ExceptionNotification::Rack, so middleware config looks like that:

Whatever::Application.config.middleware.use ExceptionNotification::Rack,
 :email => {
   :email_prefix => "[Whatever] ",
   :sender_address => %{"notifier" <notifier@example.com>},
   :exception_recipients => %w{exceptions@example.com}
 }

Exception Notification Gem and Rails 3

17 Answers17

Linked