Class: Bugsnag::Notification
- Inherits:
-
Object
- Object
- Bugsnag::Notification
- Includes:
- HTTParty
- 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 =
/^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/
- MAX_EXCEPTIONS_TO_UNWRAP =
5
- SUPPORTED_SEVERITIES =
["fatal", "error", "warning", "info"]
Instance Attribute Summary collapse
-
#configuration ⇒ Object
Returns the value of attribute configuration.
-
#context ⇒ Object
Returns the value of attribute context.
-
#user ⇒ Object
Returns the value of attribute user.
Class Method Summary collapse
Instance Method Summary collapse
-
#add_custom_data(name, value) ⇒ Object
Add a single value as custom data, to this notification.
-
#add_tab(name, value) ⇒ Object
Add a new tab to this notification.
- #api_key ⇒ Object
- #api_key=(api_key) ⇒ Object
-
#deliver ⇒ Object
Deliver this notification to bugsnag.com Also runs through the middleware as required.
- #exceptions ⇒ Object
- #ignore? ⇒ Boolean
-
#initialize(exception, configuration, overrides = nil, request_data = nil) ⇒ Notification
constructor
A new instance of Notification.
-
#remove_tab(name) ⇒ Object
Remove a tab from this notification.
- #request_data ⇒ Object
- #severity ⇒ Object
- #severity=(severity) ⇒ Object
- #user_id ⇒ Object
- #user_id=(user_id) ⇒ Object
Constructor Details
#initialize(exception, configuration, overrides = nil, request_data = nil) ⇒ Notification
Returns a new instance of Notification.
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 |
# File 'lib/bugsnag/notification.rb', line 52 def initialize(exception, configuration, overrides = nil, request_data = nil) @configuration = configuration @overrides = Bugsnag::Helpers.(overrides) || {} @request_data = request_data @meta_data = {} @user = {} self.severity = @overrides[:severity] @overrides.delete :severity if @overrides.key? :api_key self.api_key = @overrides[:api_key] @overrides.delete :api_key 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 unless ex.is_a? Exception Bugsnag.warn("Converting non-Exception to RuntimeError: #{ex.inspect}") ex = RuntimeError.new(ex.to_s) end 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 self.class.http_proxy(configuration.proxy_host, configuration.proxy_port, configuration.proxy_user, configuration.proxy_password) if configuration.proxy_host self.class.default_timeout(configuration.timeout) if configuration.timeout 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 |
#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(endpoint, payload) ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/bugsnag/notification.rb', line 29 def deliver_exception_payload(endpoint, payload) begin payload_string = Bugsnag::Helpers.dump_json(payload) # If the payload is going to be too long, we trim the hashes to send # a minimal payload instead 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 response = post(endpoint, {:body => payload_string}) Bugsnag.debug("Notification to #{endpoint} finished, response was #{response.code}, payload was #{payload_string}") rescue StandardError => e # KLUDGE: Since we don't re-raise http exceptions, this breaks rspec raise if e.class.to_s == "RSpec::Expectations::ExpectationNotMetError" Bugsnag.warn("Notification to #{endpoint} failed, #{e.inspect}") Bugsnag.warn(e.backtrace) end end |
Instance Method Details
#add_custom_data(name, value) ⇒ Object
Add a single value as custom data, to this notification
101 102 103 104 |
# File 'lib/bugsnag/notification.rb', line 101 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
107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/bugsnag/notification.rb', line 107 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
150 151 152 |
# File 'lib/bugsnag/notification.rb', line 150 def api_key @api_key ||= @configuration.api_key end |
#api_key=(api_key) ⇒ Object
146 147 148 |
# File 'lib/bugsnag/notification.rb', line 146 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.
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 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 |
# File 'lib/bugsnag/notification.rb', line 155 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 # 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].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, :exceptions => exception_list, :severity => self.severity, :metaData => Bugsnag::Helpers.cleanup_obj((@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] } self.class.deliver_exception_payload(endpoint, payload) end end |
#exceptions ⇒ Object
236 237 238 |
# File 'lib/bugsnag/notification.rb', line 236 def exceptions @exceptions end |
#ignore? ⇒ Boolean
228 229 230 |
# File 'lib/bugsnag/notification.rb', line 228 def ignore? ignore_exception_class? || ignore_user_agent? end |
#remove_tab(name) ⇒ Object
Remove a tab from this notification
120 121 122 123 124 |
# File 'lib/bugsnag/notification.rb', line 120 def remove_tab(name) return if name.nil? @meta_data.delete(name.to_sym) end |
#request_data ⇒ Object
232 233 234 |
# File 'lib/bugsnag/notification.rb', line 232 def request_data @request_data || Bugsnag.configuration.request_data end |
#severity ⇒ Object
142 143 144 |
# File 'lib/bugsnag/notification.rb', line 142 def severity @severity || "error" end |
#severity=(severity) ⇒ Object
138 139 140 |
# File 'lib/bugsnag/notification.rb', line 138 def severity=(severity) @severity = severity if SUPPORTED_SEVERITIES.include?(severity) end |
#user_id ⇒ Object
130 131 132 |
# File 'lib/bugsnag/notification.rb', line 130 def user_id @user[:id] end |
#user_id=(user_id) ⇒ Object
126 127 128 |
# File 'lib/bugsnag/notification.rb', line 126 def user_id=(user_id) @user[:id] = user_id end |