Module: HoptoadNotifier

Classes and Modules

Module HoptoadNotifier::Rails
Class HoptoadNotifier::Backtrace
Class HoptoadNotifier::Configuration
Class HoptoadNotifier::Notice
Class HoptoadNotifier::Rack
Class HoptoadNotifier::Railtie
Class HoptoadNotifier::Sender
Class HoptoadNotifier::UserInformer

Constants

 "2.0"
 "** [Hoptoad] "
 {     'Content-type'             => 'text/xml',     'Accept'                   => 'text/xml, application/xml'
 "2.4.11".freeze
 ['ActiveRecord::RecordNotFound',                       'ActionController::RoutingError',                       'ActionController::InvalidAuthenticityToken',                       'CGI::Session::CookieStore::TamperedWithCookie',                       'ActionController::UnknownAction',                       'AbstractController::ActionNotFound']

External Aliases

secure -> secure?

Attributes

configuration	[RW]	A Hoptoad configuration object. Must act like a hash and return sensible values for all Hoptoad configuration options. See HoptoadNotifier::Configuration.
sender	[RW]	The sender object is responsible for delivering formatted data to the Hoptoad server. Must respond to send_to_hoptoad. See HoptoadNotifier::Sender.

Public Class methods

build_lookup_hash_for(exception, options = {})

configure(silent = false) {|configuration| ...}

Call this method to modify defaults in your initializers.

@example

  HoptoadNotifier.configure do |config|
    config.api_key = '1234567890abcdef'
    config.secure  = false
  end

environment_info()

Returns the Ruby version, Rails version, and current Rails environment

logger()

Look for the Rails logger currently defined

new()

notify(exception, opts = {})

Sends an exception manually using this method, even when you are not in a controller.

@param [Exception] exception The exception you want to notify Hoptoad about. @param [Hash] opts Data that will be sent to Hoptoad.

@option opts [String] :api_key The API key for this project. The API key is a unique identifier that Hoptoad uses for identification. @option opts [String] :error_message The error returned by the exception (or the message you want to log). @option opts [String] :backtrace A backtrace, usually obtained with caller. @option opts [String] :request The controller‘s request object. @option opts [String] :session The contents of the user‘s session. @option opts [String] :environment ENV merged with the contents of the request‘s environment.

notify_or_ignore(exception, opts = {})

Sends the notice unless it is one of the default ignored exceptions @see HoptoadNotifier.notify

report_environment_info()

Prints out the environment info to the log for debugging help

report_ready()

Tell the log that the Notifier is good to go

report_response_body(response)

Prints out the response body from Hoptoad for debugging help

write_verbose_log(message)

Writes out the given message to the logger

Public Instance methods

[](option)

Allows config options to be read like a hash

@param [Symbol] option Key for a given attribute

environment_filters()

filter_backtrace(&block)

Takes a block and adds it to the list of backtrace filters. When the filters run, the block will be handed each line of the backtrace and can modify it as necessary.

@example

  config.filter_bracktrace do |line|
    line.gsub(/^#{Rails.root}/, "[RAILS_ROOT]")
  end

@param [Proc] block The new backtrace filter. @yieldparam [String] line A line in the backtrace.

ignore_by_filter(&block)

Takes a block and adds it to the list of ignore filters. When the filters run, the block will be handed the exception. @example

  config.ignore_by_filter do |exception_data|
    true if exception_data[:error_class] == "RuntimeError"
  end

@param [Proc] block The new ignore filter @yieldparam [Hash] data The exception data given to +HoptoadNotifier.notify+ @yieldreturn [Boolean] If the block returns true the exception will be ignored, otherwise it will be processed by hoptoad.

ignore_only=(names)

Overrides the list of default ignored errors.

@param [Array<Exception>] names A list of exceptions to ignore.

ignore_user_agent_only=(names)

Overrides the list of default ignored user agents

@param [Array<String>] A list of user agents to ignore

js_notifier=(*args)

merge(hash)

Returns a hash of all configurable options merged with hash

@param [Hash] hash A set of configuration options that will take precedence over the defaults

port()

protocol()