wireframe-rpm_contrib 1.0.12.7 → 2.1.6.1

data/CHANGELOG

@@ -1,6 +1,72 @@
-* Version 1.0.12.7
+* Version 2.1.6.1
 
-  Add support for resque jobs running in backgrounded
+  Add instrumentation for Backgrounded Resque Job Processing Framework (Ryan
+	Sonnek)
+
+* Version 2.1.6
+  Community contributed instrumentation
+  - ThinkingSphinx instrumentation (W. Andrew Loe III)
+  - Riak instrumentation (Bryce Kerley)
+  - KyotoTycoon instrumentation (Keisuke Kawahara)
+  Community Contributed Bug Fixes
+  - MongoDB instrumentation (Kenn Ejima)
+  - Yajl instrumentation (Chris Griego)
+  - UltraSphinx instrumentation (Jonathan Rudenberg)
+  Renamed ActiveMQ instrumentation to ActiveMessaging (W. Andrew Loe III)
+
+* Version 2.1.5
+
+  Changed the resque detection so it does not depend on the load
+  order of resque => rpm_contrib => newrelic_rpm.  The gems can be
+  installed in any order.
+
+* Version 2.1.4
+
+  Updated requirements to latest agent with some bug fixes for background jobs
+  Converted instrumentation to install with DependencyDetection in the latest Agent
+  Changed Resque instrumentation from a plugin back to method chaining
+  Fixed several reported bugs related to resque
+
+* Version 2.1.3
+
+  Fixed typo in Resque instrumentation
+  Fixed double loading of AWS instrumentation
+
+* Version 2.1.2
+
+  Add a manual shutdown to the Resque instrumentation to make sure data is saved and sent - thanks to Jade Rubick
+
+* Version 2.1.1
+
+  Fix namespacing problem with Resque
+  Add instrumentation to Mongo::Cursor #refresh and #close - thanks to Chris Griego
+
+* Version 2.1.0
+
+  Included instrumentation from the community:
+  - Alexey Palazhchenko - mongo ORM-agnostic instrumentation
+  - Michael Breen - Elastic Search
+  - Paul Ingles - Sinatra Template instrumentation
+  - Siddharth Dawara - Typhoeus instrumentation
+  - Rob Meyer - ActiveMQ instrumentation
+  - Greg Hazel - Curb instrumentation
+  - Ben Poweski - Crack and Yajl instrumentation
+  - Chad Ingram and Scott Fleckenstein - Workling instrumentation
+  - Adam Weller - UltraSphinx instrumentation
+  - Liron Yahdav - work on the Resque instrumentation
+
+* Version 2.0.1
+
+  Fixed an error with Bundler and RubyGems 1.8.2 which caused the gem to always fail to load
+
+* Version 2.0.0
+
+  Updated to use the latest version of the Ruby Agent
+
+* Version 1.0.13
+
+  Removed use of 'metaclass' - no longer available from ActiveSupport as of Rails 3
+  Contributed by Chris Griego
 
 * Version 1.0.12
 
@@ -47,7 +113,7 @@
   MongoDB instrumentation contributed by John Nunemaker
 
 * Version 1.0.2
- 
+
   Improved Camping support
 
 * Version 1.0.1

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem 'newrelic_rpm', '>=3.1.1'
+
+group :test do
+  gem 'resque'
+  gem 'json'
+  gem 'mocha'
+end
+
+group :build do
+  gem 'jeweler'
+end

data/README.md

@@ -7,13 +7,15 @@ To use the rpm_contrib gem, install the `rpm_contrib` gem from rubygems.org.
 It will also install the required version of the `newrelic_rpm` gem if it's not
 already installed.
 
-For Rails 3.0 and later, add this dependency to your Gemfile:
+For Rails 3.0 and when using Bundler, add these dependencies to your Gemfile:
 
     gem 'rpm_contrib'
+    gem 'newrelic_rpm'
 
