exception_notification 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ed3e1aae22db5d3e8005cf160d81b2e4cbf629c
-  data.tar.gz: 12fda9fcf321b8b3c5d2fa5eb2a1c35358e03105
+  metadata.gz: f61027914f50eed12ef3c115cca8ba7a3f4f3b1e
+  data.tar.gz: 1a63465348250221f3a7d2171979a8d6b35639c1
 SHA512:
-  metadata.gz: 4cce16554760bb205c3d2f64ce7c4278f9a7e376254989d486132aec26ebe9802cd62e3dcc18eb51cc94f70d58dd40b57263777ac8e9315f18a68b09b1a335a8
-  data.tar.gz: 34578cb651e0363e1a58b08ef3bbc70187afc7fb8de9e57bfa0ad3f35e1f93dd639ff4a63b1fe148c014875fafaffea6471895c9882102a99ed0b1127c095902
+  metadata.gz: 62cf62e3500f7edb53940bbe458a5b2e1936469033c4c643ad47d4ac9d3a913bd406fb7ca37cbf0d27b4f862b5487bd5736abdd37288aaaa904a125a00bd72bf
+  data.tar.gz: 0ffc513a9fd0ce553254665abfb6da9640a4e9eb3ff5edf39aa838b9baa3caffffd76f0ffab64417721cd7c4828fdabba8c6ab9c9f47077f800845418c38db52

data/Appraisals

@@ -1,7 +1,7 @@
-rails_versions = ['~> 4.0.5', '~> 4.1.1', '~> 4.2.0', '~> 5.0.0', '~> 5.1.0']
+rails_versions = ['~> 4.0.5', '~> 4.1.1', '~> 4.2.0', '~> 5.0.0', '~> 5.1.0', '~> 5.2.0']
 
 rails_versions.each do |rails_version|
-  appraise "rails#{rails_version.slice(/\d+\.\d+/).gsub('.', '_')}" do
+  appraise "rails#{rails_version.slice(/\d+\.\d+/).tr('.', '_')}" do
     gem 'rails', rails_version
   end
 end

data/CHANGELOG.rdoc

@@ -1,3 +1,17 @@
+== 4.4.0
+
+* enhancements
+  * Rails 6 compatibility (by @shanecav)
+  * Add Datadog notifier (by @ajain0184)
+  * Use backtrace cleaner for Slack notifications (by @pomier)
+  * Add slack channel name override option (by @chaadow)
+  * Addition of sample application for testing purposes (by @ampeigonet)
+
+* bug fixes
+  * Fix error in Resque failure backend (by @EmilioCristalli)
+  * Remove sqlite dependency (by @EmilioCristalli)
+  * Configure ignore_crawlers from Rails initializer (by @EmilioCristalli)
+
 == 4.3.0
 
 * enhancements

data/CONTRIBUTING.md

@@ -18,6 +18,24 @@ need contributors to follow:
     like OS version, gem versions, etc...
   * Even better, provide a failing test case for it.
 
+To help you add information to an issue, you can use the sample_app.
+Steps to use sample_app:
+
+1) Add your configuration to (ex. with webhook):
+```ruby
+config.middleware.use ExceptionNotification::Rack,
+  # -----------------------------------
+  # Change this with your configuration
+  # https://github.com/smartinez87/exception_notification#notifiers
+                        webhook: {
+                          url: 'http://domain.com:5555/hubot/path'
+                        }
+  # -----------------------------------
+```
+
+2) Run `ruby examples/sample_app.rb`
+If exception notification is working OK, the test should pass and trigger a notification as configured above. If it's not, you can copy the information printed on the terminal related to exception notification and report an issue with more info!
+
 ## Pull Requests
 
 If you've gone the extra mile and have a patch that fixes the issue, you

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -9,7 +9,7 @@
 
 ---
 
