rpm_contrib 2.0.1 → 2.1.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+* 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

data/README.md

@@ -48,6 +48,13 @@ Both MongoMapper and Mongoid are supported.  You can disable them both by settin
 
 ### Resque
 
+Make sure that your jobs either inherit from Resque::Job or else include our instrumentation:
+
+class MyJob
+  require 'rpm_contrib/instrumentation/resque'
+  include Resque::Plugins::NewRelicInstrumentation
+end
+
 To disable resque, set 'disable_resque' to true in your newrelic.yml file.
 
 ### Redis

data/lib/rpm_contrib/instrumentation/active_mq.rb

@@ -0,0 +1,17 @@
+# == ActiveMQ Instrumentation ==
+# Robert R. Meyer
+# Blue-Dog-Archolite @ GitHub
+
+module RpmContrib
+  module Instrumentation
+    module ActiveMessaging
+      if defined?(::ActiveMessaging::Processor) and not NewRelic::Control.instance['disable_active_mq']
+        ::ActiveMessaging::Processor.class_eval do
+          class << self
+            add_method_tracer :on_message, 'ActiveMessaging/OnMessage'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/camping.rb

@@ -32,22 +32,22 @@ module RPMContrib
     #	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 
+        # 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/cassandra.rb

@@ -5,7 +5,7 @@ module RpmContrib
       #
 
       if defined?(::Cassandra) and not  NewRelic::Control.instance['disable_cassandra_instrumentation']
-        
+
         ::Cassandra.class_eval do
           add_method_tracer :insert,               'Database/Cassandra/insert'
           add_method_tracer :remove,               'Database/Cassandra/remove'

data/lib/rpm_contrib/instrumentation/crack.rb

@@ -0,0 +1,26 @@
+module RpmContrib
+  module Instrumentation
+    module Crack
+
+      if defined?(::Crack) && !NewRelic::Control.instance['disable_crack']
+        if defined?(::Crack::JSON)
+          ::Crack::JSON.class_eval do
+            class << self
+              include NewRelic::Agent::MethodTracer
+              add_method_tracer :parse, 'Parser/#{self.name}/parse'
+            end
+          end
+        end
+
+        if defined?(::Crack::XML)
+          ::Crack::XML.class_eval do
+            class << self
+              include NewRelic::Agent::MethodTracer
+              add_method_tracer :parse, 'Parser/#{self.name}/parse'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/curb.rb

@@ -0,0 +1,45 @@
+module RpmContrib
+  module Instrumentation
+    module Curl
+      if defined?(::Curl) and not NewRelic::Control.instance['disable_curb']
+        ::Curl::Easy.class_eval do
+          def host
+            URI.parse(self.url).host
+          end
+
+          # TODO: http, http_delete, http_get, http_post, http_head, http_put
+          def perform_with_newrelic_trace(*args, &block)
+            metrics = ["External/#{host}/Curl::Easy","External/#{host}/all"]
+            if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+              metrics << "External/allWeb"
+            else
+              metrics << "External/allOther"
+            end
+            self.class.trace_execution_scoped metrics do
+              perform_without_newrelic_trace(*args, &block)
+            end
+          end
+          alias perform_without_newrelic_trace perform
+          alias perform perform_with_newrelic_trace
+        end
+
+        ::Curl::Multi.class_eval do
+          # TODO: http
+          def perform_with_newrelic_trace(*args, &block)
+            metrics = ["External/Curl::Multi"]
+            if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+              metrics << "External/allWeb"
+            else
+              metrics << "External/allOther"
+            end
+            self.class.trace_execution_scoped metrics do
+              perform_without_newrelic_trace(*args, &block)
+            end
+          end
+          alias perform_without_newrelic_trace perform
+          alias perform perform_with_newrelic_trace
+        end
+      end
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/elastic_search.rb

