rackamole 0.3.1 → 0.3.2

data/HISTORY

@@ -49,4 +49,9 @@
 * Fixed issue with rails and params not being correctly recorded
 
 0.3.1
-* Bugs and cleanups
+* Bugs and cleanups
+
+0.3.2
+* Fix issue with excluded_path being nil.
+* Changed default excluded_path 
+* Added perf_excludes option to exempt alerts from being sent for known slower requests

data/lib/rackamole/mole.rb

@@ -47,9 +47,16 @@ module Rack
     #
     # :mole_excludes :: Exclude some of the paramaters that the mole would normaly include. The list of 
     #                   customizable paramaters is: software, ip, browser type, url, path, status, headers and body.
-    #                   This options takes an array of symbols. Defaults to [:body].    
+    #                   This options takes an array of symbols. Defaults to [:body].
+    # :perf_excludes :: Specifies a set of paths that will be excluded when a performance issue is detected.
+    #                   This is useful when certain requests are known to be slow. When a match is found an
+    #                   alert won't be issued but the context will still be moled.
+    # ==
+    #   Don't send an alert when perf is found on /blee/fred. Don't alert on /duh unless the request took longer than 10 secs 
+    #   :perf_excludes => [ {:context => '/blee/fred}, {:context => /^\/duh.*/, :threshold => 10 } ]
+    # ==
     # :excluded_paths:: Exclude paths that you do not wish to mole by specifying an array of regular expresssions.
-    # :param_excludes:: Exempt params from being logged to the mole. Specify an array of keys as 
+    # :param_excludes:: Exempt certain sensitive request parameters from being logged to the mole. Specify an array of keys as 
     #                   as symbols ie [:password, :card_number].
     # :session_excludes:: Exempt session params from being logged by the mole. Specify an array of keys as symbols
     #                   ie [:fred, :blee] to exclude session[:fred] and session[:blee] from being stored.
@@ -126,7 +133,7 @@ module Rack
         :log_level       =>  :info,
         :expiration      =>  60*60, # 1 hour
         :environment     =>  'development',
-        :excluded_paths  =>  [/.?\.ico/, /.?\.png/],
+        :excluded_paths  =>  [/.*?\/stylesheets\/.*/, /.*?\/javascripts\/.*/,/\.*?\/images\/.*/ ],
         :mole_excludes   =>  [:body],
         :perf_threshold  =>  10.0,
         :store           =>  Rackamole::Store::Log.new
@@ -199,10 +206,34 @@ module Rack
       
       # Check if we've seen this perf issue before. If so stash it
       if attrs[:type] == Rackamole.perf
+        # Don't send alert if exempted
+        return true if perf_exempt?( attrs[:path], attrs[:request_time])
         return stash.stash_perf( path, attrs[:request_time], now.utc )
       end      
     end
     
+    # Check if request should be exempted from perf alert
+    def perf_exempt?( path, req_time )
+      return false unless option_defined?( :perf_excludes )
+      options[:perf_excludes].each do |hash|
+        context    = hash[:context]
+        threshold  = hash[:threshold]
+        time_trip  = (threshold ? req_time <= threshold : true)
+        
+        if context.is_a? String
+          return true if path == context and time_trip
+        elsif context.is_a? Regexp
+          return true if path.match(context) and time_trip
+        end
+      end
+      false
+    end
+    
+    # Check if an option is defined
+    def option_defined?( key )
+      options.has_key?(key) and options[key]
+    end
+    
     # Check if an options is set and configured
     def configured?( key, configs, optional=true )
       return false if optional and !options.has_key?(key)
@@ -225,8 +256,10 @@ module Rack
             
     # Check if this request should be moled according to the exclude filters        
     def mole_request?( request )
-      options[:excluded_paths].each do |exclude_path|
-        return false if request.path.match( exclude_path )
+      if options.has_key?( :excluded_paths ) and options[:excluded_paths]
+        options[:excluded_paths].each do |exclude_path|
+          return false if request.path =~ exclude_path
+        end
       end
       true
     end
@@ -329,7 +362,6 @@ module Rack
     
     # check exclusion to see if the information should be moled
     def mole?( key, stash, value )
-# puts "Checking #{key} -- #{options[:mole_excludes].inspect}"      
       return stash[key] = value if !options[:mole_excludes] or options[:mole_excludes].empty?
       stash[key] = (options[:mole_excludes].include?( key ) ? nil : value)
     end

data/lib/rackamole.rb

@@ -1,7 +1,7 @@
 module Rackamole
 
   # :stopdoc:
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/spec/rackamole/mole_spec.rb

