bugsnag 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0293abdf77561e74847883fc613ca6dc008cebab
-  data.tar.gz: 619d14f7854cfc80f580d3d02737f1df3e67b661
+  metadata.gz: 3eb0d383ce8b03fd84cafce08eb5e087a6163fe7
+  data.tar.gz: 09433fa6a18a8f972a6fc8fbd27327e9820279b3
 SHA512:
-  metadata.gz: cf05cd8421771e2af00139da267a9bdb3f29104d1cc9b20974db805677582676289e5f2ffaf8248ca4d9b660aa879b0099a85fbdc1e0709859d26b6da170f0b3
-  data.tar.gz: f3b7696c70a8eedf524ab3a8bfdac71a0e6dfd8f3c823270a51f7a3f1a20c46321cfdf4e03a3490193e8ad7e9c3b0071f81e2e78f1d04208eda214945a65c1d3
+  metadata.gz: 7b6ce5c4483f4ee3d40b55a624d6f82762e71d42328ee89158cdabdc33addc3b68e935807a3e3194c5bb4161e28c184a9e0a7bd93151b4054333e08231c2cc37
+  data.tar.gz: fbe2f141ffd43808aedf115121774fbdf2a465bea5be05a9bea456705bc14d1c155665998ae6d3dfb7b327b411f5fe902eafd67b82449b2865ad92710d109190

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+2.5.0
+-----
+-   Allow access to the metadata object in before bugsnag notify callbacks
+-   Dont send the rack env by default
+
 2.4.1
 ------
 

data/README.md

@@ -83,9 +83,7 @@ exceptions, to help debug problems.
 
 ### Rails Apps
 
