Gem for applications to automatically post errors to the Hoptoad of their choice.
A Hoptoad configuration object. Must act like a hash and return sensible values for all Hoptoad configuration options. See HoptoadNotifier::Configuration.
The sender object is responsible for delivering formatted data to the Hoptoad server. Must respond to send_to_hoptoad. See HoptoadNotifier::Sender.
# File lib/hoptoad_notifier.rb, line 102 def build_lookup_hash_for(exception, options = {}) notice = build_notice_for(exception, options) result = {} result[:action] = notice.action rescue nil result[:component] = notice.component rescue nil result[:error_class] = notice.error_class if notice.error_class result[:environment_name] = 'production' unless notice.backtrace.lines.empty? result[:file] = notice.backtrace.lines.first.file result[:line_number] = notice.backtrace.lines.first.number end result end
Call this method to modify defaults in your initializers.
@example
HoptoadNotifier.configure do |config| config.api_key = '1234567890abcdef' config.secure = false end
# File lib/hoptoad_notifier.rb, line 73 def configure(silent = false) self.configuration ||= Configuration.new yield(configuration) self.sender = Sender.new(configuration) report_ready unless silent end
Look for the Rails logger currently defined
# File lib/hoptoad_notifier.rb, line 62 def logger self.configuration.logger end
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.
# File lib/hoptoad_notifier.rb, line 91 def notify(exception, opts = {}) send_notice(build_notice_for(exception, opts)) end
Sends the notice unless it is one of the default ignored exceptions @see HoptoadNotifier.notify
# File lib/hoptoad_notifier.rb, line 97 def notify_or_ignore(exception, opts = {}) notice = build_notice_for(exception, opts) send_notice(notice) unless notice.ignore? end
Prints out the environment info to the log for debugging help
# File lib/hoptoad_notifier.rb, line 40 def report_environment_info write_verbose_log("Environment Info: #{environment_info}") end
Tell the log that the Notifier is good to go
# File lib/hoptoad_notifier.rb, line 35 def report_ready write_verbose_log("Notifier #{VERSION} ready to catch errors") end
Generated with the Darkfish Rdoc Generator 2.