Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
2,353 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
HoptoadNotifier.configure do |config| | ||
config.api_key = '8e21252519d4be7204bd774f0f783be4' | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
log/* | ||
tmp/**/* | ||
db/schema.rb | ||
db/*.sqlite3 | ||
public/system | ||
*.swp | ||
*.DS_Store | ||
coverage/* | ||
rdoc/ | ||
tags |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
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 | ||
------------ | ||
|
||
REMOVE EXCEPTION_NOTIFIER | ||
|
||
In your ApplicationController, REMOVE this line: | ||
|
||
include ExceptionNotifiable | ||
|
||
In your config/environment* files, remove all references to ExceptionNotifier | ||
|
||
Remove the vendor/plugins/exception_notifier directory. | ||
|
||
INSTALL HOPTOAD_NOTIFIER | ||
|
||
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.) | ||
|
||
After this is in place, 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person | ||
obtaining a copy of this software and associated documentation | ||
files (the "Software"), to deal in the Software without | ||
restriction, including without limitation the rights to use, | ||
copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the | ||
Software is furnished to do so, subject to the following | ||
conditions: | ||
|
||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | ||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | ||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
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 | ||
------------ | ||
|
||
REMOVE EXCEPTION_NOTIFIER | ||
|
||
In your ApplicationController, REMOVE this line: | ||
|
||
include ExceptionNotifiable | ||
|
||
In your config/environment* files, remove all references to ExceptionNotifier | ||
|
||
Remove the vendor/plugins/exception_notifier directory. | ||
|
||
INSTALL HOPTOAD_NOTIFIER | ||
|
||
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* environment-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.) | ||
|
||
That should be it! Now all exceptions will be logged to Hoptoad where they can | ||
be aggregated, filtered, sorted, analyzed, massaged, and searched. In previous | ||
releases you had to include HoptoadNotifier::Catcher into your | ||
ApplicationController, but the plugin takes care of that now. | ||
|
||
** 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. | ||
|
||
USAGE | ||
|
||
For the most part, hoptoad works for itself. Once you've included the notifier | ||
in your ApplicationController (which is now done automatically by the plugin), | ||
all errors will be rescued by the #rescue_action_in_public provided by the plugin. | ||
|
||
If you want to log arbitrary things which you've rescued yourself from a | ||
controller, you can do something like this: | ||
|
||
... | ||
rescue => ex | ||
notify_hoptoad(ex) | ||
flash[:failure] = 'Encryptions could not be rerouted, try again.' | ||
end | ||
... | ||
|
||
The #notify_hoptoad call will send the notice over to hoptoad for later | ||
analysis. | ||
|
||
TRACKING DEPLOYMENTS IN HOPTOAD | ||
|
||
Paying Hoptoad plans support the ability to track deployments of your application in Hoptoad. | ||
By notify Hoptoad of your application deployments, all errors are resolved when a deploy occurs, | ||
so that you'll be notified again about any errors that reoccur after a deployment. | ||
|
||
Additionally, it's possible to review the errors in Hoptoad that occurred before and after a deploy. | ||
|
||
When Hoptoad is installed as a plugin this functionality is loaded automatically (if you have Capistrano version 2.0.0 or greater). | ||
|
||
When Hoptoad installed as a gem, you need to add | ||
require 'hoptoad_notifier/recipes/hoptoad' | ||
to your deploy.rb | ||
|
||
GOING BEYOND EXCEPTIONS | ||
|
||
You can also pass a hash to notify_hoptoad method and store whatever you want, not just an exception. And you can also use it anywhere, not just in controllers: | ||
|
||
begin | ||
params = { | ||
# params that you pass to a method that can throw an exception | ||
} | ||
my_unpredicable_method(params) | ||
rescue => e | ||
HoptoadNotifier.notify( | ||
:error_class => "Special Error", | ||
:error_message => "Special Error: #{e.message}", | ||
:request => { :params => params } | ||
) | ||
end | ||
|
||
While in your controllers you use the notify_hoptoad method, anywhere else in your code, use HoptoadNotifier.notify. Hoptoad will get all the information about the error itself. As for a hash, these are the keys you should pass: | ||
|
||
* :error_class – Use this to group similar errors together. When Hoptoad catches an exception it sends the class name of that exception object. | ||
* :error_message – This is the title of the error you see in the errors list. For exceptions it is "#{exception.class.name}: #{exception.message}" | ||
* :request – While there are several ways to send additional data to Hoptoad, passing a Hash with :params key as :request as in the example above is the most common use case. When Hoptoad catches an exception in a controller, the actual HTTP client request is being sent using this key. | ||
|
||
Hoptoad merges the hash you pass with these default options: | ||
|
||
def default_notice_options | ||
{ | ||
:api_key => HoptoadNotifier.api_key, | ||
:error_message => 'Notification', | ||
:backtrace => caller, | ||
:request => {}, | ||
:session => {}, | ||
:environment => ENV.to_hash | ||
} | ||
end | ||
|
||
You can override any of those parameters. | ||
|
||
FILTERING | ||
|
||
You can specify a whitelist of errors, that Hoptoad will not report on. Use | ||
this feature when you are so apathetic to certain errors that you don't want | ||
them even logged. | ||
|
||
This filter will only be applied to automatic notifications, not manual | ||
notifications (when #notify is called directly). | ||
|
||
Hoptoad ignores the following exceptions by default: | ||
ActiveRecord::RecordNotFound | ||
ActionController::RoutingError | ||
ActionController::InvalidAuthenticityToken | ||
CGI::Session::CookieStore::TamperedWithCookie | ||
|
||
To ignore errors in addition to those, specify their names in your Hoptoad | ||
configuration block. | ||
|
||
HoptoadNotifier.configure do |config| | ||
config.api_key = '1234567890abcdef' | ||
config.ignore << ActiveRecord::IgnoreThisError | ||
end | ||
|
||
To ignore *only* certain errors (and override the defaults), use the | ||
#ignore_only attribute. | ||
|
||
HoptoadNotifier.configure do |config| | ||
config.api_key = '1234567890abcdef' | ||
config.ignore_only = [ActiveRecord::IgnoreThisError] | ||
end | ||
|
||
To ignore certain user agents, add in the #ignore_user_agent attribute as a | ||
string or regexp: | ||
|
||
HoptoadNotifier.configure do |config| | ||
config.api_key = '1234567890abcdef' | ||
config.ignore_user_agent << /Ignored/ | ||
config.ignore_user_agent << 'IgnoredUserAgent' | ||
end | ||
|
||
To ignore exceptions based on other conditions, use #ignore_by_filter: | ||
|
||
HoptoadNotifier.configure do |config| | ||
config.api_key = '1234567890abcdef' | ||
config.ignore_by_filter do |exception_data| | ||
true if exception_data[:error_class] == "RuntimeError" | ||
end | ||
end | ||
|
||
To replace sensitive information sent to the hoptoad service with [FILTERED] use #environment_filters: | ||
|
||
HoptoadNotifier.configure do |config| | ||
config.api_key = '1234567890abcdef' | ||
config.environment_filters << "AWS_SECRET" | ||
config.environment_filters << "EC2_PRIVATE_KEY" | ||
config.environment_filters << "AWS_ACCESS" | ||
config.environment_filters << "EC2_CERT" | ||
end | ||
|
||
TESTING | ||
|
||
When you run your tests, you might notice that the hoptoad service is recording | ||
notices generated using #notify when you don't expect it to. You can | ||
use code like this in your test_helper.rb to redefine that method so those | ||
errors are not reported while running tests. | ||
|
||
module HoptoadNotifier::Catcher | ||
def notify(thing) | ||
# do nothing. | ||
end | ||
end | ||
|
||
THANKS | ||
|
||
Thanks to Eugene Bolshakov for the excellent write-up on GOING BEYOND EXCEPTIONS, which we have included above. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
require 'rake' | ||
require 'rake/testtask' | ||
require 'rake/rdoctask' | ||
|
||
desc 'Default: run unit tests.' | ||
task :default => :test | ||
|
||
desc 'Test the hoptoad_notifier plugin.' | ||
Rake::TestTask.new(:test) do |t| | ||
t.libs << 'lib' | ||
t.pattern = 'test/**/*_test.rb' | ||
t.verbose = true | ||
end | ||
|
||
desc 'Generate documentation for the hoptoad_notifier plugin.' | ||
Rake::RDocTask.new(:rdoc) do |rdoc| | ||
rdoc.rdoc_dir = 'rdoc' | ||
rdoc.title = 'HoptoadNotifier' | ||
rdoc.options << '--line-numbers' << '--inline-source' | ||
rdoc.rdoc_files.include('README') | ||
rdoc.rdoc_files.include('lib/**/*.rb') | ||
end | ||
|
||
desc 'Run ginger tests' | ||
task :ginger do | ||
$LOAD_PATH << File.join(*%w[vendor ginger lib]) | ||
ARGV.clear | ||
ARGV << 'test' | ||
load File.join(*%w[vendor ginger bin ginger]) | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
For Maintainers: | ||
|
||
When developing the Hoptoad Notifier, be sure to use the integration test | ||
against an existing project on staging before pushing to master. | ||
|
||
./script/integration_test.rb <test project's api key> <staging server hostname> | ||
./script/integration_test.rb <test project's api key> <staging server hostname> secure | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
require 'ginger' | ||
|
||
def create_scenario(version) | ||
scenario = Ginger::Scenario.new | ||
scenario[/^active_?support$/] = version | ||
scenario[/^active_?record$/] = version | ||
scenario[/^action_?pack$/] = version | ||
scenario[/^action_?controller$/] = version | ||
scenario | ||
end | ||
|
||
Ginger.configure do |config| | ||
config.aliases["active_record"] = "activerecord" | ||
config.aliases["active_support"] = "activesupport" | ||
config.aliases["action_controller"] = "actionpack" | ||
|
||
config.scenarios << create_scenario("2.0.2") | ||
config.scenarios << create_scenario("2.1.2") | ||
config.scenarios << create_scenario("2.2.2") | ||
config.scenarios << create_scenario("2.3.2") | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
puts IO.read(File.join(File.dirname(__FILE__), 'INSTALL')) |
Oops, something went wrong.