fiveruns-dash-activerecord 0.8.0 → 0.8.1

data/README.rdoc

@@ -9,10 +9,30 @@ You'll need a Dash account before using this library.
 This library is released as a gem from the official repository at http://github.com/fiveruns/dash-activerecord
 
   sudo gem install fiveruns-dash-activerecord --source http://gems.github.com
+  
+== Configuration
+
+Metrics in this recipe require a 'total_time' option be provided when the recipe is added; this option should indicate the metric to use when calculating % of utilization: 
+
+* For web applications, this is probably the total time of a request (ie, request_time)
+* For daemons, this is likely a processing cycle (eg, proc_time)
+
+Known issue: The metric name is not currently namespaced by recipe URL; although collision is unlikely, if your 'total_time' setting is for a metric that's present in more than one recipe, you may encounter problems.
+
+Note: The metric selected must be `marked', ie:
+
+  recipe.time :response_time, :method => 'Request#dispatch_action',
+                              :mark => true
+
+Example:
+
+  other_recipe.add_recipe :activerecord,
+                          :url => 'http://dash.fiveruns.com',
+                          :total_time => 'response_time'
 
 == Usage
 
-See the Dash Ruby support pages http://support.fiveruns.com/faqs/dash/ruby for information on how to use this library. 
+See the Dash Ruby support pages http://support.fiveruns.com/faqs/dash/ruby for more information on how to use this library. 
 
 == Authors
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 0
+:patch: 1
 :major: 0
 :minor: 8

data/lib/fiveruns-dash-activerecord.rb

@@ -1,2 +1,2 @@
 # Stub for gem dependency schemes
-require 'fiveruns/dash/recipes/activerecord'
+require 'fiveruns/dash/activerecord'

data/lib/fiveruns/dash/activerecord.rb

@@ -0,0 +1,25 @@
+gem 'fiveruns-dash-ruby'
+require 'fiveruns/dash'
+
+require 'fiveruns/dash/recipes/activerecord'
+
+module Fiveruns::Dash::ActiveRecord
+      
+  CLASS_METHODS = %w(
+    find find_by_sql 
+    create create! 
+    update_all 
+    destroy destroy_all 
+    delete delete_all
+    calculate
+  )      
+  INSTANCE_METHODS = %w(
+    update
+    save save!
+    destroy
+  )
+
+  TARGETS = CLASS_METHODS.map { |m| "ActiveRecord::Base.#{m}" } + \
+            INSTANCE_METHODS.map { |m| "ActiveRecord::Base##{m}"}
+
+end

data/lib/fiveruns/dash/recipes/activerecord.rb

@@ -1,19 +1,41 @@
-require 'fiveruns/dash'
-
 Fiveruns::Dash.register_recipe :activerecord, :url => 'http://dash.fiveruns.com' do |recipe|
-  # We need a way to get the total time for a request/operation so that we can
-  # calculate the relative percentage used by AR/DB.  Default to "response_time" for the Rails
-  # recipe but daemons can set this constant to provide their own total time metric.
-  total_time = recipe.options[:ar_total_time] ? recipe.options[:ar_total_time] : "response_time"
 
-  recipe.time :ar_time, 'ActiveRecord Time', :methods => Fiveruns::Dash::ActiveRecordContext.all_methods, :reentrant => true, :only_within => total_time
-  recipe.time :db_time, 'Database Time', :methods => %w(ActiveRecord::ConnectionAdapters::AbstractAdapter#log), :only_within => total_time
+  recipe.time :db_time, 'Database Time', :methods => %w(ActiveRecord::ConnectionAdapters::AbstractAdapter#log)  
+  recipe.time :ar_time, 'ActiveRecord Time', :methods => Fiveruns::Dash::ActiveRecord::TARGETS,
+                                             :reentrant => true
+  recipe.added do |settings|
 
-  recipe.percentage :ar_util, 'ActiveRecord Utilization', :sources => ["ar_time", total_time] do |ar_time, all_time|
-    all_time == 0 ? 0 : (ar_time / all_time) * 100.0
-  end
-  recipe.percentage :db_util, 'Database Utilization', :sources => ["db_time", total_time] do |db_time, all_time|
-    all_time == 0 ? 0 : (db_time / all_time) * 100.0
+    # We need a way to get the total time for a request/operation so that we can
+    # calculate the relative percentage used by AR/DB.    
+    if settings[:total_time]
+      
+      total_time = settings[:total_time].to_s
+
+      Fiveruns::Dash.logger.debug "Set FiveRuns Dash `activerecord' :total_time setting to #{total_time}"
+      # Limit timing
+      recipe.metrics.each do |metric|
+        if %w(db_time ar_time).include?(metric.name) && metric.recipe.url == 'http://dash.fiveruns.com'
+          metric.options[:only_within] = total_time
+        end
+      end
+
+      recipe.percentage :ar_util, 'ActiveRecord Utilization', :sources => ["ar_time", total_time] do |ar_time, all_time|
+        all_time == 0 ? 0 : (ar_time / all_time) * 100.0
+      end
+      recipe.percentage :db_util, 'Database Utilization', :sources => ["db_time", total_time] do |db_time, all_time|
+        all_time == 0 ? 0 : (db_time / all_time) * 100.0
+      end
+    
+    else
+      
+      Fiveruns::Dash.logger.error [
+        "Could not add some metrics from the FiveRuns Dash `activerecord' recipe to the configuration;",
+        "Please provide a :total_time metric name setting when adding the recipe.",
+        "For more information, see the fiveruns-dash-activerecord README"
+      ].join("\n")
+      
+    end
+    
   end
 
 end