-For Rails 2.1 and later, add this dependency to your in your environment.rb:
+For Rails 2.1 and later, add these dependencies to your in your environment.rb:
 
     config.gem 'rpm_contrib'
+    config.gem 'newrelic_rpm'
 
 For other frameworks, make sure you load rubygems if it isn't already, then just
 require the rpm_contrib gem:
@@ -22,40 +24,160 @@ require the rpm_contrib gem:
     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.
+initialized.  No need for a separate require statement for `newrelic_rpm`. 
 
-# Supported Frameworks
+In non-Rails frameworks, it's important that the New Relic Agent gets
+loaded as late as possible, or that the final initialization hook is called 
+after all other frameworks have loaded:
+
+    DependencyDetection.detect!
+
+### Troubleshooting Startup
+
+If you've set up your gems to load as described above and you are still not seeing 
+data in RPM, there may be a bug in detecting your framework.  Try setting the 
+environment variable `NEWRELIC_DISPATCHER` to the name of your app server (Camping, 
+Resque, Rake, etc), and please report to us if this fixes the problem so we can
+fix the auto-detection logic.
+
+If this does not help then set the `log_level` to `debug` in the `newrelic.yml` file
+and examine the `newrelic_agent.log` file for errors after restarting your app.
+
+## 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.
 
+### ActiveMessaging
+
+The gem will detect the underlying ActiveMessaging::Processor class and instrument the `on_message` method
+
+It can be disabled with the `disable_active_messaging` flag in your newrelic.yml file.
+
+### Cassandra
+
+The gem will instrument Cassandra so it should be visible in transaction traces and the web transactions page.
+
+You can disable it with `disable_cassandra_instrumentation` in your newrelic.yml file.
+
 ### Camping
 
 The gem will detect a Camping app but you need to manually add the
-instrumentation to your configuration file.  See RPMContrib::Instrumentation::Camping 
-for more information.
+instrumentation to your configuration file.  See
+RPMContrib::Instrumentation::Camping for more information. 
+
+In addition you will need to load the gems in the following order: 1) Camping, 2) rpm_contrib,
+3) newrelic_rpm.
+
+### Crack
+
+The gem will instrument the Crack parsers for JSON and XML - you
+should see them in transaction traces and the web transactions page.
+
+You can disable it with `disable_crack` in your newrelic.yml file.
+
+### Curb
+
+The gem will instrument both Curl::Easy and Curl::Multi - they should show up similarly to Net::HTTP in the UI
+
+You can disable it with `disable_curb` in your newrelic.yml file.
+
+## Elastic Search
+
+The gem will instrument ElasticSearch::Client. The metrics should show up in the UI
+
+You can disable it with `disable_elastic_search_instrumentation` in your newrelic.yml file.
+
+## KyotoTycoon
+
+The gem will instrument KyotoTycoon.
+
+You can disable it with `disable_kyototycoon` in your newrelic.yml file.
 
 ### Paperclip
 
