errplane 0.2.7 → 0.3.7

data/README.md

@@ -49,7 +49,25 @@ This gem also supports notifications from failed Resque jobs. Just add the follo
     Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Errplane]
     Resque::Failure.backend = Resque::Failure::Multiple
 
-Assuming this is running from within a normal Rails projects, the values provided in `config/initializers/errplane.rb` will make sure that the Resque backend is set up correctly.
+Assuming this is running from within a normal Rails project, the values provided in `config/initializers/errplane.rb` will make sure that the Resque backend is set up correctly.
+
+Customizing How Exceptions Get Grouped and Sending Additional Data
+------------------------------------------------------------------
+
+The Errplane API will automatically attempt to group exceptions and threshold alerts based on a SHA hash of the exception class name and the first line of the backtrace. This works for some cases, but may be too noisy for failures that occur in different spots in your application that mean the same thing. This gem includes functionality to define a hash yourself to modify how exception groupings are made. That can be done by modifying `config/initializers/resque.rb`:
+
+    require 'digest/sha1'
+
+    Errplane.configure do |config|
+      config.define_custom_exception_data do |black_box|
+        if black_box.exception.class ==  ZeroDivisionError
+          black_box.hash = Digest::SHA1.hexdigest("ZeroDivisionError")
+          black_box.custom_data[:extra_info] = "maths"
+        end
+      end
+    end
+
+That example will ensure that any divide by zero errors in your application will be grouped together, while all other exceptions will be grouped by the normal logic. The custom_exception_data block gets yielded an [Errplane::BlackBox](https://github.com/errplane/gem/blob/master/lib/errplane/black_box.rb) object. Through that object you can access exception information, request information, and custom data. You can also add custom data that can be viewed later in Errplane. This is useful if you want to capture additional context that we haven't already thought of including. When setting `custom_data.hash` it should always be some sort of digest like SHA1 used in the above example.
 
 Rails Remote Logger
 -------------------

data/errplane.gemspec

@@ -23,12 +23,14 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', ['>= 2.3.14']
   s.add_dependency 'actionpack', ['>= 2.3.14']
   s.add_dependency 'json', ['>= 0']
+  s.add_dependency 'rails', ['>= 3.0']
 
   s.add_development_dependency 'bundler', ['>= 1.0.0']
   s.add_development_dependency 'rake', ['>= 0']
   s.add_development_dependency 'sqlite3', ['>= 0']
   s.add_development_dependency 'tzinfo', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['>= 0']
   s.add_development_dependency 'rr', ['>= 0']
   s.add_development_dependency 'capybara', ['>= 1.0']
   s.add_development_dependency 'database_cleaner', ['>= 0']

data/lib/errplane/black_box.rb

@@ -1,5 +1,6 @@
 module Errplane
   class BlackBox
+    attr_accessor :hash
     attr_reader :exception
     attr_reader :params
     attr_reader :session_data
@@ -19,7 +20,7 @@ module Errplane
     end
 
     def to_json
-      {
+      paylaod = {
         :time => Time.now.to_i,
         :application_name => Errplane.configuration.application_name,
         :application_root => Errplane.configuration.application_root,
@@ -32,9 +33,15 @@ module Errplane
         :language_version => "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
         :environment_variables => ENV.to_hash,
         :reporter => reporter,
-        :request_data => request_data,
         :custom_data => @custom_data
-      }.to_json
+      }
+
+      Errplane.configuration.add_custom_exception_data(self)
+
+      paylaod[:request_data] = request_data if @controller || @action || !params.empty?
+      paylaod[:hash] = hash if hash
+
+      paylaod.to_json
     end
 
     def reporter

data/lib/errplane/configuration.rb

@@ -65,6 +65,14 @@ module Errplane
       end
     end
 
+    def define_custom_exception_data(&block)
+      @custom_exception_data_handler = block
+    end
+
+    def add_custom_exception_data(black_box)
+      @custom_exception_data_handler.call(black_box) if @custom_exception_data_handler
+    end
+
     private
     def initialize_http_connection
       Net::HTTP.new(@app_host, "80")

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.2.7"
+  VERSION = "0.3.7"
 end

data/lib/errplane.rb

@@ -61,7 +61,25 @@ module Errplane
       configuration.ignore_current_environment? || configuration.ignored_exceptions.include?(e.class.to_s)
     end
 
+    def rescue(&block)
+      block.call
+    rescue StandardError => e
+      if configuration.ignore_current_environment?
+        raise(e)
+      else
+        transmit_unless_ignorable(e, {})
+      end
+    end
+
+    def rescue_and_reraise(&block)
+      block.call
+    rescue StandardError => e
+      transmit_unless_ignorable(e, {})
+      raise(e)
+    end
+
     private
+
     def assemble_black_box_for(e, opts = {})
       opts ||= {}
       configuration.logger.info("OPTS: #{opts}")

data/spec/unit/black_box_spec.rb

@@ -30,5 +30,21 @@ describe Errplane::BlackBox do
       json["time"].should_not be_nil
       json["backtrace"].should_not be_nil
     end
+
+    it "should include a custom hash if defined in the errplane config" do
+      Errplane.configure do |config|
+        config.define_custom_exception_data do |black_box|
+          if black_box.exception.class ==  ZeroDivisionError
+            black_box.hash = "some_hash"
+            black_box.custom_data[:extra_info] = "blah"
+          end
+        end
+      end
+
+      black_box = Errplane::BlackBox.new(exception: @exception)
+      json = JSON.parse(black_box.to_json)
+      json["hash"].should == "some_hash"
+      json["custom_data"]["extra_info"].should == "blah"
+    end
   end
 end

data/spec/unit/errplane_spec.rb

@@ -23,4 +23,47 @@ describe Errplane do
       Errplane.ignorable_exception?(exception).should be_false
     end
   end
+
+  describe 'rescue' do
+
+    it "should transmit an exception when passed" do
+      Errplane.configure do |config|
+        config.ignored_environments = %w{development}
+      end
+
+      stub_request(:post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012").to_return(status: 200)
+      Errplane.rescue do
+        raise ArgumentError.new('wrong')
+      end
+      assert_requested :post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    end
+
+    it "should also raise the exception when in an ignored environment" do
+      Errplane.configure do |config|
+        config.ignored_environments = %w{development test}
+      end
+      expect {
+        Errplane.rescue do
+          raise ArgumentError.new('wrong')
+        end
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "rescue_and_reraise" do
+    before do
+      Errplane.configure do |config|
+        config.ignored_environments = %w{development}
+      end
+    end
+
+    it "should transmit an exception when passed" do
+      stub_request(:post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012").to_return(status: 200)
+      expect {
+        Errplane.rescue_and_reraise { raise ArgumentError.new('wrong') }
+      }.to raise_error(ArgumentError)
+      assert_requested :post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-17 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534139560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.14
+  version_requirements: *70311534139560
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534139040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.14
+  version_requirements: *70311534139040
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534138560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70311534138560
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70311534138080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311534138080
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534137600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *70311534137600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534137120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311534137120
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534136640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,15 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311534136640
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534136160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -117,15 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311534136160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534135680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,15 +109,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70311534135680
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70311534135200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70311534135200
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534134720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -149,15 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311534134720
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534134240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -165,15 +142,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.0'
+  version_requirements: *70311534134240
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311534133760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -181,15 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311534133760
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311533885740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,15 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311533885740
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70311533884500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -213,12 +175,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70311533884500
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
 - todd@errplane.com
@@ -227,7 +184,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - README.md
 - Rakefile
@@ -299,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: errplane
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Rails exception reporting for Errplane.

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-1.9.3-p194@errplane_rails --create