Class: Bugsnag::Notification

Inherits:
Object
  • Object
show all
Defined in:
lib/bugsnag/notification.rb

Constant Summary collapse

NOTIFIER_NAME = 
"Ruby Bugsnag Notifier"
NOTIFIER_VERSION = 
Bugsnag::VERSION
NOTIFIER_URL = 
"http://www.bugsnag.com"
API_KEY_REGEX = 
/[0-9a-f]{32}/i
BACKTRACE_LINE_REGEX =

e.g. “org/jruby/RubyKernel.java:1264:in ‘catch’”

/^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/
JAVA_BACKTRACE_REGEX =

e.g. “org.jruby.Ruby.runScript(Ruby.java:807)”

/^(.*)\((.*)(?::([0-9]+))?\)$/
MAX_EXCEPTIONS_TO_UNWRAP = 
5
SUPPORTED_SEVERITIES = 
["error", "warning", "info"]
CURRENT_PAYLOAD_VERSION = 
"2"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(exception, configuration, overrides = nil, request_data = nil) ⇒ Notification

Returns a new instance of Notification.



44
45
46
47
48
49
50
51
52
53
54
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
 
# File 'lib/bugsnag/notification.rb', line 44

def initialize(exception, configuration, overrides = nil, request_data = nil)
  @configuration = configuration
  @overrides = Bugsnag::Helpers.flatten_meta_data(overrides) || {}
  @request_data = request_data
  @meta_data = {}
  @user = {}
  @should_ignore = false

  self.severity = @overrides[:severity]
  @overrides.delete :severity

  if @overrides.key? :grouping_hash
    self.grouping_hash = @overrides[:grouping_hash]
    @overrides.delete :grouping_hash
  end

  if @overrides.key? :api_key
    self.api_key = @overrides[:api_key]
    @overrides.delete :api_key
  end

  if @overrides.key? :delivery_method
    @delivery_method = @overrides[:delivery_method]
    @overrides.delete :delivery_method
  end

  # Unwrap exceptions
  @exceptions = []

  ex = exception
  while ex != nil && !@exceptions.include?(ex) && @exceptions.length < MAX_EXCEPTIONS_TO_UNWRAP

    unless ex.is_a? Exception
      if ex.respond_to?(:to_exception)
        ex = ex.to_exception
      elsif ex.respond_to?(:exception)
        ex = ex.exception
      end
    end

    unless ex.is_a?(Exception) || (defined?(Java::JavaLang::Throwable) && ex.is_a?(Java::JavaLang::Throwable))
      Bugsnag.warn("Converting non-Exception to RuntimeError: #{ex.inspect}")
      ex = RuntimeError.new(ex.to_s)
    end

    @exceptions << ex

    if ex.respond_to?(:cause) && ex.cause
      ex = ex.cause
    elsif ex.respond_to?(:continued_exception) && ex.continued_exception
      ex = ex.continued_exception
    elsif ex.respond_to?(:original_exception) && ex.original_exception
      ex = ex.original_exception
    else
      ex = nil
    end
  end
end

Instance Attribute Details

#configuration ⇒ Object

Returns the value of attribute configuration.



26
27
28
 
# File 'lib/bugsnag/notification.rb', line 26

def configuration
  @configuration
end

#context ⇒ Object

Returns the value of attribute context.



24
25
26
 
# File 'lib/bugsnag/notification.rb', line 24

def context
  @context
end

#meta_data ⇒ Object

Returns the value of attribute meta_data.



27
28
29
 
# File 'lib/bugsnag/notification.rb', line 27

def meta_data
  @meta_data
end

#user ⇒ Object

Returns the value of attribute user.



25
26
27
 
# File 'lib/bugsnag/notification.rb', line 25

def user
  @user
end

Class Method Details

.deliver_exception_payload(url, payload, configuration = Bugsnag.configuration, delivery_method = nil) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/bugsnag/notification.rb', line 30

def deliver_exception_payload(url, payload, configuration=Bugsnag.configuration, delivery_method=nil)

  # If the payload is going to be too long, we trim the hashes to send
  # a minimal payload instead
  payload_string = Bugsnag::Helpers.dump_json(payload)
  if payload_string.length > 128000
    payload[:events].each {|e| e[:metaData] = Bugsnag::Helpers.reduce_hash_size(e[:metaData])}
    payload_string = Bugsnag::Helpers.dump_json(payload)
  end

  Bugsnag::Delivery[delivery_method || configuration.delivery_method].deliver(url, payload_string, configuration)
end

Instance Method Details

#add_custom_data(name, value) ⇒ Object

Add a single value as custom data, to this notification



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

def add_custom_data(name, value)
  @meta_data[:custom] ||= {}
  @meta_data[:custom][name.to_sym] = value
end

#add_tab(name, value) ⇒ Object

Add a new tab to this notification



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/bugsnag/notification.rb', line 110

def add_tab(name, value)
  return if name.nil?

  if value.is_a? Hash
    @meta_data[name.to_sym] ||= {}
    @meta_data[name.to_sym].merge! value
  else
    self.add_custom_data(name, value)
    Bugsnag.warn "Adding a tab requires a hash, adding to custom tab instead (name=#{name})"
  end
