system-metrics 0.1.0 → 0.2.0

data/spec/system_metrics/collector_spec.rb

@@ -1,8 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'system_metrics/collector'
 
 describe SystemMetrics::Collector do
-  before(:each) do 
+  before(:each) do
     @store = TestStore.new
     @collector = SystemMetrics::Collector.new(@store)
   end

data/spec/system_metrics/config_spec.rb

@@ -1,24 +1,32 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'system_metrics/config'
 
 describe SystemMetrics::Config do
-  it 'should be valid with instruments, path_exclude_patterns, and a store' do
-    config = SystemMetrics::Config.new({:instruments => [Object.new], :store => Object.new})
+  it 'should be valid by default' do
+    config = SystemMetrics::Config.new
     config.should be_valid
   end
 
-  it 'should be invalid without instruments' do
-    config = SystemMetrics::Config.new({:store => Object.new})
+  it 'should be invalid with nil instruments' do
+    config = SystemMetrics::Config.new
+    config.instruments = nil
     config.should_not be_valid
   end
 
   it 'should be invalid without a store' do
-    config = SystemMetrics::Config.new({:instruments => [Object.new]})
+    config = SystemMetrics::Config.new
+    config.store = nil
     config.should_not be_valid
   end
 
-  it 'should be invalid if passed an unrecognized option' do
-    config = SystemMetrics::Config.new({:instruments => [Object.new], :path_exclude_patterns => [], :store => Object.new, :bogus => true})
+  it 'should be invalid with a nil path_exclude_patterns' do
+    config = SystemMetrics::Config.new
+    config.path_exclude_patterns = nil
+    config.should_not be_valid
+  end
+
+  it 'should be invalid with a nil notification_exclude_patterns' do
+    config = SystemMetrics::Config.new
+    config.notification_exclude_patterns = nil
     config.should_not be_valid
   end
 end

data/spec/system_metrics/engine_spec.rb

@@ -1,50 +1,75 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'system_metrics/engine'
 
 describe SystemMetrics::Engine do
   before(:each) do
     @app = MockApp.new
     @store = TestStore.new
-    @app.config.system_metrics[:instruments] = [Comb::Instrument::Base.new(/xyz123/)]
-    @app.config.system_metrics[:store] = @store
+    @app.config.system_metrics = SystemMetrics::Config.new
+    @app.config.system_metrics.instruments << SystemMetrics::Instrument::Base.new(/xyz123/)
+    @app.config.system_metrics.store = @store
+    @engine = SystemMetrics::Engine.new
+    run_initializers(@engine)
   end
 
-  it 'should establish ActiveSupport::Notification subscribers for each instrument' do
-    @app.config.system_metrics[:instruments] = [Comb::Instrument::Base.new(/^sql/), Comb::Instrument::Base.new(/^render/)]
-    engine = SystemMetrics::Engine.new
-    run_initializers(engine)
-
-    collector = SystemMetrics::Collector.new(@store)
-    collector.collect do
-      ActiveSupport::Notifications.instrument 'sql.active_record'
-      ActiveSupport::Notifications.instrument 'render.action_view'
-      ActiveSupport::Notifications.instrument 'process.action_controller'
-    end
-
-    @store.should have(2).events
-    @store.events.map(&:name) =~ ['sql.active_record', 'render.action_view']
+  it 'should initialize the SystemMetrics configuration' do
+    @engine.smc.should_not be_nil
+    @engine.smc.should be_valid
+    @engine.collector.should_not be_nil
   end
 
   it 'should setup the SystemMetrics::Middleware' do
-    engine = SystemMetrics::Engine.new
-    run_initializers(engine)
-
     middleware = @app.config.middleware.first
     middleware[0].should == SystemMetrics::Middleware
     middleware[1].should_not be_nil
     middleware[2].should_not be_nil
   end
 
-  def run_initializer(engine, name)
-    initializer = engine.initializers.find do |initializer|
-      initializer.name == name
+  describe '#process_event' do
+    it 'should collect events that do not have an instrument that handles them' do
+      event = ActiveSupport::Notifications::Event.new('unknown', Time.now - 5, Time.now, 'tid', {})
+      @engine.collector.collect { @engine.send(:process_event, event) }
+      @store.events.should include(event)
     end
-    initializer.run @app
-  end
 