@@ -0,0 +1,24 @@
+# == Elastic Search Instrumentation
+#
+
+module RpmContrib
+  module Instrumentation
+    module ElasticSearch
+
+      if defined?(::ElasticSearch) and not  NewRelic::Control.instance['disable_elastic_search_instrumentation']
+
+        ::ElasticSearch::Client.class_eval do
+          add_method_tracer :index,  'ActiveRecord/ElasticSearch/index'
+          add_method_tracer :get,    'ActiveRecord/ElasticSearch/get'
+          add_method_tracer :delete, 'ActiveRecord/ElasticSearch/delete'
+          add_method_tracer :search, 'ActiveRecord/ElasticSearch/search'
+          add_method_tracer :scroll, 'ActiveRecord/ElasticSearch/scroll'
+          add_method_tracer :count,  'ActiveRecord/ElasticSearch/count'
+          add_method_tracer :bulk,   'ActiveRecord/ElasticSearch/bulk'
+        end
+
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation/mongo.rb

@@ -0,0 +1,32 @@
+module RpmContrib
+  module Instrumentation
+    module Mongo
+      # Mongo Instrumentation contributed by Alexey Palazhchenko
+
+      if defined?(::Mongo) and not NewRelic::Control.instance['disable_mongodb']
+        ::Mongo::Connection.class_eval do
+          include NewRelic::Agent::MethodTracer
+
+          def instrument_with_newrelic_trace(name, payload = {}, &blk)
+            collection = payload[:collection]
+            if collection == '$cmd'
+              f = payload[:selector].first
+              name, collection = f if f
+            end
+
+            trace_execution_scoped("Database/#{collection}/#{name}") do
+              t0 = Time.now
+              res = instrument_without_newrelic_trace(name, payload, &blk)
+              NewRelic::Agent.instance.transaction_sampler.notice_sql(payload.inspect, nil, (Time.now - t0).to_f)
+              res
+            end
+          end
+
+          alias_method :instrument_without_newrelic_trace, :instrument
+          alias_method :instrument, :instrument_with_newrelic_trace
+        end
+      end
+
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/paperclip.rb

@@ -2,27 +2,27 @@ module RpmContrib
   module Instrumentation
     module Paperclip
       # Paperclip Instrumentation.