-No special configuration required for Paperclip visibility.  You can disable
-it by setting `disable_paperclip` to true in the newrelic.yml file.
+No special configuration required for Paperclip visibility.  
+
+You can disable it by setting `disable_paperclip` to true in your newrelic.yml file.
+
+### Picky
+
+The gem will instrument the [Picky semantic search engine](http://florianhanke.com/picky/) so it should be visible in transaction traces and the web transactions page.
+
+You can disable it with `disable_picky` in your newrelic.yml file.
 
 ### MongoDB
 
-Both MongoMapper and Mongoid are supported.  You can disable them both by setting
-'disable_mongodb' to true in the newrelic.yml file.
+Our instrumentation works on the underlying 'Mongo' library.  
+
+You can disable it by setting 'disable_mongodb' to true in your newrelic.yml file.
 
 ### Resque
 
+To instrument jobs you no longer need to have your Job class inherit from Resque::Job or include 
+the Resque::Plugins::NewRelicInstrumentation module.  The module definition was left in for 
+backward compatibility.
+
 To disable resque, set 'disable_resque' to true in your newrelic.yml file.
 
 ### Redis
 
 Redis instrumentation will record operations as well as `allWeb` and `allOther`
 summary metrics under the `Database/Redis` metric namespace. This instrumentation
-supports Redis versions 1.x and 2.x. To disable Redis instrumentation, set
-'disable_redis' to true in your newrelic.yml file.
+supports Redis versions 1.x and 2.x. 
+
+To disable Redis instrumentation, set 'disable_redis' to true in your newrelic.yml file.
+
+### Riak
+
+RiakClient is instrumented.  Its opereations are recorded under Database in the
+the response time graph.
+
+To disable Riak instrumentation, set 'disable_riak_client' to true in your newrelic.yml file.
+
+### Ripple
+
+Ripple is instrumented.  Its opereations are recorded under Database in the
+the response time graph.
+
+To disable Riak instrumentation, set 'disable_ripple' to true in your newrelic.yml file.
+
+### Sinatra view instrumentation
+
+This adds instrumentation to the `render` methods in Sinatra::Base
+
+You can disable it with `disable_sinatra_template` in your newrelic.yml file.
+
+### ThinkingSphinx instrumentation
+
+This adds instrumentation to the `initialize` and `results` method of ThinkingSphinx::Search
+
+You can disable it with `disable_thinking_sphinx` in your newrelic.yml file.
+
+
+### Typhoeus instrumentation
+
+This adds instrumentation to the Typhoeus::Request class for 'GET' requests
+
+You can disable it with `disable_typhoeus` in your newrelic.yml file.
+
+### Ultrasphinx instrumentation
+
+This adds basic instrumentation to the `run` and `results` method of Ultrasphinx::Search
+
+You can disable it with `disable_ultrasphinx` in your newrelic.yml file.
+
+### Workling
+
+This adds instrumentation to the Workling::Base and all children, for all defined public methods not inherited from the Workling::Base class
+
+You can disable it with `disable_workling` in your newrelic.yml file.
+
+### YAJL
+
+This adds instrumentation to the YAJL json parser
+
+You can disable it with `disable_yajl_instrumentation` in your newrelic.yml file.
 
 ### AWS/S3
 
@@ -150,7 +272,8 @@ we'll be happy to help you work through it.
   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.  
+* Add tests.
+* Update README.md
 * 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)

data/Rakefile

@@ -1,9 +1,10 @@
 require 'rubygems'
+require "bundler/setup"
 require 'rake'
 # See http://www.rubygems.org/read/chapter/20 
 
 def version
-  @rpm_contrib_version ||= File.read("CHANGELOG")[/Version ([\d\.]+)$/, 1]
+  @rpm_contrib_version ||= File.read("CHANGELOG")[/Version ([\d\.]+\w*)$/, 1]
 end
 
 RDOC_FILES = FileList['README*','LICENSE','CHANGELOG']
@@ -21,10 +22,11 @@ begin
     gem.description = DESCRIPTION
     gem.email = "support@newrelic.com"
     gem.homepage = "http://github.com/newrelic/rpm_contrib"