-  def run_initializers(engine)
-    ['system_metrics.initialize', 'system_metrics.add_subscribers', 'system_metrics.add_middleware'].each do |name|
-      run_initializer(engine, name)
+    it 'should collect events that have an instrument that handles and does not ignore them' do
+      event = ActiveSupport::Notifications::Event.new('xyz123', Time.now - 5, Time.now, 'tid', {})
+      @engine.collector.collect { @engine.send(:process_event, event) }
+      @store.events.should include(event)
+    end
+
+    it 'should not collect events whose instrument indicates that it should be ignored' do
+      class IgnoringInstrument
+        def handles?(event)
+          true
+        end
+
+        def ignore?(event)
+          true
+        end
+      end
+
+      @app.config.system_metrics.instruments << IgnoringInstrument.new
+      engine = SystemMetrics::Engine.new
+      run_initializers(engine)
+      event = ActiveSupport::Notifications::Event.new('abc123', Time.now - 5, Time.now, 'tid', {})
+      engine.collector.collect { @engine.send(:process_event, event) }
+      @store.events.should_not include(event)
     end
   end
+
+  private
+
+    def run_initializer(engine, name)
+      initializer = engine.initializers.find do |initializer|
+        initializer.name == name
+      end
+      initializer.run @app
+    end
+
+    def run_initializers(engine)
+      ['system_metrics.initialize', 'system_metrics.start_subscriber', 'system_metrics.add_middleware'].each do |name|
+        run_initializer(engine, name)
+      end
+    end
+
 end

data/spec/system_metrics/instrument/action_controller_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::ActionController do
+  include NotificationsSupport
+
+  before(:each) do
+    @instrument = SystemMetrics::Instrument::ActionController.new
+  end
+
+  describe '#handle?' do
+    it 'should handle any event whose name ends with action_controller' do
+      @instrument.handles?(event(:name => 'process_action.action_controller')).should be_true
+      @instrument.handles?(event(:name => 'do_something.action_controller')).should be_true
+    end
+
+    it 'should not handle an event whose name does not end with action_controller' do
+      @instrument.handles?(event(:name => 'do_something.else')).should be_false
+      @instrument.handles?(event(:name => 'action_controller.process_action')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should ignore all events unless the name is process_action.action_controller' do
+      @instrument.ignore?(event(:name => 'process_action.action_controller')).should be_false
+      @instrument.ignore?(event(:name => 'start_processing.action_controller')).should be_true
+    end
+  end
+
+  describe '#prepare' do
+    it 'should add an endpoint entry to the payload' do
+      e = event(:payload => { :controller => 'User', :action => 'create' })      
+      @instrument.prepare(e)
+      e.payload.should include(:end_point)
+      e.payload[:end_point].should == 'User#create'
+    end
+
+    it 'should remove all payload keys except :path, :method, :params, :db_runtime, :view_runtime, and :end_point' do
+      e = event(:payload => { 
+        :controller => 'User',
+        :action => 'create',
+        :path => '/',
+        :method => 'GET',
+        :params => {},
+        :db_runtime => 10,
+        :view_runtime => 10 
+      })      
+      @instrument.prepare(e)
+      e.payload.keys.should =~ [:path, :method, :params, :db_runtime, :view_runtime, :end_point]
+    end
+  end
+end

data/spec/system_metrics/instrument/action_mailer_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::ActionMailer do
+  include NotificationsSupport
+
+  before(:each) do
+    @instrument = SystemMetrics::Instrument::ActionMailer.new
+  end
+
+  describe '#handle?' do
+    it 'should handle any event whose name ends with action_mailer' do
+      @instrument.handles?(event(:name => 'recieve.action_mailer')).should be_true
+      @instrument.handles?(event(:name => 'send.action_mailer')).should be_true
+    end
+
+    it 'should not handle an event whose name does not end with action_mailer' do
+      @instrument.handles?(event(:name => 'do_something.else')).should be_false
+      @instrument.handles?(event(:name => 'action_mailer.process_action')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should always return false' do
+      @instrument.ignore?(event(:name => 'process_action.action_mailer')).should be_false
+      @instrument.ignore?(event(:name => 'start_processing.action_controller')).should be_false
+    end
+  end
+
+  describe '#prepare' do
+    it 'should should keep all payload attributes except :mail' do
+      e = event(:payload => { 
+        :controller => 'User',
+        :action => 'create',
+        :mail => 'big long message'
+      })      
+      @instrument.prepare(e)
+      e.payload.keys.should =~ [:controller, :action]
+    end
+  end
+end

data/spec/system_metrics/instrument/action_view_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::ActionView do
+  include NotificationsSupport
+
+  before(:each) do
+    @instrument = SystemMetrics::Instrument::ActionView.new
+  end
+
+  describe '#handle?' do
+    it 'should handle any event whose name ends with action_view' do
+      @instrument.handles?(event(:name => 'recieve.action_view')).should be_true
+      @instrument.handles?(event(:name => 'send.action_view')).should be_true
+    end
+
+    it 'should not handle an event whose name does not end with action_view' do
+      @instrument.handles?(event(:name => 'do_something.else')).should be_false
+      @instrument.handles?(event(:name => 'action_view.process_action')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should always return false' do
+      @instrument.ignore?(event(:name => 'process_action.action_view')).should be_false
+      @instrument.ignore?(event(:name => 'start_processing.action_controller')).should be_false
+    end
+  end
+
+  describe '#prepare' do
+    it 'should try to replace any paths in payload values' do
+      @instrument.mapped_paths['/abc123'] = 'A'
+      e = event(:payload => { 
+        :path => '/abc123/more/path',
+        :action => 'create'
+      })      
+      @instrument.prepare(e)
+      e.payload.should == { :path => 'A/more/path', :action => 'create' }
+    end
+  end
+end

data/spec/system_metrics/instrument/active_record_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::ActiveRecord do
+  include NotificationsSupport
+
+  before(:each) do
+    @instrument = SystemMetrics::Instrument::ActiveRecord.new
+  end
+
+  describe '#handle?' do
+    it 'should handle any event whose name ends with active_record' do
+      @instrument.handles?(event(:name => 'sql.active_record')).should be_true
+      @instrument.handles?(event(:name => 'arel.active_record')).should be_true
+    end
+
+    it 'should not handle an event whose name does not end with active_record' do
+      @instrument.handles?(event(:name => 'do_something.else')).should be_false
+      @instrument.handles?(event(:name => 'active_record.sql')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should ignore all events whose payload[:sql] does not begin with SELECT, INSERT, UPDATE, or DELETE' do
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'SELECT * from users' })
+      @instrument.ignore?(e).should be_false
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'INSERT into users' })
+      @instrument.ignore?(e).should be_false
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'UPDATE users' })
+      @instrument.ignore?(e).should be_false
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'DELETE from users' })
+      @instrument.ignore?(e).should be_false
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'DESCRIBE users' })
+      @instrument.ignore?(e).should be_true
+    end
+  end
+
+  describe '#prepare' do
+    it 'should replace all runs of multiple spaces and newlines in the payload[:sql] with a single space' do
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'SELECT *     from   users' })
+      @instrument.prepare(e)
+      e.payload[:sql].should == 'SELECT * from users'
+    end
+
+    it 'should remove the :connection_id from the payload' do
+      e = event(:name => 'sql.active_record', :payload => { :sql => 'SELECT * from users', :connection_id => 27 })
+      @instrument.prepare(e)
+      e.payload.should_not include(:connection_id)
+    end
+  end
+end

data/spec/system_metrics/instrument/base_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::Base do
+  include NotificationsSupport
+
+  describe '#handle?' do
+    it 'should handle any event whose name matches the pattern passed to the constructor' do
+      instrument = SystemMetrics::Instrument::Base.new(/action_mailer$/)
+      instrument.handles?(event(:name => 'recieve.action_mailer')).should be_true
+      instrument = SystemMetrics::Instrument::Base.new(/action_controller$/)
+      instrument.handles?(event(:name => 'process_action.action_controller')).should be_true
+    end
+
+    it 'should not handle an event whose name does not match the pattern passed to the constructor' do
+      instrument = SystemMetrics::Instrument::Base.new(/action_mailer$/)
+      instrument.handles?(event(:name => 'action_mailer.receive')).should be_false
+      instrument = SystemMetrics::Instrument::Base.new(/action_controller$/)
+      instrument.handles?(event(:name => 'action_controller.go')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should always return false' do
+      instrument = SystemMetrics::Instrument::Base.new(/action_mailer$/)
+      instrument.ignore?(event(:name => 'process_action.action_mailer')).should be_false
+      instrument.ignore?(event(:name => 'start_processing.action_controller')).should be_false
+    end
+  end
+
+  describe '#prune_path' do
+    it 'should allow path elements to be replaced' do
+      instrument = SystemMetrics::Instrument::Base.new(/action_mailer$/)
+      instrument.mapped_paths['/abc123'] = 'A'
+      instrument.prune_path('/abc123/more/path').should == 'A/more/path'
+    end
+  end
+
+end

data/spec/system_metrics/instrument/rack_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SystemMetrics::Instrument::Rack do
+  include NotificationsSupport
+
+  before(:each) do
+    @instrument = SystemMetrics::Instrument::Rack.new
+  end
+
+  describe '#handle?' do
+    it 'should handle any event whose name is request.rack' do
+      @instrument.handles?(event(:name => 'request.rack')).should be_true
+    end
+
+    it 'should not handle an event whose name is not request.rack' do
+      @instrument.handles?(event(:name => 'response.rack')).should be_false
+      @instrument.handles?(event(:name => 'view.rack')).should be_false
+    end
+  end
+
+  describe '#ignore?' do
+    it 'should always return false' do
+      @instrument.ignore?(event(:name => 'request.rack')).should be_false
+      @instrument.ignore?(event(:name => 'start_processing.action_controller')).should be_false
+    end
+  end
+
+end

data/spec/system_metrics/middleware_spec.rb

@@ -1,6 +1,4 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require 'system_metrics/middleware'
-require 'system_metrics/collector'
 
 describe SystemMetrics::Middleware do
   before(:each) do
@@ -8,7 +6,7 @@ describe SystemMetrics::Middleware do
     @collector = SystemMetrics::Collector.new(@store)
   end
 
-  it 'should invoke the collector for a non-excluded paths' do
+  it 'should invoke the collector for non-excluded paths' do
     event = Object.new
     blk = Proc.new { @collector.collect_event(event) }
     middleware = SystemMetrics::Middleware.new(blk, @collector, [])

data/spec/system_metrics/nested_event_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SystemMetrics::NestedEvent do
+  it "should provide a reader for started_at that pulls directly from the event's time property" do
+    time = Time.now
+    e = event(:start => time)
+    e.started_at.should == time
+  end
+
+  it "should provide a reader for ended_at that pulls directly from the event's end property" do
+    time = Time.now
+    e = event(:end => time)
+    e.ended_at.should == time
+  end
+
+  it 'should contain child events' do
+    e = event
+    e.children << event()
+    e.should have(1).child
+  end
+
+  describe '.arrange' do
+    it 'should arrange an array of events in a nested structure' do
+      parent = event(:start => Time.now - 10.seconds, :end => Time.now)
+      child = event(:start => Time.now - 9.seconds, :end => Time.now - 1.seconds)
+      grandchild = event(:start => Time.now - 8.seconds, :end => Time.now - 2.seconds)
+
+      root = SystemMetrics::NestedEvent.arrange([grandchild, child, parent])
+      root.should have(1).child
+      root.children[0].should == child
+      root.children[0].should have(1).child
+      root.children[0].children[0].should == grandchild
+    end
+  end
+
+  describe '#parent_of?' do
+    it 'should be a parent of another event if its start and end times contain the target event' do
+      parent = event(:start => Time.now - 10.seconds, :end => Time.now)
+      child = event(:start => Time.now - 6.seconds, :end => Time.now - 3.seconds)
+      parent.parent_of?(child).should be_true
+    end
+  end
+
+  describe '#child_of?' do
+    it 'should be a child of another event if its start and end times are within the parent event' do
+      parent = event(:start => Time.now - 10.seconds, :end => Time.now)
+      child = event(:start => Time.now - 6.seconds, :end => Time.now - 3.seconds)
+      child.child_of?(parent).should be_true
+    end
+  end
+
+  describe '#exclusive_duration' do
+    it 'should calculate the time spent within an event minus all the time spent in child events' do
+      now = Time.now
+      parent = event(:start => now - 10.seconds, :end => now)
+      child = event(:start => now - 9.seconds, :end => now - 1.seconds)
+      grandchild = event(:start => now - 8.seconds, :end => now - 2.seconds)
+      root = SystemMetrics::NestedEvent.arrange([grandchild, child, parent])
+      root.exclusive_duration.should be_within(100).of(2000)
+    end
+  end
+
+  describe '#to_hash' do
+    it 'should return a hash with keys for :name, :action, :category, :started_at, :transaction_id, :payload, :duration, and :exclusive_duration' do
+      e = event
+      hash = event.to_hash
+      hash[:name].should == e.name
+      hash[:started_at].should be_within(1).of(e.started_at)
+      hash[:transaction_id].should == e.transaction_id
+      hash[:payload].should == e.payload
+      hash[:duration].should be_within(1).of(e.duration)
+      hash[:exclusive_duration].should be_within(1).of(e.exclusive_duration)
+    end
+  end
+
+  private
+
+    def event(options={})
+      SystemMetrics::NestedEvent.new(
+        options[:name] || 'sql.active_record',
+        options[:start] || (Time.now - 5.seconds),
+        options[:end] || Time.now,
+        options[:transaction_id] || 'tid',
+        options[:payload] || {}
+      )
+    end
+end