fiveruns-dash-datamapper 0.6.0

data/README.rdoc

@@ -0,0 +1,90 @@
+= FiveRuns Dash recipe for DataMapper
+
+Provides a Ruby API to push metrics from applications using DataMapper to the FiveRuns Dash service, http://dash.fiveruns.com, currently in beta.
+
+You'll need a Dash account before using this library.
+
+== Installation
+
+This library is released as a gem from the official repository at http://github.com/fiveruns/dash-datamapper
+
+  sudo gem install fiveruns-dash-datamapper --source http://gems.github.com
+  
+== Compatibility
+
+Currently only DataObject adapters are supported.
+  
+== 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 issues: 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 :datamapper,
+                          :url => 'http://dash.fiveruns.com',
+                          :total_time => 'response_time'
+
+== Usage
+
+See the Dash Ruby support pages http://support.fiveruns.com/faqs/dash/ruby for more information on how to use this library. 
+
+== Authors
+
+The FiveRuns Development Team & Dash community
+
+== Dependencies
+
+* The fiveruns-dash-ruby gem (see http://github.com/fiveruns/dash-ruby)
+* The json gem (as a dependency for fiveruns-dash-ruby)
+
+== Platforms
+
+This library has only been tested on OSX and Linux.  See the notes for fiveruns-dash-ruby for more information: http://github.com/fiveruns/dash-ruby
+
+== Contributing
+
+As an open source project, we welcome community contributions!
+
+The best way to contribute is by sending pull requests via GitHub.  The official repository for this project is:
+
+  http://github.com/fiveruns/dash-datamapper
+
+== Support
+
+Please join the dash-users Google group, http://groups.google.com/group/dash-users
+
+You can also contact us via Twitter, Campfire, or email; see the main help page, http://support.fiveruns.com, for details.
+
+== License
+
+  # (The FiveRuns License)
+  #
+  # Copyright (c) 2006-2008 FiveRuns Corporation
+  # 
+  # Permission is hereby granted, free of charge, to any person obtaining
+  # a copy of this software and associated documentation files (the
+  # 'Software'), to deal in the Software without restriction, including
+  # without limitation the rights to use, copy, modify, merge, publish,
+  # distribute, sublicense, and/or sell copies of the Software, and to
+  # permit persons to whom the Software is furnished to do so, subject to
+  # the following conditions:
+  # 
+  # The above copyright notice and this permission notice shall be
+  # included in all copies or substantial portions of the Software.
+  # 
+  # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION.yml

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

data/lib/fiveruns-dash-datamapper.rb

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

data/lib/fiveruns/dash/datamapper.rb

@@ -0,0 +1,11 @@
+gem 'fiveruns-dash-ruby'
+require 'fiveruns/dash'
+
+require 'fiveruns/dash/recipes/datamapper'
+
+module Fiveruns::Dash::DataMapper
+  DB_TARGETS = %w(DataMapper::Adapters::DataObjectsAdapter#execute)
+  ORM_TARGETS = %w(read_many read_one update delete).map do |meth|
+    "DataMapper::Repository##{meth}"
+  end
+end

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

@@ -0,0 +1,41 @@
+Fiveruns::Dash.register_recipe :datamapper, :url => 'http://dash.fiveruns.com' do |recipe|
+
+  recipe.time :db_time, 'Database Time', :methods => Fiveruns::Dash::DataMapper::DB_TARGETS  
+  recipe.time :orm_time, 'DataMapper Time', :methods => Fiveruns::Dash::DataMapper::ORM_TARGETS,
+                                             :reentrant => true
+  recipe.added do |settings|
+
+    # 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 "Limiting FiveRuns Dash DataMapper metrics to within #{total_time}"
+      # Limit timing
+      recipe.metrics.each do |metric|
+        if %w(db_time orm_time).include?(metric.name) && metric.recipe.url == 'http://dash.fiveruns.com'
+          metric.options[:only_within] = total_time
+        end
+      end
+
+      recipe.percentage :orm_util, 'DataMapper Utilization', :sources => ["orm_time", total_time] do |orm_time, all_time|
+        all_time == 0 ? 0 : (orm_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 `datamapper' recipe to the configuration;",
+        "Please provide a :total_time metric name setting when adding the recipe.",
+        "For more information, see the fiveruns-dash-datamapper README"
+      ].join("\n")
+      
+    end
+    
+  end
+
+end

data/test/datamapper_test.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) << "/test_helper"
+
+Fiveruns::Dash.logger.level = Logger::FATAL
+
+class DataMapperTest < Test::Unit::TestCase
+
+  class TestModel
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+  end
+
+  class TestEngine
+    def doit
+      sleep 1
+      2.times do
+        t = TestModel.create(:name => 'foo')
+        t.destroy
+      end
+    end
+
+    def conn
+      # FIXME: We need a way to suspend execution temporarily
+      #        for a specific w/in the DB; sqlite doesn't support sleep()
+      #        ... otherwise we need to mock `execute'
+      TestModel.repository.adapter.execute("select sleep(1)")
+    end
+
+    def entry(meth)
+      send(meth)
+    end
+  end
+  
+
+  context "Metric" do
+    
+    setup do
+      DataMapper.setup(:default, 'sqlite3::memory:') 
+      DataMapper.auto_migrate!
+    end
+
+    should "collect basic ORM metrics" do
+      scenario do
+        TestEngine.new.entry(:doit)
+
+        data = Fiveruns::Dash.session.data
+        assert metric('test_time', data) > 1.0
+        assert metric('orm_util', data) > metric('db_util', data)
+        assert metric('db_util', data) < 5
+      end
+    end
+
+    should "collect DB metrics" do
+      scenario do
+        TestEngine.new.entry(:conn)
+        
+        data = Fiveruns::Dash.session.data
+        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 scenario(&block)
+    child = fork do
+      mock_datamapper!
+      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_datamapper!
+    
+    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 => 'DataMapperTest::TestEngine#entry',
+                                           :mark => true
+    end
+    
+    Fiveruns::Dash.start :app => '666' do |config|
+      config.add_recipe :ruby
+      config.add_recipe :tester
+      config.add_recipe :datamapper, :total_time => 'test_time'
+    end
+    
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: fiveruns-dash-datamapper
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- FiveRuns Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-22 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Provides an API to send metrics from applications using DataMapper to the FiveRuns Dash service
+email: dev@fiveruns.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/fiveruns
+- lib/fiveruns/dash
+- lib/fiveruns/dash/datamapper.rb
+- lib/fiveruns/dash/recipes
+- lib/fiveruns/dash/recipes/datamapper.rb
+- lib/fiveruns-dash-datamapper.rb
+- test/datamapper_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fiveruns/dash-datamapper
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: FiveRuns Dash recipe for DataMapper
+test_files: []
+