-In any rails controller you can define a `before_bugsnag_notify` callback,
-which allows you to add this additional data by calling `add_tab` on the
-exception notification object.
+In any rails controller you can define a `before_bugsnag_notify` callback, which allows you to add this additional data by calling `add_tab` on the exception notification object. Please see the [Notification Object](#notification-object) for details on the notification parameter.
 
 ```ruby
 class MyController < ApplicationController
@@ -115,10 +113,7 @@ end
 
 ### Other Ruby Apps
 
-In other ruby apps, you can provide lambda functions to execute before any
-`Bugsnag.notify` calls as follows. Don't forget to clear the callbacks at the
-end of each request or session. In Rack applications like Sinatra, however, the
-gem will clear the callbacks for you.
+In other ruby apps, you can provide lambda functions to execute before any `Bugsnag.notify` calls as follows. Don't forget to clear the callbacks at the end of each request or session. In Rack applications like Sinatra, this is automatically done for you.
 
 ```ruby
 # Set a before notify callback
@@ -134,6 +129,90 @@ Bugsnag.before_notify_callbacks << lambda {|notif|
 Bugsnag.before_notify_callbacks.clear
 ```
 
+### Notification Object
+
+The notification object is passed to all [before bugsnag notify](#sending-custom-data-with-exceptions) callbacks and is used to manipulate the error report before it is transmitted.
+
+#### add_tab
+
+Call add_tab on a notification object to add a tab to the error report so that it would appear on your dashboard.
+
+```ruby
+notif.add_tab(:user_info, {
+  name: current_user.name
+})
+```
+
+The first parameter is the tab name that will appear in the error report and the second is the key, value list that will be displayed in the tab.
+
+#### remove_tab
+
+Removes a tab completely from the error report
+
+```ruby
+notif.remove_tab(:request)
+```
+
+#### ignore!
+
+Calling ignore! on a notification object will cause the notification to not be sent to bugsnag. This means that you can choose dynamically not to send an error depending on application state or the error itself.
+
+```ruby
+notif.ignore! if foo == 'bar'
+```
+
+#### grouping_hash
+
+Sets the grouping hash of the error report. All errors with the same grouping hash are grouped together. This is an advanced usage of the library and mis-using it will cause your errors not to group properly in your dashboard.
+
+```ruby
+notif.grouping_hash = "#{exception.message}#{exception.class}"
+```
+
+#### severity
+
+Set the severity of the error. Severity can be `error`, `warning` or `info`.
+
+```ruby
+notif.severity = "error"
+```
+
+#### context
+
+Set the context of the error report. This is notionally the location of the error and should be populated automatically. Context is displayed in the dashboard prominently.
+
+```ruby
+notif.context = "billing"
+```
+
+#### user
+
+You can set or read the user with the user property of the notification. The user will be a hash of `email`, `id` and `name`.
+
+```ruby
+notif.user = {
+  id: current_user.id,
+  email: current_user.email,
+  name: current_user.name
+}
+```
+
+#### exceptions
+
+Allows you to read the exceptions that will be combined into the report.
+
+```ruby
+puts "#{notif.exceptions.first.message} found!"
+```
+
+#### meta_data
+
+Provides access to the meta_data in the error report.
+
+```ruby
+notif.ignore! if notif.meta_data[:sidekiq][:retry_count] > 2
+```
+
 ### Exceptions with Meta Data
 
 If you include the `Bugsnag::MetaData` module into your own exceptions, you can
@@ -463,6 +542,16 @@ config.app_type = "resque"
 This is usually used to represent if you are running in a Rails server, Sidekiq job or
 Rake task for example. Bugsnag will automatically detect most application types for you.
 
+###send_environment
+
+Bugsnag can transmit your rack environment to help diagnose issues. This environment
+can sometimes contain private information so Bugsnag does not transmit by default. To
+send your rack environment, set the `send_environment` option to `true`.
+
+```ruby
+config.send_environment = true
+```
+
 Bugsnag Middleware
 ------------------
 

data/Rakefile

@@ -24,8 +24,6 @@ end
 # RSpec tasks
 require 'rspec/core'
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+RSpec::Core::RakeTask.new(:spec)
 
 task :default  => :spec

data/VERSION

@@ -1 +1 @@
-2.4.1
+2.5.0

data/lib/bugsnag/configuration.rb

@@ -10,6 +10,7 @@ module Bugsnag
     attr_accessor :notify_release_stages
     attr_accessor :auto_notify
     attr_accessor :use_ssl
+    attr_accessor :send_environment
     attr_accessor :project_root
     attr_accessor :app_version
     attr_accessor :app_type
@@ -53,6 +54,7 @@ module Bugsnag
       # Set up the defaults
       self.auto_notify = true
       self.use_ssl = true
+      self.send_environment = false
       self.params_filters = Set.new(DEFAULT_PARAMS_FILTERS)
       self.ignore_classes = Set.new(DEFAULT_IGNORE_CLASSES)
       self.ignore_user_agents = Set.new(DEFAULT_IGNORE_USER_AGENTS)

data/lib/bugsnag/middleware/rack_request.rb

@@ -36,7 +36,9 @@ module Bugsnag::Middleware
         })
 
         # Add an environment tab
-        notification.add_tab(:environment, env)
+        if notification.configuration.send_environment
+          notification.add_tab(:environment, env)
+        end
 
         # Add a session tab
         if session

data/lib/bugsnag/middleware/rails2_request.rb

@@ -3,7 +3,7 @@ module Bugsnag::Middleware
     def initialize(bugsnag)
       @bugsnag = bugsnag
     end
-      
+
     def call(notification)
       if notification.request_data[:rails2_request]
         request = notification.request_data[:rails2_request]
@@ -30,7 +30,9 @@ module Bugsnag::Middleware
         })
 
         # Add an environment tab
-        notification.add_tab(:environment, request.env) if request.env
+        if request.env && notification.configuration.send_environment
+          notification.add_tab(:environment, request.env)
+        end
 
         # Add a session tab
         notification.add_tab(:session, session_data) if session_data

data/lib/bugsnag/middleware/rails3_request.rb

@@ -3,7 +3,7 @@ module Bugsnag::Middleware
     def initialize(bugsnag)
       @bugsnag = bugsnag
     end
-      
+
     def call(notification)
       if notification.request_data[:rack_env]
         env = notification.request_data[:rack_env]
@@ -21,9 +21,11 @@ module Bugsnag::Middleware
         end
 
         # Add the rails version
-        notification.add_tab(:environment, {
-          :railsVersion => Rails::VERSION::STRING
-        })
+        if notification.configuration.send_environment
+          notification.add_tab(:environment, {
+            :railsVersion => Rails::VERSION::STRING
+          })
+        end
       end
 
       @bugsnag.call(notification)

data/lib/bugsnag/notification.rb

@@ -31,6 +31,7 @@ module Bugsnag
     attr_accessor :context
     attr_accessor :user
     attr_accessor :configuration
+    attr_accessor :meta_data
 
     @queue = Bugsnag::Queue.new
 

data/spec/middleware_spec.rb

@@ -127,4 +127,20 @@ describe Bugsnag::MiddlewareStack do
     end
     Bugsnag.notify(BugsnagTestException.new("It crashed"))
   end
+
+  it "allows inspection of meta_data before ignoring exception" do
+    expect(Bugsnag::Notification).not_to receive(:deliver_exception_payload)
+
+    # Use before notify callbacks as only the callback based metadata is
+    # available to before_notify_callbacks
+    Bugsnag.before_notify_callbacks << lambda do |notif|
+      notif.add_tab(:sidekiq, {:retry_count => 4})
+    end
+
+    Bugsnag.before_notify_callbacks << lambda do |notif|
+      notif.ignore! if notif.meta_data[:sidekiq][:retry_count] > 3
+    end
+
+    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json