Merge pull request #221 from getsentry/add-configurable-callback-issue-167

Add configurable callback for deciding whether or not to send an event

Author: nateberkopec

README.md

@@ -209,6 +209,16 @@ end
 
 You can find the list of exceptions that are excluded by default in [Raven::Configuration::IGNORE_DEFAULT](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb). Remember you'll be overriding those defaults by setting this configuration.
 
+You can also use a configuration option to determine if an individual event should
+be sent to Sentry. Events are passed to the Proc or lambda you provide - returning
+`false` will stop the event from sending to Sentry:
+
+```ruby
+Raven.configure do |config|
+  config.should_send = Proc.new { |e| true unless e.contains_sensitive_info? }
+end
+```
+
 ### Tags
 
 You can configure default tags to be sent with every event. These can be

lib/raven/base.rb

@@ -101,7 +101,7 @@ def capture(options = {}, &block)
     end
 
     def capture_exception(exception, options = {})
-      send_or_skip do
+      send_or_skip(exception) do
         if evt = Event.from_exception(exception, options)
           yield evt if block_given?
           if configuration.async?
@@ -114,7 +114,7 @@ def capture_exception(exception, options = {})
     end
 
     def capture_message(message, options = {})
-      send_or_skip do
+      send_or_skip(message) do
         if evt = Event.from_message(message, options)
           yield evt if block_given?
           if configuration.async?
@@ -126,8 +126,14 @@ def capture_message(message, options = {})
       end
     end
 
-    def send_or_skip
-      if configuration.send_in_current_environment?
+    def send_or_skip(exc)
+      should_send = if configuration.should_send
+        configuration.should_send.call(*[exc])
+      else
+        true
+      end
+
+      if configuration.send_in_current_environment? && should_send
         yield if block_given?
       else
         configuration.log_excluded_environment_message

lib/raven/configuration.rb

@@ -80,6 +80,9 @@ class Configuration
     # ActionDispatch::ShowExceptions or ActionDispatch::DebugExceptions
     attr_accessor :catch_debugged_exceptions
 
+    # Provide a configurable callback to block or send events
+    attr_accessor :should_send
+
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
                       'ActionController::InvalidAuthenticityToken',

spec/raven/raven_spec.rb

@@ -70,6 +70,20 @@
     end
   end
 
+  describe '.capture_exception with a should_send callback' do
+    let(:exception) { build_exception }
+
+    it 'sends the result of Event.capture_exception according to the result of should_send' do
+      expect(Raven).not_to receive(:send).with(event)
+
+      prior_should_send = Raven.configuration.should_send
+      Raven.configuration.should_send = Proc.new { |e| false }
+      expect(Raven.configuration.should_send).to receive(:call).with(exception)
+      Raven.capture_exception(exception, options)
+      Raven.configuration.should_send = prior_should_send
+    end
+  end
+
   describe '.annotate_exception' do
     let(:exception) { build_exception }