end

#api_key ⇒ Object 



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

def api_key
  @api_key ||= @configuration.api_key
end

#api_key=(api_key) ⇒ Object 



162
163
164
 
# File 'lib/bugsnag/notification.rb', line 162

def api_key=(api_key)
  @api_key = api_key
end

#deliver ⇒ Object

Deliver this notification to bugsnag.com Also runs through the middleware as required.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/bugsnag/notification.rb', line 171

def deliver
  return unless @configuration.should_notify?

  # Check we have at least an api_key
  if api_key.nil?
    Bugsnag.warn "No API key configured, couldn't notify"
    return
  elsif api_key !~ API_KEY_REGEX
    Bugsnag.warn "Your API key (#{api_key}) is not valid, couldn't notify"
    return
  end

  # Warn if no release_stage is set
  Bugsnag.warn "You should set your app's release_stage (see https://bugsnag.com/docs/notifiers/ruby#release_stage)." unless @configuration.release_stage

  @meta_data = {}

  # Run the middleware here, at the end of the middleware stack, execute the actual delivery
  @configuration.middleware.run(self) do
    # At this point the callbacks have already been run.
    # This supports self.ignore! for before_notify_callbacks.
    return if @should_ignore

    # Now override the required fields
    exceptions.each do |exception|
      if exception.class.include?(Bugsnag::MetaData)
        if exception.bugsnag_user_id.is_a?(String)
          self.user_id = exception.bugsnag_user_id
        end
        if exception.bugsnag_context.is_a?(String)
          self.context = exception.bugsnag_context
        end
      end
    end

    [:user_id, :context, :user, :grouping_hash].each do |symbol|
      if @overrides[symbol]
        self.send("#{symbol}=", @overrides[symbol])
        @overrides.delete symbol
      end
    end

    # Build the endpoint url
    endpoint = (@configuration.use_ssl ? "https://" : "http://") + @configuration.endpoint
    Bugsnag.log("Notifying #{endpoint} of #{@exceptions.last.class} from api_key #{api_key}")

    # Build the payload's exception event
    payload_event = {
      :app => {
        :version => @configuration.app_version,
        :releaseStage => @configuration.release_stage,
        :type => @configuration.app_type
      },
      :context => self.context,
      :user => @user,
      :payloadVersion => payload_version,
      :exceptions => exception_list,
      :severity => self.severity,
      :groupingHash => self.grouping_hash,
      :metaData => Bugsnag::Helpers.cleanup_obj(generate_meta_data(@exceptions, @overrides), @configuration.params_filters)
    }.reject {|k,v| v.nil? }

    payload_event[:device] = {:hostname => @configuration.hostname} if @configuration.hostname

    # Build the payload hash
    payload = {
      :apiKey => api_key,
      :notifier => {
        :name => NOTIFIER_NAME,
        :version => NOTIFIER_VERSION,
        :url => NOTIFIER_URL
      },
      :events => [payload_event]
    }

    # Deliver the payload
    self.class.deliver_exception_payload(endpoint, payload, @configuration, @delivery_method)
  end
end

#exceptions ⇒ Object 



259
260
261
 
# File 'lib/bugsnag/notification.rb', line 259

def exceptions
  @exceptions
end

#grouping_hash ⇒ Object 



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

def grouping_hash
  @grouping_hash || nil
end

#grouping_hash=(grouping_hash) ⇒ Object 



154
155
156
 
# File 'lib/bugsnag/notification.rb', line 154

def grouping_hash=(grouping_hash)
  @grouping_hash = grouping_hash
end

#ignore! ⇒ Object 



263
264
265
 
# File 'lib/bugsnag/notification.rb', line 263

def ignore!
  @should_ignore = true
end

#ignore? ⇒ Boolean

Returns:

  • (Boolean) 


251
252
253
 
# File 'lib/bugsnag/notification.rb', line 251

def ignore?
  @should_ignore || ignore_exception_class? || ignore_user_agent?
end

#payload_version ⇒ Object 



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

def payload_version
  CURRENT_PAYLOAD_VERSION
end

#remove_tab(name) ⇒ Object

Remove a tab from this notification



123
124
125
126
127
 
# File 'lib/bugsnag/notification.rb', line 123

def remove_tab(name)
  return if name.nil?

  @meta_data.delete(name.to_sym)
end

#request_data ⇒ Object 



255
256
257
 
# File 'lib/bugsnag/notification.rb', line 255

def request_data
  @request_data || Bugsnag.configuration.request_data
end

#severity ⇒ Object 



146
147
148
 
# File 'lib/bugsnag/notification.rb', line 146

def severity
  @severity || "warning"
end

#severity=(severity) ⇒ Object 



142
143
144
 
# File 'lib/bugsnag/notification.rb', line 142

def severity=(severity)
  @severity = severity if SUPPORTED_SEVERITIES.include?(severity)
end

#user_id ⇒ Object 



133
134
135
 
# File 'lib/bugsnag/notification.rb', line 133

def user_id
  @user[:id]
end

#user_id=(user_id) ⇒ Object 



129
130
131
 
# File 'lib/bugsnag/notification.rb', line 129

def user_id=(user_id)
  @user[:id] = user_id
end