data/test/activerecord_test.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+Fiveruns::Dash.logger.level = Logger::FATAL
+
+class ActiverecordTest < Test::Unit::TestCase
+
+  class TestModel < ActiveRecord::Base
+  end
+
+  class TestEngine
+    def doit
+      sleep 1
+      2.times do
+        t = TestModel.create!(:name => 'foo')
+        t.destroy
+      end
+    end
+
+    def conn
+      TestModel.connection.execute("select sleep(1)")
+    end
+
+    def entry(meth)
+      send(meth)
+    end
+  end
+  
+
+  context "Metric" do
+    
+    setup do
+      ActiveRecord::Base.configurations = { 'test' => { 'database' => 'test', 'adapter' => 'mysql', 'user' => 'root', 'hostname' => 'localhost' }}
+      ActiveRecord::Base.establish_connection('test')
+      ActiveRecord::Base.connection.execute("create table if not exists test_models (id integer PRIMARY KEY, name varchar(32) not null)")
+      ActiveRecord::Base.connection.execute("delete from test_models")
+    end
+
+    should "collect basic AR metrics" do
+      ar_scenario do
+        TestEngine.new.entry(:doit)
+
+        data = Fiveruns::Dash.session.data
+        # data.each do |hsh|
+        #   puts "#{hsh[:name]}: #{hsh[:values].inspect}"
+        # end
+
+        assert metric('test_time', data) > 1.0
+        assert metric('ar_util', data) > metric('db_util', data)
+        assert metric('db_util', data) < 5
+      end
+    end
+
+    should "collect DB metrics" do
+      ar_scenario do
+        TestEngine.new.entry(:conn)
+        
+        data = Fiveruns::Dash.session.data
+        # data.each do |hsh|
+        #   puts "#{hsh[:name]}: #{hsh[:values].inspect}"
+        # end
+
+        assert metric('test_time', data) > 1.0
+        assert metric('test_time', data) < 1.1
+        assert metric('db_time', data) > 1.0
+        assert metric('db_time', data) < 1.1
+        assert metric('db_util', data) > 90.0
+        assert metric('db_util', data) < 100.0
+      end
+    end
+  end
+
+  def ar_scenario(&block)
+    child = fork do
+      mock_activerecord!
+      yield
+    end
+    Process.wait
+    assert_equal 0, $?.exitstatus
+  end
+
+  def metric(metric, data, context=[])
+    hash = data.detect { |hash| hash[:name] == metric }
+    assert hash, "No metric named #{metric} was found in metrics payload"
+    vals = hash[:values]
+    assert vals, "No values found for #{metric} in metrics payload"
+    val = vals.detect { |val| val[:context] == context }
+    assert val, "No value for #{metric} found for context #{context.inspect}"
+    val[:value]
+  end
+
+  def mock_activerecord!
+    
+    eval <<-MOCK
+      module Fiveruns::Dash
+        class Reporter
+          private
+          def run
+          end
+        end
+      end
+    MOCK
+
+    Fiveruns::Dash.register_recipe :tester, :url => 'http://dash.fiveruns.com' do |recipe|
+      recipe.time :test_time, 'Test Time', :method => 'ActiverecordTest::TestEngine#entry',
+                                           :mark => true
+    end
+    
+    Fiveruns::Dash.start :app => '666' do |config|
+      config.add_recipe :ruby
+      config.add_recipe :tester
+      config.add_recipe :activerecord, :total_time => 'test_time'
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) << "/../lib")
+require 'fiveruns/dash/activerecord'
+
+require 'test/unit'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+require 'activerecord'
+require 'shoulda'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-activerecord
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - FiveRuns Development Team
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 -08:00
+date: 2009-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.0
+        version: 0.8.1
     version: 
 description: Provides an API to send metrics from applications using ActiveRecord to the FiveRuns Dash service
 email: dev@fiveruns.com
@@ -35,9 +35,12 @@ files:
 - VERSION.yml
 - lib/fiveruns
 - lib/fiveruns/dash
+- lib/fiveruns/dash/activerecord.rb
 - lib/fiveruns/dash/recipes
 - lib/fiveruns/dash/recipes/activerecord.rb
 - lib/fiveruns-dash-activerecord.rb
+- test/activerecord_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/fiveruns/dash-activerecord
 post_install_message: