Module: Bugsnag

Defined in:
lib/bugsnag.rb,
lib/bugsnag/report.rb,
lib/bugsnag/cleaner.rb,
lib/bugsnag/helpers.rb,
lib/bugsnag/version.rb,
lib/bugsnag/delivery.rb,
lib/bugsnag/meta_data.rb,
lib/bugsnag/stacktrace.rb,
lib/bugsnag/configuration.rb,
lib/bugsnag/session_tracker.rb,
lib/bugsnag/middleware_stack.rb,
lib/bugsnag/integrations/rack.rb,
lib/bugsnag/integrations/resque.rb,
lib/bugsnag/delivery/synchronous.rb,
lib/bugsnag/integrations/mailman.rb,
lib/bugsnag/integrations/railtie.rb,
lib/bugsnag/integrations/sidekiq.rb,
lib/bugsnag/delivery/thread_queue.rb,
lib/bugsnag/integrations/shoryuken.rb

Defined Under Namespace

Modules: Delivery, Helpers, MetaData, Middleware, Rails Classes: Cleaner, Configuration, Mailman, MiddlewareStack, Rack, Railtie, Report, Resque, SessionTracker, Shoryuken, Sidekiq, Stacktrace

Constant Summary collapse

LOCK = 
Mutex.new
INTEGRATIONS = 
[:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que]
NIL_EXCEPTION_DESCRIPTION = 
"'nil' was notified as an exception"
VERSION = 
File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip

Class Method Summary collapse

Class Method Details

.at_exit_handler_installed? ⇒ Boolean

Checks if an at_exit handler has been added

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/bugsnag.rb', line 136

def at_exit_handler_installed?
  @exit_handler_added ||= false
end

.before_notify_callbacks ⇒ Object

Allow access to “before notify” callbacks as an array.

These callbacks will be called whenever an error notification is being made.



167
168
169
 
# File 'lib/bugsnag.rb', line 167

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

.configuration ⇒ Object

Configuration getters

Returns the client’s Configuration object, or creates one if not yet created.



143
144
145
146
 
# File 'lib/bugsnag.rb', line 143

def configuration
  @configuration = nil unless defined?(@configuration)
  @configuration || LOCK.synchronize { @configuration ||= Bugsnag::Configuration.new }
end

.configure(validate_api_key = true) {|configuration| ... } ⇒ Object

Configure the Bugsnag notifier application-wide settings.

Yields a configuration object to use to set application settings.

Yields:



43
44
45
46
47
48
49
 
# File 'lib/bugsnag.rb', line 43

def configure(validate_api_key=true)
  yield(configuration) if block_given?

  check_key_valid if validate_api_key

  register_at_exit
end

.load_integration(integration) ⇒ Object

Load a specific integration



183
184
185
186
187
188
189
190
 
# File 'lib/bugsnag.rb', line 183

def load_integration(integration)
  integration = :railtie if integration == :rails
  if INTEGRATIONS.include?(integration) || integration == :railtie
    require "bugsnag/integrations/#{integration}"
  else
    configuration.debug("Integration #{integration} is not currently supported")
  end
end

.load_integrations ⇒ Object

Attempts to load all integrations through auto-discovery



172
173
174
175
176
177
178
179
180
 
# File 'lib/bugsnag.rb', line 172

def load_integrations
  require "bugsnag/integrations/railtie" if defined?(Rails::Railtie)
  INTEGRATIONS.each do |integration|
    begin
      require "bugsnag/integrations/#{integration}"
    rescue LoadError
    end
  end
end

.notify(exception, auto_notify = false) {|report| ... } ⇒ Object

Explicitly notify of an exception.

Optionally accepts a block to append metadata to the yielded report.

Yields:

  • (report) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bugsnag.rb', line 55

def notify(exception, auto_notify=false, &block)
  unless auto_notify.is_a? TrueClass or auto_notify.is_a? FalseClass
    configuration.warn("Adding metadata/severity using a hash is no longer supported, please use block syntax instead")
    auto_notify = false
  end

  return unless deliver_notification?(exception, auto_notify)

  exception = NIL_EXCEPTION_DESCRIPTION if exception.nil?

  report = Report.new(exception, configuration, auto_notify)

  # If this is an auto_notify we yield the block before the any middleware is run
  yield(report) if block_given? && auto_notify
  if report.ignore?
    configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in auto_notify block")
    return
  end

  # Run internal middleware
  configuration.internal_middleware.run(report)
  if report.ignore?
    configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in internal middlewares")
    return
  end

  # Store before_middleware severity reason for future reference
  initial_severity = report.severity
  initial_reason = report.severity_reason

  # Run users middleware
  configuration.middleware.run(report) do
    if report.ignore?
      configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in user provided middleware")
      return
    end

    # If this is not an auto_notify then the block was provided by the user. This should be the last
    # block that is run as it is the users "most specific" block.
    yield(report) if block_given? && !auto_notify
    if report.ignore?
      configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in user provided block")
      return
    end

    # Test whether severity has been changed and ensure severity_reason is consistant in auto_notify case
    if report.severity != initial_severity
      report.severity_reason = {
        :type => Report::USER_CALLBACK_SET_SEVERITY
      }
    else
      report.severity_reason = initial_reason
    end

    # Deliver
    configuration.info("Notifying #{configuration.endpoint} of #{report.exceptions.last[:errorClass]}")
    options = {:headers => report.headers}
    payload = ::JSON.dump(Bugsnag::Helpers.trim_if_needed(report.as_json))
    Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.endpoint, payload, configuration, options)
  end
end

.register_at_exit ⇒ Object

Registers an at_exit function to automatically catch errors on exit



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/bugsnag.rb', line 119

def register_at_exit
  return if at_exit_handler_installed?
  @exit_handler_added = true
  at_exit do
    if $!
      Bugsnag.notify($!, true) do |report|
        report.severity = 'error'
        report.severity_reason = {
          :type => Bugsnag::Report::UNHANDLED_EXCEPTION
        }
      end
    end
  end
end

.session_tracker ⇒ Object

Returns the client’s SessionTracker object, or creates one if not yet created.



150
151
152
153
 
# File 'lib/bugsnag.rb', line 150

def session_tracker
  @session_tracker = nil unless defined?(@session_tracker)
  @session_tracker || LOCK.synchronize { @session_tracker ||= Bugsnag::SessionTracker.new}
end

.start_session ⇒ Object

Starts a session.

Allows Bugsnag to track error rates across releases.



159
160
161
 
# File 'lib/bugsnag.rb', line 159

def start_session
  session_tracker.start_session
end