public
Fork of thoughtbot/hoptoad_notifier
Description: Reports exceptions to Hoptoad
Homepage: http://www.hoptoadapp.com/
Clone URL: git://github.com/lukeredpath/hoptoad_notifier.git
hoptoad_notifier / INSTALL
100644 48 lines (30 sloc) 1.488 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
HoptoadNotifier
===============
 
This is the notifier plugin for integrating apps with Hoptoad.
 
When an uncaught exception occurs, HoptoadNotifier will POST the relevant data
to the Hoptoad server specified in your environment.
 
 
INSTALLATION
 
From your project's RAILS_ROOT, run:
 
  script/plugin install git://github.com/thoughtbot/hoptoad_notifier.git
 
CONFIGURATION
 
You should have something like this in config/initializers/hoptoad.rb.
 
  HoptoadNotifier.configure do |config|
    config.api_key = '1234567890abcdef'
  end
  
(Please note that this configuration should be in a global configuration, and
is *not* enrivonment-specific. Hoptoad is smart enough to know what errors are
caused by what environments, so your staging errors don't get mixed in with
your production errors.)
 
Then, to enable hoptoad in your appication, include this code...
 
  include HoptoadNotifier::Catcher
 
...at the top of your ApplicationController, and all exceptions will be logged
to Hoptoad where they can be aggregated, filtered, sorted, analyzed, massaged,
and searched.
 
** NOTE FOR RAILS 1.2.* USERS: **
You will need to copy the hoptoad_notifier_tasks.rake file into your
RAILS_ROOT/lib/tasks directory in order for the following to work:
 
You can test that hoptoad is working in your production environment by using
this rake task (from RAILS_ROOT):
 
  rake hoptoad:test
 
If everything is configured properly, that task will send a notice to hoptoad
which will be visible immediately.