Module: Bugsnag

Defined in:
lib/bugsnag.rb,
lib/bugsnag/rack.rb,
lib/bugsnag/rails.rb,
lib/bugsnag/resque.rb,
lib/bugsnag/helpers.rb,
lib/bugsnag/mailman.rb,
lib/bugsnag/railtie.rb,
lib/bugsnag/sidekiq.rb,
lib/bugsnag/version.rb,
lib/bugsnag/meta_data.rb,
lib/bugsnag/capistrano.rb,
lib/bugsnag/delay/resque.rb,
lib/bugsnag/notification.rb,
lib/bugsnag/configuration.rb,
lib/bugsnag/middleware_stack.rb

Defined Under Namespace

Modules: Capistrano, Delay, Helpers, MetaData, Middleware, Rails, Rake Classes: Configuration, Mailman, MiddlewareStack, Notification, Rack, Railtie, Resque, Sidekiq

Constant Summary collapse

LOG_PREFIX = 
"** [Bugsnag] "
VERSION = 
File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip

Class Method Summary collapse

Class Method Details

.after_notify_callbacks ⇒ Object

Allow access to “after notify” callbacks



105
106
107
 
# File 'lib/bugsnag.rb', line 105

def after_notify_callbacks
  Bugsnag.configuration.request_data[:after_callbacks] ||= []
end

.auto_notify(exception, overrides = nil, request_data = nil) ⇒ Object

Auto notify of an exception, called from rails and rack exception rescuers, unless auto notification is disabled, or we should ignore this error class



63
64
65
 
# File 'lib/bugsnag.rb', line 63

def auto_notify(exception, overrides=nil, request_data=nil)
  notify_or_ignore(exception, overrides, request_data) if configuration.auto_notify
end

.before_notify_callbacks ⇒ Object

Allow access to “before notify” callbacks



100
101
102
 
# File 'lib/bugsnag.rb', line 100

def before_notify_callbacks
  Bugsnag.configuration.request_data[:before_callbacks] ||= []
end

.clear_request_data ⇒ Object

Clear all “per-request” data, temporal data for use in bugsnag middleware This method should be called after each distinct request or session ends Eg. After completing a page request in a web app



95
96
97
 
# File 'lib/bugsnag.rb', line 95

def clear_request_data
  Bugsnag.configuration.clear_request_data
end

.configuration ⇒ Object

Configuration getters



83
84
85
 
# File 'lib/bugsnag.rb', line 83

def configuration
  @configuration ||= Bugsnag::Configuration.new
end

.configure(config_hash = nil) {|configuration| ... } ⇒ Object

Configure the Bugsnag notifier application-wide settings.

Yields:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/bugsnag.rb', line 24

def configure(config_hash=nil)
  if config_hash
    config_hash.each do |k,v|
      configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
    end
  end

  yield(configuration) if block_given?

  # Use resque for asynchronous notification if required
  require "bugsnag/delay/resque" if configuration.delay_with_resque && defined?(Resque)

  # Log that we are ready to rock
  if configuration.api_key && !@logged_ready
    log "Bugsnag exception handler #{VERSION} ready, api_key=#{configuration.api_key}"
    @logged_ready = true
  end
end

.debug(message) ⇒ Object

Debug logger



78
79
80
 
# File 'lib/bugsnag.rb', line 78

def debug(message)
  configuration.logger.info("#{LOG_PREFIX}#{message}") if configuration.debug
end

.log(message) ⇒ Object

Log wrapper



68
69
70
 
# File 'lib/bugsnag.rb', line 68

def log(message)
  configuration.logger.info("#{LOG_PREFIX}#{message}")
end

.notify(exception, overrides = nil, request_data = nil) ⇒ Object

Explicitly notify of an exception



44
45
46
 
# File 'lib/bugsnag.rb', line 44

def notify(exception, overrides=nil, request_data=nil)
  Notification.new(exception, configuration, overrides, request_data).deliver
end

.notify_or_ignore(exception, overrides = nil, request_data = nil) ⇒ Object

Notify of an exception unless it should be ignored



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bugsnag.rb', line 49

def notify_or_ignore(exception, overrides=nil, request_data=nil)
  notification = Notification.new(exception, configuration, overrides, request_data)

  unless notification.ignore?
    notification.deliver
    notification
  else
    false
  end
end

.set_request_data(key, value) ⇒ Object

Set “per-request” data, temporal data for use in bugsnag middleware



88
89
90
 
# File 'lib/bugsnag.rb', line 88

def set_request_data(key, value)
  Bugsnag.configuration.set_request_data(key, value)
end

.warn(message) ⇒ Object

Warning logger



73
74
75
 
# File 'lib/bugsnag.rb', line 73

def warn(message)
  configuration.logger.warn("#{LOG_PREFIX}#{message}")
end