-      
+
       if defined?(::Paperclip) && !NewRelic::Control.instance['disable_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'                            
+          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'                            
+          add_method_tracer :flush_deletes, 'Paperclip/Storage/flush_deletes'
+          add_method_tracer :flush_writes, 'Paperclip/Storage/flush_writes'
         end
-        
+
       end
-      
+
     end
   end
 end

data/lib/rpm_contrib/instrumentation/redis.rb

@@ -8,14 +8,14 @@ module RpmContrib
 
 
         ::Redis::Client.class_eval do
-          
+
           include NewRelic::Agent::MethodTracer
 
-          def self.redis_call_method                                                          
+          def self.redis_call_method
             ::Redis::Client.new.respond_to?(:call) ? :call : :raw_call_command
           end
 
-          
+
           def raw_call_command_with_newrelic_trace *args
             method_name = args[0].is_a?(Array) ? args[0][0] : args[0]
             metrics = ["Database/Redis/#{method_name}",
@@ -28,7 +28,7 @@ module RpmContrib
 
           alias_method :raw_call_command_without_newrelic_trace, redis_call_method
           alias_method redis_call_method, :raw_call_command_with_newrelic_trace
-          
+
         end
 
 

data/lib/rpm_contrib/instrumentation/resque.rb

@@ -1,32 +1,32 @@
+module Resque
+  module Plugins
+    module NewRelicInstrumentation
+      include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+      def around_perform_with_monitoring(*args)
+        perform_action_with_newrelic_trace(:name => 'perform', :class_name => class_name, :category => 'OtherTransaction/ResqueJob') do
+          yield(*args)
+        end
+      end
+    end
+  end
+end
 
 module RPMContrib
   module Instrumentation
-    module ResqueInstrumentation
-      Resque.before_first_fork do
+    module Resque
+      ::Resque.before_first_fork do
         NewRelic::Agent.manual_start(:dispatcher => :resque)
       end
 
-      Resque.after_fork do
+      ::Resque.after_fork do
         NewRelic::Agent.after_fork(:force_reconnect => false)
       end
 
-      Resque.before_child_exit do
-        NewRelic::Agent.shutdown
+      ::Resque::Job.class_eval do
+        include Resque::Plugins::NewRelicInstrumentation
       end
     end
   end
 end if defined?(::Resque) and not NewRelic::Control.instance['disable_resque']
 
-module Resque
-  module Plugins
-    module NewRelicInstrumentation
-      include NewRelic::Agent::Instrumentation::ControllerInstrumentation
-
-      def around_perform_with_monitoring(*args)
-        perform_action_with_newrelic_trace(:name => 'perform', :class_name => class_name, :category => 'OtherTransaction/ResqueJob') do
-          yield(*args)
-        end
-      end
-    end
-  end
-end

data/lib/rpm_contrib/instrumentation/sinatra.rb

@@ -0,0 +1,27 @@
+module RpmContrib
+  module Instrumentation
+    module Sinatra
+      if defined?(::Sinatra::Base) and not NewRelic::Control.instance['disable_sinatra_template']
+        module ::Sinatra
+          Base.class_eval do
+            def render_with_newrelic_trace(*args, &block)
+              engine, file = *args
+              return render_without_newrelic_trace(*args, &block) if file == "= yield"
+
+              file = "Proc" if file.is_a?(Proc)
+              metrics = ["Sinatra/#{engine}/#{file}"]
+
+              self.class.trace_execution_scoped metrics do
+                render_without_newrelic_trace(*args, &block)
+              end
+            end
+
+            alias render_without_newrelic_trace render
+            alias render render_with_newrelic_trace
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation/typhoeus.rb

@@ -0,0 +1,28 @@
+module RpmContrib
+  module Instrumentation
+    module Typhoeus
+      if defined?(::Typhoeus)
+        require 'uri'
+        module ::Typhoeus
+          Request.instance_eval do
+            def get_with_newrelic_trace(*args, &block)
+              uri = URI.parse(args.first)
+              metrics = ["External/#{uri.host}/Typhoeus/GET","External/#{uri.host}/all"]
+              if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+                metrics << "External/allWeb"
+              else
+                metrics << "External/allOther"
+              end
+              self.class.trace_execution_scoped metrics do
+                get_without_newrelic_trace(*args, &block)
+              end
+            end
+            alias get_without_newrelic_trace get
+            alias get get_with_newrelic_trace
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation/ultrasphinx.rb

@@ -0,0 +1,18 @@
+require 'new_relic/agent/method_tracer'
+
+module RpmContrib
+  module Instrumentation
+    module UltraSphinx
+      if defined?(::UltraSphinx)
+        module ::Ultrasphinx
+          class Search
+            include NewRelic::Agent::MethodTracer
+
+            add_method_tracer :run
+            add_method_tracer :results
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpm_contrib/instrumentation/workling.rb

@@ -0,0 +1,21 @@
+# Workling instrumentation contributed by Chad Ingram of Aurora Feint
+#
+module RpmContrib
+  module Instrumentation
+    module Workling
+      if defined?(::Workling) and not ::NewRelic::Control.instance['disable_workling']
+        ::Workling::Base.class_eval do
+          include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+        end
+
+        ::Workling::Discovery.discovered.each do |clazz|
+          (clazz.public_instance_methods - ::Workling::Base.public_instance_methods).each do |method|
+            puts "added method tracer Workling/#{clazz.name}/#{method}"
+            clazz.send(:add_method_tracer, method, "Workling/#{clazz.name}/#{method}", :category => :task)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation/yajl.rb

@@ -0,0 +1,15 @@
+module RpmContrib
+  module Instrumentation
+    module Yajl
+      if defined?(::Yajl::Encoder) and not  ::NewRelic::Control.instance['disable_yajl_instrumentation']
+        ::Yajl::Encoder.class_eval do
+          class << self
+            include ::NewRelic::Agent::MethodTracer
+            add_method_tracer :parse, 'Encoder/Yajl/encode'
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rpm_contrib/instrumentation.rb

@@ -1,9 +1,20 @@
-require 'rpm_contrib/instrumentation/cassandra'
+require 'rpm_contrib/instrumentation/active_mq'
+require 'rpm_contrib/instrumentation/aws'
 require 'rpm_contrib/instrumentation/camping'
+require 'rpm_contrib/instrumentation/cassandra'
+require 'rpm_contrib/instrumentation/crack'
+require 'rpm_contrib/instrumentation/curb'
+require 'rpm_contrib/instrumentation/elastic_search'
+require 'rpm_contrib/instrumentation/mongo'
 require 'rpm_contrib/instrumentation/paperclip'
 require 'rpm_contrib/instrumentation/redis'
 require 'rpm_contrib/instrumentation/resque'
-require 'rpm_contrib/instrumentation/aws'
+require 'rpm_contrib/instrumentation/sinatra'
+require 'rpm_contrib/instrumentation/typhoeus'
+require 'rpm_contrib/instrumentation/ultrasphinx'
+require 'rpm_contrib/instrumentation/workling'
+require 'rpm_contrib/instrumentation/yajl'
+
 
 module RpmContrib
   module Instrumentation

data/test/schema.rb

@@ -4,7 +4,7 @@
 begin
   require 'sqlite3'
   require 'active_record'
-  
+
   ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
   ActiveRecord::Migration.verbose = false
 

data/test/test_curb.rb

@@ -0,0 +1,66 @@
+require "#{File.dirname(__FILE__)}/helper"
+require 'curb'
+
+class NewRelic::Agent::NetInstrumentationTest < Test::Unit::TestCase
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+  def setup
+    NewRelic::Agent.manual_start
+    @engine = NewRelic::Agent.instance.stats_engine
+    @engine.clear_stats
+  end
+  def test_get
+    curl = Curl::Easy.new('http://www.google.com/index.html')
+    curl.perform
+    assert_match /<head>/, curl.body_str
+    assert_equal %w[External/www.google.com/Curl::Easy External/Curl::Multi
+                    External/allOther External/www.google.com/all].sort,
+       @engine.metrics.sort
+  end
+
+  def test_multi
+    multi = Curl::Multi.new
+    curl1 = Curl::Easy.new('http://www.google.com/index.html')
+    multi.add curl1
+    curl2 = Curl::Easy.new('http://www.yahoo.com/')
+    multi.add curl2
+    multi.perform
+    assert_match /<head>/, curl1.body_str
+    assert_match /<head>/, curl2.body_str
+    assert_equal %w[External/Curl::Multi External/allOther].sort,
+       @engine.metrics.sort
+  end
+
+  def test_background
+    perform_action_with_newrelic_trace("task", :category => :task) do
+      curl = Curl::Easy.new('http://www.google.com/index.html')
+      curl.perform
+      assert_match /<head>/, curl.body_str
+    end
+    assert_equal %w[External/Curl::Multi
+          External/Curl::Multi:OtherTransaction/Background/NewRelic::Agent::NetInstrumentationTest/task
+          External/www.google.com/Curl::Easy External/allOther External/www.google.com/all
+          External/www.google.com/Curl::Easy:OtherTransaction/Background/NewRelic::Agent::NetInstrumentationTest/task].sort,
+       @engine.metrics.select{|m| m =~ /^External/}.sort
+  end
+
+  def test_transactional
+    perform_action_with_newrelic_trace("task") do
+      curl = Curl::Easy.new('http://www.google.com/index.html')
+      curl.perform
+      assert_match /<head>/, curl.body_str
+    end
+    assert_equal %w[External/Curl::Multi
+          External/Curl::Multi:Controller/NewRelic::Agent::NetInstrumentationTest/task
+          External/www.google.com/Curl::Easy External/allWeb External/www.google.com/all
+          External/www.google.com/Curl::Easy:Controller/NewRelic::Agent::NetInstrumentationTest/task].sort,
+       @engine.metrics.select{|m| m =~ /^External/}.sort
+  end
+  def test_ignore
+    NewRelic::Agent.disable_all_tracing do
+      curl = Curl::Easy.new('http://www.google.com/index.html')
+      curl.http_post('data')
+    end
+    assert_equal 0, @engine.metrics.size
+  end
+
+end

data/test/test_redis.rb

@@ -8,7 +8,7 @@ end
 require "#{File.dirname(__FILE__)}/../lib/rpm_contrib/instrumentation/redis"
 
 if defined?(::Redis)
-  
+
 
   class RedisTest < Test::Unit::TestCase
 
@@ -27,7 +27,7 @@ if defined?(::Redis)
 
     # Fake test
     def test_fail
-      
+
 
     end
   end

data/test/{test_mongoid.rb → test_workling.rb}

@@ -1,24 +1,16 @@
 require "#{File.dirname(__FILE__)}/helper"
 begin
-  require 'mongoid'
+  require 'redis'
+  require 'ruby-debug'
 rescue LoadError
 end
 
-require "#{File.dirname(__FILE__)}/../lib/rpm_contrib/instrumentation/mongoid"
+require "#{File.dirname(__FILE__)}/../lib/rpm_contrib/instrumentation/workling"
 
-if defined?(::Mongoid)
-  
-  Mongoid.configure do |config|
-    config.master = Mongo::Connection.new.db('animals')
-  end
-
-  class Dog
-    include Mongoid::Document
+if defined?(::Workling)
 
-    field :name
-  end
 
-  class MongoidTest < Test::Unit::TestCase
+  class WorklingTest < Test::Unit::TestCase
 
     # Called before every test method runs. Can be used
     # to set up fixture information.
@@ -35,7 +27,7 @@ if defined?(::Mongoid)
 
     # Fake test
     def test_fail
-      Dog.create!(:name=>'rover')
+
 
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rpm_contrib
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 2
-  - 0
   - 1
-  version: 2.0.1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Bill Kayser
@@ -58,17 +58,28 @@ files:
 - lib/rpm_contrib/detection/camping.rb
 - lib/rpm_contrib/detection/resque.rb
 - lib/rpm_contrib/instrumentation.rb
+- lib/rpm_contrib/instrumentation/active_mq.rb
 - lib/rpm_contrib/instrumentation/aws.rb
 - lib/rpm_contrib/instrumentation/aws/s3.rb
 - lib/rpm_contrib/instrumentation/camping.rb
 - lib/rpm_contrib/instrumentation/cassandra.rb
+- lib/rpm_contrib/instrumentation/crack.rb
+- lib/rpm_contrib/instrumentation/curb.rb
+- lib/rpm_contrib/instrumentation/elastic_search.rb
+- lib/rpm_contrib/instrumentation/mongo.rb
 - lib/rpm_contrib/instrumentation/paperclip.rb
 - lib/rpm_contrib/instrumentation/redis.rb
 - lib/rpm_contrib/instrumentation/resque.rb
+- lib/rpm_contrib/instrumentation/sinatra.rb
+- lib/rpm_contrib/instrumentation/typhoeus.rb
+- lib/rpm_contrib/instrumentation/ultrasphinx.rb
+- lib/rpm_contrib/instrumentation/workling.rb
+- lib/rpm_contrib/instrumentation/yajl.rb
 - test/helper.rb
 - test/schema.rb
-- test/test_mongoid.rb
+- test/test_curb.rb
 - test/test_redis.rb
+- test/test_workling.rb
 has_rdoc: true
 homepage: http://github.com/newrelic/rpm_contrib
 licenses: []
@@ -112,5 +123,6 @@ summary: Contributed Instrumentation for New Relic RPM
 test_files: 
 - test/helper.rb
 - test/schema.rb
-- test/test_mongoid.rb
+- test/test_curb.rb
 - test/test_redis.rb
+- test/test_workling.rb