staugaard-rpm_contrib 1.0.7

data/CHANGELOG

@@ -0,0 +1,35 @@
+* Version 1.0.7
+
+  Resque instrumentation now supports the resque-multi-job-forks plugin
+
+* Version 1.0.6
+
+  Update newrelic dependency: depends on 2.11.1
+
+* Version 1.0.5
+
+  Clear stats in forked resque jobs
+
+* Version 1.0.4
+
+  Resque support
+
+* Version 1.0.3
+
+  MongoDB instrumentation contributed by John Nunemaker
+
+* Version 1.0.2
+ 
+  Improved Camping support
+
+* Version 1.0.1
+
+  Removed DelayedJob, put back in core agent
+
+* 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,147 @@
+# 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.
+
+To use the contrib gem, install the `rpm_contrib` gem from gemcutter.
+It will also install the required version of the `newrelic_rpm` gem if
+it's not already installed.
+
+For Rails 2.1 and later, add this dependency to your in your
+environment.rb:
+
+    config.gem 'rpm_contrib'
+
+For other frameworks, make sure you load rubygems if it isn't already,
+then just require the contrib gem:
+
+    require 'rubygems'
+    require 'rpm_contrib'
+
+When you load the rpm_contrib gem, the `newrelic_rpm` gem will also be
+initialized.  No need for a separate require statement for
+`newrelic_rpm`.  The `rpm_contrib` gem must be loaded before the
+`newrelic_rpm` gem initializes.
+
+# Supported Frameworks
+
+A number of frameworks are supported in the contrib gem.  They are all
+turned on by default but you can add settings to your newrelic.yml to
+disable any of them.
+
+### Camping
+
+### Paperclip
+
+### Authlogic
+
+### MongoDB
+
+### Resque
+
+To disable resque, add this to your newrelic.yml:
+
+    disable_resque: true
+
+
+# How to Add Custom Instrumentation
+
+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.
+
+When adding instrumentation to this gem, be sure and get familiar with the
+[RPM Agent API](http://newrelic.github.com/rpm/classes/NewRelic/Agent.html)
+and contact support@newrelic.com with any questions.
+
+There are several extension points in the agent you can take advantage of
+with this gem.
+
+* Custom tracers which measure methods and give visibility to
+  otherwise unmeasured libraries.
+* Samplers which sample some value about once a minute.
+* Dispatcher support for web request handlers which would otherwise be undetected.
+  In order for the agent to turn on in 'auto' mode it needs to discover a 
+  web dispatcher, or be [started manually](http://support.newrelic.com/faqs/general/manual-start).
+* Framework support, for alternatives to Rails like Camping or Ramaze
+
+## Custom Tracers
+
+Custom tracers for frameworks should be added to the `lib/rpm_contrib/instrumentation`
+directory.  These files are loaded at the time the Agent starts.  **They will not
+be loaded if the Agent does not start up.** 
+
+It is important that you wrap any instrumentation with the checks necessary
+to determine if the code being instrumented is loaded.  You can't add code to the
+contrib gem that will break when run in any other context besides yours.
+
+
+For details on how to define custom tracers, refer to the [support documentation on adding
+custom tracers](http://support.newrelic.com/faqs/docs/custom-metric-collection).  You 
+can also get detailed information on the API from the 
+[Agent method tracing rdocs](http://newrelic.github.com/rpm/classes/NewRelic/Agent/MethodTracer.html),
+especially the [add_method_tracer](http://newrelic.github.com/rpm/classes/NewRelic/Agent/MethodTracer/ClassMethods.html)
+docs.
+
+A good example can be found in `lib/rpm_contrib/instrumentation/paperclip.rb`.
+
+## Samplers
+
+You can add samplers which will record metrics approximately once a minute.  Samplers
+are useful for capturing generic instrumentation for display in 
+[custom views](http://support.newrelic.com/faqs/docs/custom-dashboard-specification).
+
+Samplers should extend the [`NewRelic::Agent::Sampler`](http://newrelic.github.com/rpm/classes/NewRelic/Agent/Sampler.html)
+class.  They should be placed in the `samplers` directory.
+
+Refer to examples in the RPM agent to see how to get started.
+
+## Supporting New Dispatchers
+
+If you want to add support for a new dispatcher which is not being recognized by default
+by the RPM agent, add code to the `rpm_contrib/detection` directory.  This code needs
+to define a module in the `NewRelic::LocalEnvironment` class.  This module will be 
+accessed at the time environment detection takes place, when the agent is initialized.
+
+This module should define the method `discover_dispatcher` and return the name of the
+dispatcher if detected, or defer to super.  See `rpm_contrib/detection/camping.rb`
+for a good example.
+
+## Supporting New Frameworks
+
+Supporting new frameworks can be pretty involved and generally involves both
+adding custom instrumentation as well as framework and dispatcher detection.
+
+In addition it will be necessary to define a new control class with the same 
+name as the framework.  This control class must go in `new_relic/control`.
+
+Refer to the camping example in this gem to see how this is done in general.
+
+If you decide to tackle any new frameworks, contact support@newrelic.com and
+we'll be happy to help you work through it.
+
+# 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,62 @@
+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 = "staugaard-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.11.1'
+    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('LICENSE')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+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

@@ -0,0 +1,34 @@
+
+RPM_CONTRIB_LIB = File.dirname(__FILE__)
+
+module RPMContrib
+  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'
+
+init_sequence = Proc.new do
+  
+  # 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 }
+end
+
+if defined?(Rails.configuration)
+  Rails.configuration.after_initialize &init_sequence
+else
+  init_sequence.call
+end
+
+

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/detection/resque.rb

@@ -0,0 +1,15 @@
+# Detect when running under camping and set the framework and dispatcher.
+
+module NewRelic
+  class LocalEnvironment
+    module Resque
+      def discover_dispatcher
+        super
+        if defined?(::Resque::Worker) && @dispatcher.nil?
+          @dispatcher = 'resque'
+        end
+      end
+    end
+  end
+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,53 @@
+require 'new_relic/agent/instrumentation/controller_instrumentation'
+
+module RPMContrib
+  module Instrumentation
+    # == Instrumentation for Camping
+    # To instrument all controllers do the following:
+    # 1. Add require 'rpm_contrib' after loading camping.
+    # 2. Add an include at the end of your main Camping app module
+    # 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'
+    #	    app_name: PASTE THE NAME OF YOUR CAMPING APP HERE
+    #	    monitor_mode: true
+    #
+    #	 production:
+    #       <<: *default_settings
+    #
+    # Camping code example:
+    # -------------------------------------------------------------------------------------
+    #
+    #	require "newrelic_rpm"
+    #
+    #	Camping.goes :NewRelicCampingTest
+    #
+    #	module NewRelicCampingTest
+    #	  # your code
+    #
+    #	  include NewRelic::Agent::Instrumentation::Camping
+    #
+    #	end
+    #
+    #
+    
+    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
+          include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+          add_transaction_tracer :service
+        end
+      end
+      
+    end	#RPMContrib::Instrumentation::Camping
+  end
+end

data/lib/rpm_contrib/instrumentation/mongodb.rb

@@ -0,0 +1,40 @@
+# Just drop this little diddy in your app to get some (not perfect) information on query times and such
+# This will eventually become an official plugin but for those who can't wait, enjoy.
+
+if defined?(::MongoMapper)
+  module MMNewRelicTracing
+    def self.included(model)
+      model.metaclass.class_eval do
+        add_method_tracer :find,        'Database/#{self.name}/find'
+        add_method_tracer :find!,       'Database/#{self.name}/find!'
+        add_method_tracer :paginate,    'Database/#{self.name}/paginate'
+        add_method_tracer :first,       'Database/#{self.name}/first'
+        add_method_tracer :last,        'Database/#{self.name}/last'
+        add_method_tracer :all,         'Database/#{self.name}/all'
+        add_method_tracer :count,       'Database/#{self.name}/count'
+        add_method_tracer :create,      'Database/#{self.name}/create'
+        add_method_tracer :create!,     'Database/#{self.name}/create!'
+        add_method_tracer :update,      'Database/#{self.name}/update'
+        add_method_tracer :delete,      'Database/#{self.name}/delete'
+        add_method_tracer :delete_all,  'Database/#{self.name}/delete_all'
+        add_method_tracer :destroy,     'Database/#{self.name}/destroy'
+        add_method_tracer :destroy_all, 'Database/#{self.name}/destroy_all'
+        add_method_tracer :exists?,     'Database/#{self.name}/exists?'
+        add_method_tracer :find_by_id,  'Database/#{self.name}/find_by_id'
+        add_method_tracer :increment,   'Database/#{self.name}/increment'
+        add_method_tracer :decrement,   'Database/#{self.name}/decrement'
+        add_method_tracer :set,         'Database/#{self.name}/set'
+        add_method_tracer :push,        'Database/#{self.name}/push'
+        add_method_tracer :push_all,    'Database/#{self.name}/push_all'
+        add_method_tracer :push_uniq,   'Database/#{self.name}/push_uniq'
+        add_method_tracer :pull,        'Database/#{self.name}/pull'
+        add_method_tracer :pull_all,    'Database/#{self.name}/pull_all'
+      end
+      
+      model.class_eval do
+        add_method_tracer :save,        'Database/#{self.class.name}/save'
+      end
+    end
+  end
+  ::MongoMapper::Document.append_inclusions(MMNewRelicTracing)
+end

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/instrumentation/resque.rb

@@ -0,0 +1,34 @@
+# == Resque Instrumentation
+#
+# Installs a hook to ensure the agent starts manually when the worker
+# starts and also adds the tracer to the process method which executes
+# in the forked task.
+
+module RPMContrib
+  module Instrumentation
+    module ResqueInstrumentation
+      ::Resque::Job.class_eval do
+        include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+        
+        old_perform_method = instance_method(:perform)
+
+        define_method(:perform) do
+          class_name = (payload_class ||self.class).name
+          NewRelic::Agent.reset_stats if NewRelic::Agent.respond_to? :reset_stats
+          perform_action_with_newrelic_trace(:name => 'perform', :class_name => class_name,
+                                             :category => 'OtherTransaction/ResqueJob') do
+            old_perform_method.bind(self).call
+          end
+
+          NewRelic::Agent.shutdown unless defined?(::Resque.before_child_exit)
+        end
+      end
+
+      if defined?(::Resque.before_child_exit)
+        ::Resque.before_child_exit do |worker|
+          NewRelic::Agent.shutdown
+        end
+      end
+    end
+  end
+end if defined?(::Resque::Job) and not NewRelic::Control.instance['disable_resque']

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+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

@@ -0,0 +1,7 @@
+require "#{File.dirname(__FILE__)}/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,93 @@
+--- !ruby/object:Gem::Specification 
+name: staugaard-rpm_contrib
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 7
+  version: 1.0.7
+platform: ruby
+authors: 
+- Bill Kayser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newrelic_rpm
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 1
+        version: 2.11.1
+  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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- lib/new_relic/control/camping.rb
+- lib/rpm_contrib.rb
+- lib/rpm_contrib/detection/camping.rb
+- lib/rpm_contrib/detection/resque.rb
+- lib/rpm_contrib/instrumentation/authlogic.rb
+- lib/rpm_contrib/instrumentation/camping.rb
+- lib/rpm_contrib/instrumentation/mongodb.rb
+- lib/rpm_contrib/instrumentation/paperclip.rb
+- lib/rpm_contrib/instrumentation/resque.rb
+- test/helper.rb
+- test/schema.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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Contributed Instrumentation for New Relic RPM
+test_files: 
+- test/helper.rb
+- test/schema.rb
+- test/test_rpm_contrib.rb