-The Exception Notification gem provides a set of [notifiers](#notifiers) for sending notifications when errors occur in a Rack/Rails application. The built-in notifiers can deliver notifications by [email](#email-notifier), [Campfire](#campfire-notifier), [HipChat](#hipchat-notifier), [Slack](#slack-notifier), [Mattermost](#mattermost-notifier), [Teams](#teams-notifier), [IRC](#irc-notifier), [Amazon SNS](#amazon-sns-notifier), [Google Chat](#google-chat-notifier) or via custom [WebHooks](#webhook-notifier).
+The Exception Notification gem provides a set of [notifiers](#notifiers) for sending notifications when errors occur in a Rack/Rails application. The built-in notifiers can deliver notifications by [email](docs/notifiers/email.md), [Campfire](docs/notifiers/campfire.md), [HipChat](docs/notifiers/hipchat.md), [Slack](docs/notifiers/slack.md), [Mattermost](docs/notifiers/mattermost.md), [Teams](docs/notifiers/teams.md), [IRC](docs/notifiers/irc.md), [Amazon SNS](docs/notifiers/sns.md), [Google Chat](docs/notifiers/google_chat.md), [Datadog](docs/notifiers/datadog.md) or via custom [WebHooks](docs/notifiers/webhook.md).
 
 There's a great [Railscast about Exception Notification](http://railscasts.com/episodes/104-exception-notifications-revised) you can see that may help you getting started.
 
@@ -36,15 +36,15 @@ ExceptionNotification is used as a rack middleware, or in the environment you wa
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :deliver_with => :deliver, # Rails >= 4.2.1 do not need this option since it defaults to :deliver_now
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
+  email: {
+    deliver_with: :deliver, # Rails >= 4.2.1 do not need this option since it defaults to :deliver_now
+    email_prefix: '[PREFIX] ',
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
   }
 ```
 
-**Note**: In order to enable delivery notifications by email make sure you have [ActionMailer configured](#actionmailer-configuration).
+**Note**: In order to enable delivery notifications by email make sure you have [ActionMailer configured](docs/notifiers/email.md#actionmailer-configuration).
 
 ### Rack/Sinatra
 
@@ -57,10 +57,12 @@ Save the current user in the `request` using a controller callback.
 ```ruby
 class ApplicationController < ActionController::Base
   before_action :prepare_exception_notifier
+
   private
+
   def prepare_exception_notifier
     request.env["exception_notifier.exception_data"] = {
-      :current_user => current_user
+      current_user: current_user
     }
   end
 end
@@ -82,902 +84,48 @@ Options -> sections" below.
 
 ## Notifiers
 
-ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, 7 notifiers are available:
-
-* [Campfire notifier](#campfire-notifier)
-* [Email notifier](#email-notifier)
-* [HipChat notifier](#hipchat-notifier)
-* [IRC notifier](#irc-notifier)
-* [Slack notifier](#slack-notifier)
-* [Mattermost notifier](#mattermost-notifier)
-* [Teams notifier](#teams-notifier)
-* [Amazon SNS](#amazon-sns-notifier)
-* [Google Chat notifier](#google-chat-notifier)
-* [WebHook notifier](#webhook-notifier)
-
-But, you also can easily implement your own [custom notifier](#custom-notifier).
-
-### Campfire notifier
-
-This notifier sends notifications to your Campfire room.
-
-#### Usage
-
-Just add the [tinder](https://github.com/collectiveidea/tinder) gem to your `Gemfile`:
-
-```ruby
-gem 'tinder'
-```
-
-To configure it, you need to set the `subdomain`, `token` and `room_name` options, like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :campfire => {
-    :subdomain => 'my_subdomain',
-    :token => 'my_token',
-    :room_name => 'my_room'
-  }
-```
-
-#### Options
-
-##### subdomain
-
-*String, required*
-
-Your subdomain at Campfire.
-
-##### room_name
-
-*String, required*
-
-The Campfire room where the notifications must be published to.
-
-##### token
-
-*String, required*
-
-The API token to allow access to your Campfire account.
-
-
-For more options to set Campfire, like _ssl_, check [here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
-
-### Email notifier
-
-The Email notifier sends notifications by email. The notifications/emails sent includes information about the current request, session, and environment, and also gives a backtrace of the exception.
-
-After an exception notification has been delivered the rack environment variable `exception_notifier.delivered` will be set to true.
-
-#### ActionMailer configuration
-
-For the email to be sent, there must be a default ActionMailer `delivery_method` setting configured. If you do not have one, you can use the following code (assuming your app server machine has `sendmail`). Depending on the environment you want ExceptionNotification to run in, put the following code in your `config/environments/production.rb` and/or `config/environments/development.rb`:
-
-```ruby
-config.action_mailer.delivery_method = :sendmail
-# Defaults to:
-# config.action_mailer.sendmail_settings = {
-#   :location => '/usr/sbin/sendmail',
-#   :arguments => '-i -t'
-# }
-config.action_mailer.perform_deliveries = true
-config.action_mailer.raise_delivery_errors = true
-```
-
-#### Options
-
-##### sender_address
-
-*String, default: %("Exception Notifier" <exception.notifier@example.com>)*
-
-Who the message is from.
-
-##### exception_recipients
-
-*String/Array of strings/Proc, default: []*
-
-Who the message is destined for, can be a string of addresses, an array of addresses, or it can be a proc that returns a string of addresses or an array of addresses. The proc will be evaluated when the mail is sent.
-
-##### email_prefix
-
-*String, default: [ERROR]*
-
-The subject's prefix of the message.
-
-##### sections
-
-*Array of strings, default: %w(request session environment backtrace)*
-
-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:
-
-```ruby
-@kontroller     # 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 using `sections` option. You can even add new sections that
-describe application-specific data--just add the section's name to the list (wherever you'd like), and define the corresponding partial. Like the following example with two new added sections:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-    :sections => %w{my_section1 my_section2}
-  }
-```
-
-Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g. `./app/views/exception_notifier/_my_section1.text.erb`.
-
-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:
-
-```ruby
-class ApplicationController < ActionController::Base
-  before_action :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.
-
-##### background_sections
-
-*Array of strings, default: %w(backtrace data)*
-
-When using [background notifications](#background-notifications) some variables are not available in the views, like `@kontroller` and `@request`. Thus, you may want to include different sections for background notifications:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-    :background_sections => %w{my_section1 my_section2 backtrace data}
-  }
-```
-
-##### email_headers
-
-*Hash of strings, default: {}*
-
-Additionally, you may want to set customized headers on the outcoming emails. To do so, simply use the `:email_headers` option:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-    :email_headers        => { "X-Custom-Header" => "foobar" }
-  }
-```
-
-##### verbose_subject
-
-*Boolean, default: true*
-
-If enabled, include the exception message in the subject. Use `:verbose_subject => false` to exclude it.
-
-##### normalize_subject
-
-*Boolean, default: false*
-
-If enabled, remove numbers from subject so they thread as a single one. Use `:normalize_subject => true` to enable it.
-
-##### include_controller_and_action_names_in_subject
-
-*Boolean, default: true*
-
-If enabled, include the controller and action names in the subject. Use `:include_controller_and_action_names_in_subject => false` to exclude them.
-
-##### email_format
-
-*Symbol, default: :text*
-
-By default, ExceptionNotification sends emails in plain text, in order to sends multipart notifications (aka HTML emails) use `:email_format => :html`.
-
-##### delivery_method
-
-*Symbol, default: :smtp*
-
-By default, ExceptionNotification sends emails using the ActionMailer configuration of the application. In order to send emails by another delivery method, use the `delivery_method` option:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-    :delivery_method => :postmark,
-    :postmark_settings => {
-      :api_key => ENV["POSTMARK_API_KEY"]
-    }
-  }
-```
-
-Besides the `delivery_method` option, you also can customize the mailer settings by passing a hash under an option named `DELIVERY_METHOD_settings`. Thus, you can use override specific SMTP settings for notifications using:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-    :delivery_method => :smtp,
-    :smtp_settings => {
-      :user_name => "bob",
-      :password => "password",
-    }
-  }
-```
-
-A complete list of `smtp_settings` options can be found in the [ActionMailer Configuration documentation](http://api.rubyonrails.org/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Configuration+options).
-
-##### mailer_parent
-
-*String, default: ActionMailer::Base*
-
-The parent mailer which ExceptionNotification mailer inherit from.
-
-##### deliver_with
-
-*Symbol, default: :deliver_now
-
-The method name to send emalis using ActionMailer.
-
-### HipChat notifier
-
-This notifier sends notifications to your Hipchat room.
-
-#### Usage
-
-Just add the [hipchat](https://github.com/hipchat/hipchat-rb) gem to your `Gemfile`:
-
-```ruby
-gem 'hipchat'
-```
-
-To configure it, you need to set the `token` and `room_name` options, like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :hipchat => {
-    :api_token => 'my_token',
-    :room_name => 'my_room'
-  }
-```
-
-#### Options
-
-##### room_name
-
-*String, required*
-
-The HipChat room where the notifications must be published to.
-
-##### api_token
-
-*String, required*
-
-The API token to allow access to your HipChat account.
-
-##### notify
-
-*Boolean, optional*
-
-Notify users. Default : false.
-
-##### color
-
-*String, optional*
-
-Color of the message. Default : 'red'.
-
-##### from
-
-*String, optional, maximum length : 15*
-
-Message will appear from this nickname. Default : 'Exception'.
-
-##### server_url
-
-*String, optional*
-
-Custom Server URL for self-hosted, Enterprise HipChat Server
-
-For all options & possible values see [Hipchat API](https://www.hipchat.com/docs/api/method/rooms/message).
-
-### IRC notifier
-
-This notifier sends notifications to an IRC channel using the carrier-pigeon gem.
-
-#### Usage
-
-Just add the [carrier-pigeon](https://github.com/portertech/carrier-pigeon) gem to your `Gemfile`:
-
-```ruby
-gem 'carrier-pigeon'
-```
-
-To configure it, you need to set at least the 'domain' option, like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :irc => {
-    :domain => 'irc.example.com'
-  }
-```
-
-There are several other options, which are described below. For example, to use ssl and a password, add a prefix, post to the '#log' channel, and include recipients in the message (so that they will be notified), your configuration might look like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :irc => {
-    :domain => 'irc.example.com',
-    :nick => 'BadNewsBot',
-    :password => 'secret',
-    :port => 6697,
-    :channel => '#log',
-    :ssl => true,
-    :prefix => '[Exception Notification]',
-    :recipients => ['peter', 'michael', 'samir']
-  }
-
-```
-
-#### Options
-
-##### domain
-
-*String, required*
-
-The domain name of your IRC server.
-
-##### nick
-
-*String, optional*
-
-The message will appear from this nick. Default : 'ExceptionNotifierBot'.
-
-##### password
-
-*String, optional*
-
-Password for your IRC server.
-
-##### port
-
-*String, optional*
-
-Port your IRC server is listening on. Default : 6667.
-
-##### channel
-
-*String, optional*
-
-Message will appear in this channel. Default : '#log'.
-
-##### notice
-
-*Boolean, optional*
-
-Send a notice. Default : false.
-
-##### ssl
-
-*Boolean, optional*
-
-Whether to use SSL. Default : false.
-
-##### join
-
-*Boolean, optional*
-
-Join a channel. Default : false.
-
-##### recipients
-
-*Array of strings, optional*
-
-Nicks to include in the message. Default: []
-
-### Slack notifier
-
-This notifier sends notifications to a slack channel using the slack-notifier gem.
-
-#### Usage
-
-Just add the [slack-notifier](https://github.com/stevenosloan/slack-notifier) gem to your `Gemfile`:
-
-```ruby
-gem 'slack-notifier'
-```
-
-To configure it, you need to set at least the 'webhook_url' option, like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :slack => {
-    :webhook_url => "[Your webhook url]",
-    :channel => "#exceptions",
-    :additional_parameters => {
-      :icon_url => "http://image.jpg",
-      :mrkdwn => true
-    }
-  }
-```
-
-The slack notification will include any data saved under `env["exception_notifier.exception_data"]`.
-
-An example of how to send the server name to Slack in Rails (put this code in application_controller.rb):
-
-```ruby
-before_action :set_notification
-
-def set_notification
-     request.env['exception_notifier.exception_data'] = {"server" => request.env['SERVER_NAME']}
-     # can be any key-value pairs
-end
-```
-
-If you find this too verbose, you can determine to exclude certain information by doing the following:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :slack => {
-    :webhook_url => "[Your webhook url]",
-    :channel => "#exceptions",
-    :additional_parameters => {
-      :icon_url => "http://image.jpg",
-      :mrkdwn => true
-    },
-    :ignore_data_if => lambda {|key, value|
-      "#{key}" == 'key_to_ignore' || value.is_a?(ClassToBeIgnored)
-    }
-  }
-```
-
-Any evaluation to `true` will cause the key / value pair not be be sent along to Slack.
-
-#### Options
-
-##### webhook_url
-
-*String, required*
-
-The Incoming WebHook URL on slack.
-
-##### channel
-
-*String, optional*
-
-Message will appear in this channel. Defaults to the channel you set as such on slack.
-
-##### username
-
-*String, optional*
-
-Username of the bot. Defaults to the name you set as such on slack
-
-##### custom_hook
-
-*String, optional*
-
-Custom hook name. See [slack-notifier](https://github.com/stevenosloan/slack-notifier#custom-hook-name) for
-more information. Default: 'incoming-webhook'
-
-##### additional_parameters
-
-*Hash of strings, optional*
-
-Contains additional payload for a message (e.g avatar, attachments, etc). See [slack-notifier](https://github.com/stevenosloan/slack-notifier#additional-parameters) for more information.. Default: '{}'
-
-##### additional_fields
-
-*Array of Hashes, optional*
-
-Contains additional fields that will be added to the attachement. See [Slack documentation](https://api.slack.com/docs/message-attachments).
-
-### Mattermost notifier
-
-Post notification in a mattermost channel via [incoming webhook](http://docs.mattermost.com/developer/webhooks-incoming.html)
-
-Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
-
-```ruby
-gem 'httparty'
-```
-
-To configure it, you **need** to set the `webhook_url` option.
-You can also specify an other channel with `channel` option.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :mattermost => {
-    :webhook_url => 'http://your-mattermost.com/hooks/blablabla',
-    :channel => 'my-channel'
-  }
-```
-
-If you are using Github or Gitlab for issues tracking, you can specify `git_url` as follow to add a *Create issue* link in you notification.
-By default this will use your Rails application name to match the git repository. If yours differ you can specify `app_name`.
-
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :mattermost => {
-    :webhook_url => 'http://your-mattermost.com/hooks/blablabla',
-    :git_url => 'github.com/aschen'
-  }
-```
-
-You can also specify the bot name and avatar with `username` and `avatar` options.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :mattermost => {
-    :webhook_url => 'http://your-mattermost.com/hooks/blablabla',
-    :avatar => 'http://example.com/your-image.png',
-    :username => 'Fail bot'
-  }
-```
-
-Finally since the notifier use HTTParty, you can include all HTTParty options, like basic_auth for example.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :mattermost => {
-    :webhook_url => 'http://your-mattermost.com/hooks/blablabla',
-    :basic_auth => {
-      :username => 'clara',
-      :password => 'password'
-    }
-  }
-```
-
-#### Options
-
-##### webhook_url
-
-*String, required*
-
-The Incoming WebHook URL on mattermost.
-
-##### channel
-
-*String, optional*
-
-Message will appear in this channel. Defaults to the channel you set as such on mattermost.
-
-##### username
-
-*String, optional*
-
-Username of the bot. Defaults to "Incoming Webhook"
-
-##### avatar
-
-*String, optional*
-
-Avatar of the bot. Defaults to incoming webhook icon.
-
-##### git_url
-
-*String, optional*
-
-Url of your gitlab or github with your organisation name for issue creation link (Eg: `github.com/aschen`). Defaults to nil and don't add link to the notification.
-
-##### app_name
-
-*String, optional*
-
-Your application name used for issue creation link. Defaults to ``` Rails.application.class.parent_name.underscore```.
-
-### Google Chat Notifier
-
-Post notifications in a Google Chats channel via [incoming webhook](https://developers.google.com/hangouts/chat/how-tos/webhooks)
-
-Add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
-
-```ruby
-gem 'httparty'
-```
-
-To configure it, you **need** to set the `webhook_url` option.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :google_chat => {
-    :webhook_url => 'https://chat.googleapis.com/v1/spaces/XXXXXXXX/messages?key=YYYYYYYYYYYYY&token=ZZZZZZZZZZZZ'
-  }
-```
-
-##### webhook_url
-
-*String, required*
-
-The Incoming WebHook URL on Google Chats.
-
-##### app_name
-
-*String, optional*
-
-Your application name, shown in the notification. Defaults to `Rails.application.class.parent_name.underscore`.
+ExceptionNotification relies on notifiers to deliver notifications when errors occur in your applications. By default, 8 notifiers are available:
 
-### Amazon SNS Notifier
+* [Campfire notifier](docs/notifiers/campfire.md)
+* [Datadog notifier](docs/notifiers/datadog.md)
+* [Email notifier](docs/notifiers/email.md)
+* [HipChat notifier](docs/notifiers/hipchat.md)
+* [IRC notifier](docs/notifiers/irc.md)
+* [Slack notifier](docs/notifiers/slack.md)
+* [Mattermost notifier](docs/notifiers/mattermost.md)
+* [Teams notifier](docs/notifiers/teams.md)
+* [Amazon SNS](docs/notifiers/sns.md)
+* [Google Chat notifier](docs/notifiers/google_chat.md)
+* [WebHook notifier](docs/notifiers/webhook.md)
 
-Notify all exceptions Amazon - Simple Notification Service: [SNS](https://aws.amazon.com/sns/).
-
-#### Usage
-
-Add the [aws-sdk-sns](https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-sns) gem to your `Gemfile`:
-
-```ruby
-  gem 'aws-sdk-sns', '~> 1.5'
-```
-
-To configure it, you **need** to set 3 required options for aws: `region`, `access_key_id` and `secret_access_key`, and one more option for sns: `topic_arn`.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  sns: {
-    region: 'us-east-x',
-    access_key_id: 'access_key_id',
-    secret_access_key: 'secret_access_key',
-    topic_arn: 'arn:aws:sns:us-east-x:XXXX:my-topic'
-  }
-```
-
-##### sns_prefix
-*String, optional *
-
-Prefix in the notification subject, by default: "[Error]"
-
-##### backtrace_lines
-*Integer, optional *
-
-Number of backtrace lines to be displayed in the notification message. By default: 10
-
-#### Note:
-* You may need to update your previous `aws-sdk-*` gems in order to setup `aws-sdk-sns` correctly.
-* If you need any further information about the available regions or any other SNS related topic consider: [SNS faqs](https://aws.amazon.com/sns/faqs/)
-
-### Teams notifier
-
-Post notification in a Microsoft Teams channel via [Incoming Webhook Connector](https://docs.microsoft.com/en-us/outlook/actionable-messages/actionable-messages-via-connectors)
-Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
-
-```ruby
-gem 'httparty'
-```
-
-To configure it, you **need** to set the `webhook_url` option.  
-If you are using GitLab for issue tracking, you can specify `git_url` as follows to add a *Create issue* button in your notification.  
-By default this will use your Rails application name to match the git repository. If yours differs, you can specify `app_name`.  
-By that same notion, you may also set a `jira_url` to get a button that will send you to the New Issue screen in Jira.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :teams => {
-    :webhook_url => 'https://outlook.office.com/webhook/your-guid/IncomingWebhook/team-guid',
-    :git_url => 'https://your-gitlab.com/Group/Project',
-    :jira_url => 'https://your-jira.com'
-  }
-```
-
-#### Options
-
-##### webhook_url
-
-*String, required*
-
-The Incoming WebHook URL on mattermost.
-
-##### git_url
-
-*String, optional*
-
-Url of your gitlab or github with your organisation name for issue creation link (Eg: `github.com/aschen`). Defaults to nil and doesn't add link to the notification.
-
-##### jira_url
-
-*String, optional*
-
-Url of your Jira instance, adds button for Create Issue screen. Defaults to nil and doesn't add a button to the card.
-
-##### app_name
-
-*String, optional*
-
-Your application name used for git issue creation link. Defaults to `Rails.application.class.parent_name.underscore`.
-
-### WebHook notifier
-
-This notifier ships notifications over the HTTP protocol.
-
-#### Usage
-
-Just add the [HTTParty](https://github.com/jnunemaker/httparty) gem to your `Gemfile`:
-
-```ruby
-gem 'httparty'
-```
-
-To configure it, you need to set the `url` option, like this:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :webhook => {
-    :url => 'http://domain.com:5555/hubot/path'
-  }
-```
-
-By default, the WebhookNotifier will call the URLs using the POST method. But, you can change this using the `http_method` option.
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :webhook => {
-    :url => 'http://domain.com:5555/hubot/path',
-    :http_method => :get
-  }
-```
-
-Besides the `url` and `http_method` options, all the other options are passed directly to HTTParty. Thus, if the HTTP server requires authentication, you can include the following options:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :webhook => {
-    :url => 'http://domain.com:5555/hubot/path',
-    :basic_auth => {
-      :username => 'alice',
-      :password => 'password'
-    }
-  }
-```
-
-For more HTTParty options, check out the [documentation](https://github.com/jnunemaker/httparty).
-
-### Custom notifier
-
-Simply put, notifiers are objects which respond to `#call(exception, options)` method. Thus, a lambda can be used as a notifier as follow:
-
-```ruby
-ExceptionNotifier.add_notifier :custom_notifier_name,
-  ->(exception, options) { puts "Something goes wrong: #{exception.message}"}
-```
-
-More advanced users or third-party framework developers, also can create notifiers to be shipped in gems and take advantage of ExceptionNotification's Notifier API to standardize the [various](https://github.com/airbrake/airbrake) [solutions](https://www.honeybadger.io) [out](http://www.exceptional.io) [there](https://bugsnag.com). For this, beyond the `#call(exception, options)` method, the notifier class MUST BE defined under the ExceptionNotifier namespace and its name sufixed by `Notifier`, e.g: ExceptionNotifier::SimpleNotifier.
-
-#### Example
-
-Define the custom notifier:
-
-```ruby
-module ExceptionNotifier
-  class SimpleNotifier
-    def initialize(options)
-      # do something with the options...
-    end
-
-    def call(exception, options={})
-      # send the notification
-    end
-  end
-end
-```
-
-Using it:
-
-```ruby
-Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :email => {
-    :email_prefix => "[PREFIX] ",
-    :sender_address => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  },
-  :simple => {
-    # simple notifier options
-  }
-```
+But, you also can easily implement your own [custom notifier](docs/notifiers/custom.md).
 
 ## Error Grouping
-In general, exception notification will send every notification when an error occured, which may result in a problem: if your site has a high throughput and an same error raised frequently, you will receive too many notifications during a short period time, your mail box may be full of thousands of exception mails or even your mail server will be slow. To prevent this, you can choose to error errors by using `:error_grouping` option and set it to `true`.
 
-Error grouping has a default formula `log2(errors_count)` to determine if it is needed to send the notification based on the accumulated errors count for specified exception, this makes the notifier only send notification when count is: 1, 2, 4, 8, 16, 32, 64, 128, ... (2**n). You can use `:notification_trigger` to override this default formula.
+In general, ExceptionNotification will send a notification when every error occurs, which may result in a problem: if your site has a high throughput and a particular error is raised frequently, you will receive too many notifications. During a short period of time, your mail box may be filled with thousands of exception mails, or your mail server may even become slow. To prevent this, you can choose to group errors by setting the `:error_grouping` option to `true`.
+
+Error grouping uses a default formula of `log2(errors_count)` to determine whether to send the notification, based on the accumulated error count for each specific exception. This makes the notifier only send a notification when the count is: 1, 2, 4, 8, 16, 32, 64, 128, ..., (2**n). You can use `:notification_trigger` to override this default formula.
 
-The below shows options used to enable error grouping:
+The following code shows the available options to configure error grouping:
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :ignore_exceptions => ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
+  ignore_exceptions: ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
+  email:  {
+    email_prefix: '[PREFIX] ',
+    sender_address: %{"notifier" <notifier@example.com>},
+    exception_recipients: %w{exceptions@example.com}
   },
-  :error_grouping => true,
-  # :error_grouping_period => 5.minutes,    # the time before an error is regarded as fixed
-  # :error_grouping_cache => Rails.cache,   # for other applications such as Sinatra, use one instance of ActiveSupport::Cache::Store
+  error_grouping: true,
+  # error_grouping_period: 5.minutes,    # the time before an error is regarded as fixed
+  # error_grouping_cache: Rails.cache,   # for other applications such as Sinatra, use one instance of ActiveSupport::Cache::Store
   #
   # notification_trigger: specify a callback to determine when a notification should be sent,
   #   the callback will be invoked with two arguments:
   #     exception: the exception raised
   #     count: accumulated errors count for this exception
   #
-  # :notification_trigger => lambda { |exception, count| count % 10 == 0 }
+  # notification_trigger: lambda { |exception, count| count % 10 == 0 }
 ```
 
 ## Ignore Exceptions
@@ -999,12 +147,12 @@ Ignore specified exception types. To achieve that, you should use the `:ignore_e
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :ignore_exceptions => ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  }
+                                        ignore_exceptions: ['ActionView::TemplateError'] + ExceptionNotifier.ignored_exceptions,
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        }
 ```
 
 The above will make ExceptionNotifier ignore a *TemplateError* exception, plus the ones ignored by default.
@@ -1017,12 +165,12 @@ In some cases you may want to avoid getting notifications from exceptions made b
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :ignore_crawlers => %w{Googlebot bingbot},
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com}
-  }
+                                        ignore_crawlers: %w{Googlebot bingbot},
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com}
+                                        }
 ```
 
 ### :ignore_if
@@ -1033,12 +181,12 @@ Last but not least, you can ignore exceptions based on a condition. Take a look:
 
 ```ruby
 Rails.application.config.middleware.use ExceptionNotification::Rack,
-  :ignore_if => ->(env, exception) { exception.message =~ /^Couldn't find Page with ID=/ },
-  :email => {
-    :email_prefix         => "[PREFIX] ",
-    :sender_address       => %{"notifier" <notifier@example.com>},
-    :exception_recipients => %w{exceptions@example.com},
-  }
+                                        ignore_if: ->(env, exception) { exception.message =~ /^Couldn't find Page with ID=/ },
+                                        email: {
+                                          email_prefix: '[PREFIX] ',
+                                          sender_address: %{"notifier" <notifier@example.com>},
+                                          exception_recipients: %w{exceptions@example.com},
+                                        }
 ```
 
 You can make use of both the environment and the exception inside the lambda to decide wether to avoid or not sending the notification.
@@ -1072,9 +220,11 @@ You can include information about the background process that created the error
 ```ruby
 begin
   some code...
-rescue => exception
-  ExceptionNotifier.notify_exception(exception,
-    :data => {:worker => worker.to_s, :queue => queue, :payload => payload})
+rescue => e
+  ExceptionNotifier.notify_exception(
+    e,
+    data: { worker: worker.to_s, queue: queue, payload: payload}
+  )
 end
 ```
 
@@ -1083,13 +233,15 @@ end
 If your controller action manually handles an error, the notifier will never be run. To manually notify of an error you can do something like the following:
 
 ```ruby
-rescue_from Exception, :with => :server_error
+rescue_from Exception, with: :server_error
 
 def server_error(exception)
   # Whatever code that handles the exception
 
-  ExceptionNotifier.notify_exception(exception,
-    :env => request.env, :data => {:message => "was doing something wrong"})
+  ExceptionNotifier.notify_exception(
+    exception,
+    env: request.env, data: { message: 'was doing something wrong' }
+  )
 end
 ```
 
@@ -1118,29 +270,6 @@ or
 
 As above, make sure the gem is not listed solely under the `production` group, since this initializer will be loaded regardless of environment.
 
-## Versions
-
-For v4.2.1, see this tag:
-
-http://github.com/smartinez87/exception_notification/tree/v4.2.1
-
-For v4.2.0, see this tag:
-
-http://github.com/smartinez87/exception_notification/tree/v4.2.0
-
-For previous releases, visit:
-
-https://github.com/smartinez87/exception_notification/tags
-
-If you are running Rails 2.3 then see the branch for that:
-
-http://github.com/smartinez87/exception_notification/tree/2-3-stable
-
-If you are running pre-rack Rails then see this tag:
-
-http://github.com/smartinez87/exception_notification/tree/pre-2-3
-
-
 ## Support and tickets
 
 Here's the list of [issues](https://github.com/smartinez87/exception_notification/issues) we're currently working on.