-    gem.author = "Bill Kayser"
-    gem.add_dependency 'newrelic_rpm', '>=2.13.1'
+    gem.authors = [ "Bill Kayser", "Jon Guymon" ]
+    gem.add_dependency 'newrelic_rpm', '>=3.1.1'
     gem.version = version
     gem.files = FileList['LICENSE', 'README*', 'lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+    gem.files.exclude *File.read(File.join(File.dirname(__FILE__), '.gitignore')).split
     gem.rdoc_options <<
       "--line-numbers" <<
       "--inline-source" <<

data/lib/rpm_contrib.rb

@@ -1,43 +1,36 @@
 RPM_CONTRIB_LIB = File.dirname(__FILE__)
 
-module RPMContrib
-  VERSION = File.read(RPM_CONTRIB_LIB+"/../CHANGELOG")[/Version ([\d\.]+)$/, 1]
+module RPMContrib; end
 
-  def self.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
-  end
-
-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 'rpm_contrib/detection'
 
 require 'newrelic_rpm'
+require 'rpm_contrib/agent_compatibility'
+require 'rpm_contrib/instrumentation'
+
+# Load all the Sampler class definitions.  These will register
+# automatically with the agent.
+require 'rpm_contrib/samplers'
 
 if defined? Rails
   # Rails 3.x+
   if Rails.respond_to?(:version) && Rails.version =~ /^3/
     module NewRelic
       class Railtie < Rails::Railtie
-        initializer("rpm_contrib.start_plugin", &RPMContrib.init_sequence)
+        initializer("rpm_contrib.start_plugin"){ NewRelic::Control.instance.init_plugin }
       end
     end
   # Rails 2.x
   elsif defined?(Rails) && Rails.respond_to?(:configuration)
-    Rails.configuration.after_initialize &RPMContrib.init_sequence
+    Rails.configuration.after_initialize { NewRelic::Control.instance.init_plugin }
   else
     raise "The rpm_contrib gem supports Rails 2.2+ only."
   end
 else
-  RPMContrib.init_sequence.call
-end
+  # If not running Rails, it is important that you load the contrib gem as late 
+  # as possible so the agent initializes after everything else.  Either that 
+  # or make the following call yourself at the end of your startup sequence
+  # (it is idempotent).
+  NewRelic::Control.instance.init_plugin 
+end
+

data/lib/rpm_contrib/agent_compatibility.rb

@@ -0,0 +1,11 @@
+if NewRelic::VERSION::STRING < '3.2.0'
+  module DependencyDetection
+    def self.dependency_by_name(name)
+      @@items.find {|i| i.name == name }
+    end
+
+    class Dependent
+      attr_reader :name
+    end
+  end
+end

data/lib/rpm_contrib/detection.rb

@@ -0,0 +1,5 @@
+# Currently the only framework we are detecting with an agent
+# patch is camping.  You need to specify the camping gem prior
+# to the contrib gem and newrelic agent gem in order for this to work.
+require 'rpm_contrib/detection/camping'
+

data/lib/rpm_contrib/detection/camping.rb

@@ -1,6 +1,6 @@
 module NewRelic #:nodoc:
   # The class defined in the
-  # newrelic_rpm[http://newrelic.github.com/rpm] which can be ammended
+  # newrelic_rpm[http://newrelic.github.com/rpm] which can be amended
   # to support new frameworks by defining modules in this namespace.
   class LocalEnvironment #:nodoc:
     module Camping

data/lib/rpm_contrib/instrumentation.rb

@@ -0,0 +1,16 @@
+require 'newrelic_rpm'
+module RpmContrib
+  # Contributed instrumentation files for use with newrelic_rpm gem
+  module Instrumentation
+  end
+end
+
+pattern = File.expand_path "../instrumentation/**/*.rb",  __FILE__
+Dir.glob pattern do |file|
+  begin
+    require file.to_s
+  rescue Exception => e
+    NewRelic::Agent.logger.error "Skipping instrumentation file '#{file}': #{e}"
+    NewRelic::Agent.logger.debug e.backtrace.join("\n")
+  end
+end

data/lib/rpm_contrib/instrumentation/active_messaging.rb

@@ -0,0 +1,22 @@
+# ActiveMessaging Instrumentation
+
+DependencyDetection.defer do
+  @name = :active_messaging
+
+  depends_on do
+    defined?(::ActiveMessaging::Processor) && !NewRelic::Control.instance['disable_active_messaging'] &&
+      !NewRelic::Control.instance['disable_active_mq']
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing ActiveMessaging instrumentation'
+  end
+
+  executes do
+    ::ActiveMessaging::Processor.class_eval do
+      include NewRelic::Agent::MethodTracer
+
+      add_method_tracer :on_message, 'ActiveMessaging/OnMessage'
+    end
+  end
+end