rpm_contrib 1.0.0 → 1.0.2

data/CHANGELOG

@@ -1,3 +1,11 @@
+* Version 1.0.2
+ 
+  Improved Camping support
+
+* Version 1.0.1
+
+  Removed DelayedJob, put back in core agent
+
 * Version 1.0.0
 
   Initial Release:

data/Rakefile

@@ -18,7 +18,7 @@ begin
     gem.email = "support@newrelic.com"
     gem.homepage = "http://github.com/newrelic/rpm_contrib"
     gem.author = "Bill Kayser"
-    gem.add_dependency 'newrelic_rpm', '>= 2.10.2.2'
+    gem.add_dependency 'newrelic_rpm', '>= 2.10.6'
     gem.version = version
     gem.files = FileList['LICENSE', 'README*', 'lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
   end

data/lib/new_relic/control/camping.rb

@@ -0,0 +1,12 @@
+require 'new_relic/control/ruby'
+# This is the framework control object for Camping apps.
+# It is loaded by virtue of detecting 'camping' as the framework
+# in the rpm_contrib/detection/camping.rb file.  It gets loaded
+# by the new_relic/control.rb file.
+class NewRelic::Control::Camping < NewRelic::Control::Ruby
+  def init_config(options)
+    super
+    @local_env.dispatcher = 'camping'
+    self['app_name'] ||= 'Camping Application'
+  end
+end

data/lib/rpm_contrib.rb

@@ -1,17 +1,25 @@
-# Hook instrumentation and samplers in this gem into the normal RPM
-# start up sequence.
-require 'newrelic_rpm'
+
+RPM_CONTRIB_LIB = File.dirname(__FILE__)
+
 module RPMContrib
-  
-  lib_root = File.dirname(__FILE__)
-  
-  # Tell the agent to load all the files in the rpm_contrib/instrumentation directory.
-  
-  NewRelic::Agent.add_instrumentation(lib_root+"/rpm_contrib/instrumentation/**/*.rb")
-
-  # Load all the Sampler class definitions.  These will register
-  # automatically with the agent.
-  Dir.glob(lib_root + "/rpm_contrib/samplers/**/*.rb") { |file| require file }
-  
-  VERSION = File.read(lib_root+"/../CHANGELOG")[/Version ([\d\.]+)$/, 1]
+  VERSION = File.read(RPM_CONTRIB_LIB+"/../CHANGELOG")[/Version ([\d\.]+)$/, 1]
 end
+
+
+# Perform any framework/dispatcher detection before loading the rpm
+# gem.
+
+raise "The rpm_contrib gem must be loaded before the newrelic_rpm gem." if defined?(::NewRelic)
+
+Dir.glob(RPM_CONTRIB_LIB + "/rpm_contrib/detection/**/*.rb") { |file| require file }
+
+require 'newrelic_rpm'
+
+# Tell the agent to load all the files in the rpm_contrib/instrumentation directory.
+
+NewRelic::Agent.add_instrumentation(RPM_CONTRIB_LIB+"/rpm_contrib/instrumentation/**/*.rb")
+
+# Load all the Sampler class definitions.  These will register
+# automatically with the agent.
+Dir.glob(RPM_CONTRIB_LIB + "/rpm_contrib/samplers/**/*.rb") { |file| require file }
+

data/lib/rpm_contrib/detection/camping.rb

@@ -0,0 +1,23 @@
+# Detect when running under camping and set the framework and dispatcher.
+
+module NewRelic
+  class LocalEnvironment
+    module Camping
+      def discover_framework
+        if defined?(::Camping)
+          puts "framework is camping"
+          @framework = 'camping'
+        else
+          super
+        end
+      end
+      def discover_dispatcher
+        super
+        if defined?(::Camping) && @dispatcher.nil?
+          @dispatcher = 'camping'
+        end
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation/camping.rb

@@ -4,39 +4,33 @@ module RPMContrib
   module Instrumentation
     # == Instrumentation for Camping
     # To instrument all controllers do the following:
-    # 1. Add the necessary NewRelic-specific requires in your require section
+    # 1. Add require 'rpm_contrib' after loading camping.
     # 2. Add an include at the end of your main Camping app module
-    # 3. Add a call to NewRelic::Agent.manual_start  at the end of the file to start the agent
-    # 4. Run the following command to get the NewRelic license key to use: heroku config -all
-    # 5. Create a newrelic.yml under the /config folder with the following content:
+    # 3. Run the following command to get the NewRelic license key to use: heroku config -all
+    # 4. Create a newrelic.yml under the /config folder with the following content:
     #
-    #					common: &default_settings
-    #  					  license_key: 'PASTE THE VALUE OF NEW_RELIC_LICENSE_KEY HERE'
-    #					  agent_enabled: true
-    #					  app_name: PASTE THE NAME OF YOUR CAMPING APP HERE
-    #					  enabled: true
+    #	 common: &default_settings
+    #       license_key: 'PASTE THE VALUE OF NEW_RELIC_LICENSE_KEY HERE'
+    #	    app_name: PASTE THE NAME OF YOUR CAMPING APP HERE
+    #	    monitor_mode: true
     #
-    #					production:
-    #					  <<: *default_settings
-    #					  enabled: true
+    #	 production:
+    #       <<: *default_settings
+    #
+    # Camping code example:
+    # -------------------------------------------------------------------------------------
     #
-    #	Camping code example:
-    #	--------------------------------------------------------------------------------------
     #	require "newrelic_rpm"
-    #	require 'new_relic/agent/agent'
-    #	require 'new_relic/agent/instrumentation/controller_instrumentation'
-    #	require 'new_relic/agent/instrumentation/camping'
     #
     #	Camping.goes :NewRelicCampingTest
     #
     #	module NewRelicCampingTest
-    #		# your code
+    #	  # your code
+    #
+    #	  include NewRelic::Agent::Instrumentation::Camping
     #
-    #		include NewRelic::Agent::Instrumentation::ControllerInstrumentation
-    #		include NewRelic::Agent::Instrumentation::Camping
     #	end
     #
-    #	NewRelic::Agent.manual_start 
     #
     
     module Camping
@@ -49,23 +43,8 @@ module RPMContrib
         # we need to evaluate "weld" the NewRelic plugin in the context of the new Base
         
         (Kernel.const_get(mod.name)::Base).module_eval do
-          
-          # Add the new method to the Camping app's Base module
-          # since the Camping::Base module is being included
-          # in every Camping controller
-          
-          def service_with_newrelic(*args)
-            perform_action_with_newrelic_trace(:category => :rack) do
-              service_without_newrelic(*args)
-            end
-          end
-          
-          # Alias the "standard" service method
-          # so we can provide a level of indirection 
-          # to perform the tracing for NewRelic
-          
-          alias service_without_newrelic service
-          alias service service_with_newrelic
+          include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+          add_transaction_tracer :service
         end
       end
       

data/test/helper.rb

@@ -3,7 +3,10 @@ require 'test/unit'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'newrelic_rpm'
 require 'rpm_contrib'
 
 class Test::Unit::TestCase
 end
+
+require 'schema.rb'

data/test/schema.rb

@@ -0,0 +1,19 @@
+# Use this file to add tables you need to do testing
+# These are created in a sqllite memory DB
+
+begin
+  require 'sqlite3'
+  require 'active_record'
+  
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+  ActiveRecord::Migration.verbose = false
+
+  ActiveRecord::Schema.define do
+
+    create_table :stories, :force => true do |table|
+      table.string :text
+    end
+  end
+rescue LoadError
+  # Skip AR tests
+end

data/test/test_rpm_contrib.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require "#{File.dirname(__FILE__)}/helper"
 
 class TestRpmContrib < Test::Unit::TestCase
   def test_something_for_real

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rpm_contrib
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Bill Kayser
@@ -9,19 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -08:00
+date: 2010-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: newrelic_rpm
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.10.2.2
-    version: 
+        segments: 
+        - 2
+        - 10
+        - 6
+        version: 2.10.6
+  type: :runtime
+  version_requirements: *id001
 description: "      Community contributed instrumentation for various frameworks based on\n      the New Relic Ruby monitoring gem newrelic_rpm.\n"
 email: support@newrelic.com
 executables: []
@@ -36,14 +45,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/new_relic/control/camping.rb
 - lib/rpm_contrib.rb
+- lib/rpm_contrib/detection/camping.rb
 - lib/rpm_contrib/instrumentation/authlogic.rb
 - lib/rpm_contrib/instrumentation/camping.rb
-- lib/rpm_contrib/instrumentation/delayed_job_instrumentation.rb
 - lib/rpm_contrib/instrumentation/paperclip.rb
-- lib/rpm_contrib/samplers/delayed_job_lock_sampler.rb
-- test/delayed_job_instrumentation/delayed_job_test.rb
 - test/helper.rb
+- test/schema.rb
 - test/test_rpm_contrib.rb
 has_rdoc: true
 homepage: http://github.com/newrelic/rpm_contrib
@@ -58,22 +67,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Contributed Instrumentation for New Relic RPM
 test_files: 
-- test/delayed_job_instrumentation/delayed_job_test.rb
 - test/helper.rb
+- test/schema.rb
 - test/test_rpm_contrib.rb

data/lib/rpm_contrib/instrumentation/delayed_job_instrumentation.rb

@@ -1,45 +0,0 @@
-module RPMContrib::Instrumentation::DelayedJobInstrumentation
-  extend self
-  Delayed::Job.class_eval do
-    include NewRelic::Agent::Instrumentation::ControllerInstrumentation
-    if self.instance_methods.include?('name')
-      add_transaction_tracer "invoke_job", :category => :task, :name => '#{self.name}'
-    else
-      add_transaction_tracer "invoke_job", :category => :task
-    end
-  end
-  
-  Delayed::Worker.class_eval do
-    def initialize_with_new_relic(*args)
-      initialize_without_new_relic(*args)
-      NewRelic::.delayed_worker = self          
-    end
-    
-    alias initialize_without_new_relic initialize
-    alias initialize initialize_with_new_relic
-  end
-  
-  def delayed_worker=(w)
-    @delayed_worker = w
-    env = NewRelic::Control.instance.local_env
-    env.dispatcher = :delayed_job
-    env.dispatcher_instance_id = case
-      when @delayed_worker.respond_to?(:name)
-        @delayed_worker.name
-      when @delayed_worker.class.respond_to?(:default_name)
-        @delayed_worker.class.default_name
-      else
-        "host:#{Socket.gethostname} pid:#{Process.pid}" rescue "pid:#{Process.pid}"
-      end
-      
-      env.append_environment_value 'Dispatcher', @dispatcher.to_s
-      env.append_environment_value 'Dispatcher instance id', @dispatcher_instance_id
-      
-      @delayed_worker
-  end
-  
-  def delayed_worker
-    @delayed_worker
-  end
-  
-end if defined?(Delayed::Job)

data/lib/rpm_contrib/samplers/delayed_job_lock_sampler.rb

@@ -1,28 +0,0 @@
-module NewRelic::Agent::Samplers
-  class DelayedJobLockSampler < NewRelic::Agent::Sampler
-    def initialize
-      super :delayed_job_lock
-      raise Unsupported, "No delayed job workers running" unless Instrumentation::DelayedJobInstrumentation.delayed_worker
-    end
-    
-    def stats
-      stats_engine.get_stats("DJ/Locked Jobs", false)
-    end
-    
-    def local_env
-      NewRelic::Control.instance.local_env
-    end
-    
-    def worker_name
-      local_env.dispatcher_instance_id
-    end
-    
-    def locked_jobs
-      Delayed::Job.count(:conditions => {:locked_by => worker_name})
-    end
-    
-    def poll
-      stats.record_data_point locked_jobs
-    end
-  end
-end

data/test/delayed_job_instrumentation/delayed_job_test.rb

@@ -1,108 +0,0 @@
-module DelayedJobInstrumentation 
-  require File.expand_path(File.join(File.dirname(__FILE__),'/../test_helper'))
-    
-  class LongRunningJob
-    def perform
-      sleep 5
-    end
-  end
-  
-  class NamedJob
-    def display_name
-      'some custom name'
-    end
-    def perform
-      true
-    end
-  end
-  
-  class DelayedJobTest < Test::Unit::TestCase
-    def local_env
-      NewRelic::Control.instance.local_env
-    end
-    
-    def worker_name
-      local_env.dispatcher_instance_id
-    end
-    
-    def lock_n_jobs(n=1)
-      n.times do
-        job = Delayed::Job.create
-        job.update_attributes({
-          :locked_at => Time.now,
-          :locked_by => worker_name
-        })
-      end
-    end
-    
-    def setup      
-      NewRelic::Agent.manual_start
-      @agent = NewRelic::Agent.instance
-      
-      @agent.transaction_sampler.harvest
-      @agent.stats_engine.clear_stats
-    end
-
-    def teardown
-      @agent.instance_variable_set("@histogram", NewRelic::Histogram.new)
-    end
-    
-    def test_job_instrumentation
-      job = Delayed::Job.new(:payload_object => LongRunningJob.new)
-      job_name = "Controller/Task/Delayed::Job/LongRunningJob"
-            
-      job.invoke_job
-      job_stats = @agent.stats_engine.get_stats(job_name)
-      
-      assert @agent.stats_engine.metrics.include?(job_name)
-      assert_equal 1, job_stats.call_count
-    end
-    
-    def test_custom_name
-      job = Delayed::Job.new(:payload_object => NamedJob.new)
-      job_name = "Controller/Task/Delayed::Job/some custom name"
-            
-      job.invoke_job
-      job_stats = @agent.stats_engine.get_stats(job_name)
-      
-      assert @agent.stats_engine.metrics.include?(job_name)
-      assert_equal 1, job_stats.call_count
-    end
-    
-    def test_lock_sampler
-      stats_engine = NewRelic::Agent::StatsEngine.new
-      sampler = NewRelic::Agent::Samplers::DelayedJobLockSampler.new
-      sampler.stats_engine = stats_engine
-            
-      lock_n_jobs(1)
-      sampler.poll
-      
-      assert_equal 1, sampler.stats.data_point_count
-      assert_equal 1, sampler.stats.min_call_time
-      assert_equal 1, sampler.stats.max_call_time
-      
-      lock_n_jobs(4)
-      sampler.poll
-      
-      assert_equal 2, sampler.stats.data_point_count
-      assert_equal 1, sampler.stats.min_call_time
-      assert_equal 5, sampler.stats.max_call_time
-      
-      lock_n_jobs(5)
-      sampler.poll
-      sampler.poll
-      
-      assert_equal 4, sampler.stats.data_point_count
-      assert_equal 1, sampler.stats.min_call_time
-      assert_equal 10, sampler.stats.max_call_time
-      
-      Delayed::Job.destroy_all
-      sampler.poll
-      
-      assert_equal 5, sampler.stats.data_point_count
-      assert_equal 0, sampler.stats.min_call_time
-      assert_equal 10, sampler.stats.max_call_time
-    end
-    
-  end
-end if defined? Delayed::Job