rpm_contrib 1.0.0

data/CHANGELOG

@@ -0,0 +1,7 @@
+* Version 1.0.0
+
+  Initial Release:
+  - Camping
+  - Authlogic
+  - DelayedJob
+  - Paperclip

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 New Relic, Inc.
+
+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/README.md

@@ -0,0 +1,34 @@
+# The RPM Contrib Gem
+
+The `rpm_contrib` gem contains instrumentation for the New Relic RPM agent
+contributed by the community of RPM users.  It requires the RPM Agent
+to run.
+
+We encourage contributions to this project and will provide whatever
+assistance we can to those wishing to develop instrumentation for
+other open source Ruby libraries.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the http://www.github.com/newrelic/rpm_contrib project.
+* Add instrumentation files to `lib/rpm_contrib/instrumentation`.  These
+  files will be loaded when the RPM agent is initialized.
+* Add samplers to `lib/rpm_contrib/samplers`.  These classes are
+  installed automatically when the RPM agent is initialized.
+* Add tests.  
+* Commit, do not mess with the Rakefile, version, or history.  (if you
+  want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Further Information
+
+Refer to the [Agent API Documentation](http://newrelic.github.com/rpm).
+
+See [the support site](http://support.newrelic.com/faqs) for additional tips and documentation.
+
+Contact support@newrelic.com for help.
+
+## Copyright
+
+Copyright (c) 2010 New Relic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+# See http://www.rubygems.org/read/chapter/20 
+
+def version
+  @rpm_contrib_version ||= File.read("CHANGELOG")[/Version ([\d\.]+)$/, 1]
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rpm_contrib"
+    gem.summary = %Q{Contributed Instrumentation for New Relic RPM}
+    gem.description = <<-EOF
+      Community contributed instrumentation for various frameworks based on
+      the New Relic Ruby monitoring gem newrelic_rpm.
+    EOF
+    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.version = version
+    gem.files = FileList['LICENSE', 'README*', 'lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rpm_contrib #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/rpm_contrib/instrumentation/authlogic.rb

@@ -0,0 +1,8 @@
+if defined? Authlogic::Session::Base
+  Authlogic::Session::Base.class_eval do
+  #  add_method_tracer :record, 'Authlogic/record'
+    class << self
+      add_method_tracer :find, 'Authlogic/find'
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/camping.rb

@@ -0,0 +1,74 @@
+require 'new_relic/agent/instrumentation/controller_instrumentation'
+
+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
+    # 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:
+    #
+    #					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
+    #
+    #					production:
+    #					  <<: *default_settings
+    #					  enabled: true
+    #
+    #	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
+    #
+    #		include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+    #		include NewRelic::Agent::Instrumentation::Camping
+    #	end
+    #
+    #	NewRelic::Agent.manual_start 
+    #
+    
+    module Camping
+      
+      def self.included(mod)
+        
+        # Since the Camping::Base module is essentially copied
+        # into the main module (the mod passed in) of a Camping app 
+        # using the Camping.goes :NewRelicCampingTest syntax
+        # 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
+        end
+      end
+      
+    end	#RPMContrib::Instrumentation::Camping
+  end
+end

data/lib/rpm_contrib/instrumentation/delayed_job_instrumentation.rb

@@ -0,0 +1,45 @@
+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/instrumentation/paperclip.rb

@@ -0,0 +1,22 @@
+# Paperclip Instrumentation.
+ 
+if defined? ::Paperclip
+ 
+  ::Paperclip::Attachment.class_eval do
+    add_method_tracer :save, 'Paperclip/#{name}/save'
+    add_method_tracer :assign, 'Paperclip/#{name}/assign'
+    add_method_tracer :post_process, 'Paperclip/#{name}/post_process'
+  end
+ 
+  ::Paperclip::Storage::Filesystem.class_eval do
+    add_method_tracer :flush_deletes, 'Paperclip/Storage/flush_deletes' 
+    add_method_tracer :flush_writes, 'Paperclip/Storage/flush_writes'                            
+  end
+ 
+  ::Paperclip::Storage::S3.class_eval do
+    add_method_tracer :flush_deletes, 'Paperclip/Storage/flush_deletes' 
+    add_method_tracer :flush_writes, 'Paperclip/Storage/flush_writes'                            
+  end
+  
+end
+  

data/lib/rpm_contrib/samplers/delayed_job_lock_sampler.rb

@@ -0,0 +1,28 @@
+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/lib/rpm_contrib.rb

@@ -0,0 +1,17 @@
+# Hook instrumentation and samplers in this gem into the normal RPM
+# start up sequence.
+require 'newrelic_rpm'
+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]
+end

data/test/delayed_job_instrumentation/delayed_job_test.rb

@@ -0,0 +1,108 @@
+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

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rpm_contrib'
+
+class Test::Unit::TestCase
+end

data/test/test_rpm_contrib.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRpmContrib < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: rpm_contrib
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Bill Kayser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-28 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 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.2.2
+    version: 
+description: "      Community contributed instrumentation for various frameworks based on\n      the New Relic Ruby monitoring gem newrelic_rpm.\n"
+email: support@newrelic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- lib/rpm_contrib.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/test_rpm_contrib.rb
+has_rdoc: true
+homepage: http://github.com/newrelic/rpm_contrib
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+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/test_rpm_contrib.rb