@@ -15,7 +15,6 @@ describe Rack::Mole do
     @opts       = {
       :app_name       => "Test App", 
       :environment    => :test,
-      :excluded_paths => ['/should_bail'],      
       :perf_threshold => 0.1,
       :user_key       => :username,
       :store          => @test_store
@@ -66,7 +65,7 @@ describe Rack::Mole do
         get "/", nil, @test_env
       rescue
         last_request.env['mole.stash'].should_not be_nil
-        fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:45:in `error_app'" )
+        fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:44:in `error_app'" )
         fault.should_not be_nil
         fault.count.should == 1
       end
@@ -79,7 +78,7 @@ describe Rack::Mole do
           get "/", nil, env
         rescue
           last_request.env['mole.stash'].should_not be_nil
-          fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:45:in `error_app'" )
+          fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:44:in `error_app'" )
           fault.should_not be_nil
           fault.count.should == i+1
           env = last_request.env
@@ -95,7 +94,7 @@ describe Rack::Mole do
           get "/#{i}", nil, env
         rescue => boom
           last_request.env['mole.stash'].should_not be_nil
-          fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:45:in `error_app'" )          
+          fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:44:in `error_app'" )          
           fault.should_not be_nil
           fault.count.should == i+1
           env = last_request.env
@@ -103,7 +102,45 @@ describe Rack::Mole do
       end
     end
   end
+  
+  # ---------------------------------------------------------------------------
+  describe "perfomance exemptions" do
+    it "should exempt a string path correctly" do
+      rack = Rack::Mole.new( nil, :app_name => "test app", :perf_excludes => [ {:context => "/fred/blee" } ] )
+      rack.send( :perf_exempt?, "/fred/blee", 10 ).should == true
+      rack.send( :perf_exempt?, "/fred/blee1", 10 ).should == false
+    end
+
+    it "should exempt a regex path correctly" do
+      rack = Rack::Mole.new( nil, :app_name => "test app", :perf_excludes => [ {:context => /^\/fred\/?.*/ } ] )
+      rack.send( :perf_exempt?, "/fred/blee", 10 ).should == true
+      rack.send( :perf_exempt?, "/fred", 10 ).should == true
+      rack.send( :perf_exempt?, "/fred/blee/bubba", 10 ).should == true
+      rack.send( :perf_exempt?, "/freud", 10 ).should == false      
+    end    
 
+    it "should exempt path with threshold correctly" do
+      rack = Rack::Mole.new( nil, :app_name => "test app", :perf_excludes => [ {:context => /^\/fred\/?.*/, :threshold => 15 } ] )
+      rack.send( :perf_exempt?, "/fred/blee", 10 ).should == true
+      rack.send( :perf_exempt?, "/fred/blee", 16 ).should == false
+    end
+    
+    it "should exempt an array of path correctly" do
+      excludes = [
+        { :context => "/duh/1"     , :threshold => 5 },
+        { :context => /^\/fred\/?.*/, :threshold => 15 },
+      ]
+      rack = Rack::Mole.new( nil, :app_name => "test app", :perf_excludes => excludes )
+      rack.send( :perf_exempt?, "/fred/blee", 10 ).should == true
+      rack.send( :perf_exempt?, "/crap/10/fred", 10 ).should == false
+      rack.send( :perf_exempt?, "/fred/blee", 16 ).should == false
+      
+      rack.send( :perf_exempt?, "/duh/1", 5 ).should == true
+      rack.send( :perf_exempt?, "/duh/1", 6 ).should == false
+      rack.send( :perf_exempt?, "/duh/2", 6 ).should == false
+    end
+  end
+  
   # ---------------------------------------------------------------------------
   describe "performance duplicate" do 
     before( :each ) do
@@ -156,7 +193,7 @@ describe Rack::Mole do
     rescue 
       @test_store.mole_result[:stack].should have(4).items
       last_request.env['mole.stash'].should_not be_nil
-      fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:45:in `error_app'" )
+      fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:44:in `error_app'" )
       fault.should_not be_nil
       fault.count.should == 1
     end
@@ -236,7 +273,7 @@ describe Rack::Mole do
         @test_store.mole_result[:stack].should    have(4).items
         @test_store.mole_result[:fault].should    == 'Oh snap!'
         last_request.env['mole.stash'].should_not be_nil
-        fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:231" )
+        fault = last_request.env['mole.stash'].send( :find_fault, "/", "./spec/rackamole/mole_spec.rb:268" )
         fault.should_not   be_nil
         fault.count.should == 1
       end
@@ -246,8 +283,16 @@ describe Rack::Mole do
         get "/", { :blee => 'duh' }, @test_env
         @test_store.mole_result[:params].should == { :blee => "duh".to_json }
     end
+
+    it "should not mole a standard exclusion" do
+      %w(/stylesheets/style.css /javascripts/blee.js /images/fred.png).each do |path|
+        get path, nil, @test_env
+        @test_store.mole_result.should be_nil
+      end
+    end
     
-    it "should not mole an exclusion" do
+    it "should not mole a custom exclusion" do
+      @opts[:excluded_paths] = [/\/should_bail/]     
       get '/should_bail', nil, @test_env      
       @test_store.mole_result.should be_nil
     end
@@ -274,15 +319,15 @@ describe Rack::Mole do
   describe "rails env" do
     it "should find route info correctly" do
       pending do
-      RAILS_ENV = true
-      ActionController::Routing::Routes.stub!( :recognize_path ).and_return( { :controller => 'fred', :action => 'blee' } )
-      rack = Rack::Mole.new( nil, :app_name => "test app" )
+        RAILS_ENV = true
+        ActionController::Routing::Routes.stub!( :recognize_path ).and_return( { :controller => 'fred', :action => 'blee' } )
+        rack = Rack::Mole.new( nil, :app_name => "test app" )
       
-      # routes.should_receive( 'recognize_path' ).with( 'fred', { :method => 'blee' } ).and_return(  )
-      res = rack.send( :get_route, OpenStruct.new( :path => "/", :request_method => "GET") )
-      res.should_not          be_nil
-      res[:controller].should == 'fred'
-      res[:action].should     == 'blee'
+        # routes.should_receive( 'recognize_path' ).with( 'fred', { :method => 'blee' } ).and_return(  )
+        res = rack.send( :get_route, OpenStruct.new( :path => "/", :request_method => "GET") )
+        res.should_not          be_nil
+        res[:controller].should == 'fred'
+        res[:action].should     == 'blee'
       end
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-07 00:00:00 -07:00
+date: 2010-02-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency