rpm_contrib 2.1.7 → 2.1.8

data/CHANGELOG

@@ -1,12 +1,17 @@
+* Version 2.1.8
+  - Removed redis instrumenation in favor of https://github.com/evanphx/newrelic-redis
+  - [FIX] adding check for aws-sdk (Tom Caspy)
+  - Improved Mongo instrumenation from pull request #16 titanous/mongoid-instrumentation
+
 * Version 2.1.7
 
-Community contributed instrumentation
-- ThinkingSphinx instrumentation improvement (Martin Sarsale)
-- Picky search engine instrumentation (Niko Dittmann)
-Community Contributed Bug Fixes
-- Fix instrumentation injection for ActiveMessaging (W. Andrew Loe III)
-Other
-- Improvements to resque instrumentation detection of if its in a forking ruby implementation
+  Community contributed instrumentation
+  - ThinkingSphinx instrumentation improvement (Martin Sarsale)
+  - Picky search engine instrumentation (Niko Dittmann)
+  Community Contributed Bug Fixes
+  - Fix instrumentation injection for ActiveMessaging (W. Andrew Loe III)
+  Other
+  - Improvements to resque instrumentation detection of if its in a forking ruby implementation
 
 * Version 2.1.6
 

data/README.md

@@ -3,6 +3,29 @@
 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.
 
+## Deprecation of RPM Contrib
+
+Over the next several months we are planning to phase out the rpm_contrib gem.
+We plan to migrate the existing instrumentation into separate projects that
+instrument indivdual libraries or frameworks.  We see this as having a number of
+advantages for newrelic users.  We will provide a list of recommended
+instrumentation projects.
+
+### Removal of Redis Instrumenation
+
+As of version 2.1.8 Redis instrumentation has been removed from rpm_contrib.
+Please use Evan Phoenix's `newrelic-redis` gem instead.
+https://github.com/evanphx/newrelic-redis
+
+###  Request for Maintainers
+
+If you're interested in maintaining instrumentation for a specific
+library/framework, please let us know.  We'd love to work with you and promote
+your project.  -The New Relic Ruby Agent Team
+
+
+## Getting Started
+
 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.
@@ -23,9 +46,6 @@ require the rpm_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`. 
-
 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:
@@ -43,6 +63,7 @@ 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
@@ -122,11 +143,10 @@ 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. 
+Redis instrumentation has been removed from rpm_contrib.
 
-To disable Redis instrumentation, set 'disable_redis' to true in your newrelic.yml file.
+Please use Evan Phoenix's `newrelic-redis` gem instead.
+https://github.com/evanphx/newrelic-redis
 
 ### Riak
 

data/lib/rpm_contrib/instrumentation/aws.rb

@@ -13,8 +13,14 @@ DependencyDetection.defer do
   
   executes do
     # Instrument connections to the AWS-S3 service
-    ::AWS::S3::Connection::Management::ClassMethods.module_eval do
-      add_method_tracer :establish_connection!, 'AWS-S3/establish_connection!'
+    if defined?(::AWS::S3::Connection)
+      ::AWS::S3::Connection::Management::ClassMethods.module_eval do
+        add_method_tracer :establish_connection!, 'AWS-S3/establish_connection!'
+      end
+    else #using aws-sdk
+      ::AWS::S3.class_eval do
+        add_method_tracer :initialize, 'AWS-S3/establish_connection!'
+      end
     end
 
     # Instrument methods on Bucket

data/lib/rpm_contrib/instrumentation/mongo.rb

@@ -11,7 +11,7 @@ DependencyDetection.defer do
   end  
 
   executes do
-    ::Mongo::Connection.class_eval do
+    ::Mongo::Logging.class_eval do
       include NewRelic::Agent::MethodTracer
 
       def instrument_with_newrelic_trace(name, payload = {}, &blk)
@@ -32,17 +32,21 @@ DependencyDetection.defer do
       alias_method :instrument_without_newrelic_trace, :instrument
       alias_method :instrument, :instrument_with_newrelic_trace
     end
+    class Mongo::Collection; include Mongo::Logging; end
+    class Mongo::Connection; include Mongo::Logging; end
+    class Mongo::Cursor; include Mongo::Logging; end
 
+    # cursor refresh is not currently instrumented in mongo driver, so not picked up by above - have to add our own here
     ::Mongo::Cursor.class_eval do
       include NewRelic::Agent::MethodTracer
 
-      def refresh_with_newrelic_trace
+      def send_get_more_with_newrelic_trace
         trace_execution_scoped("Database/#{collection.name}/refresh") do
-          refresh_without_newrelic_trace
+          send_get_more_without_newrelic_trace
         end
       end
-      alias_method :refresh_without_newrelic_trace, :refresh
-      alias_method :refresh, :refresh_with_newrelic_trace
+      alias_method :send_get_more_without_newrelic_trace, :send_get_more
+      alias_method :send_get_more, :send_get_more_with_newrelic_trace
       add_method_tracer :close, 'Database/#{collection.name}/close'
     end
   end

data/lib/rpm_contrib/instrumentation/mongoid.rb

@@ -0,0 +1,21 @@
+DependencyDetection.defer do
+  @name = :mongoid
+
+  depends_on do
+    defined?(::Mongoid) and not NewRelic::Control.instance['disable_mongoid']
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Mongoid instrumentation'
+  end
+
+  executes do
+    Mongoid::Collection.class_eval do
+      include NewRelic::Agent::MethodTracer
+
+      (Mongoid::Collections::Operations::ALL - [:<<, :[]]).each do |method|
+        add_method_tracer method, "ActiveRecord/\#{@klass}/#{method}"
+      end
+    end
+  end
+end

metadata

@@ -1,69 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rpm_contrib
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 2.1.8
   prerelease: 
-  segments: 
-  - 2
-  - 1
-  - 7
-  version: 2.1.7
 platform: ruby
-authors: 
+authors:
 - Bill Kayser
 - Jon Guymon
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: &70251204964480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 1
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.1.1
-  name: newrelic_rpm
-  prerelease: false
   type: :runtime
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *70251204964480
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: &70251204963860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 1
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.1.1
-  name: newrelic_rpm
-  prerelease: false
   type: :runtime
-  requirement: *id002
-description: |
-  Community contributed instrumentation for various frameworks based on
+  prerelease: false
+  version_requirements: *70251204963860
+description: ! 'Community contributed instrumentation for various frameworks based
+  on
+
   the New Relic Ruby monitoring gem newrelic_rpm.
 
+'
 email: support@newrelic.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGELOG
 - LICENSE
 - README.md
-files: 
+files:
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -84,9 +68,9 @@ files:
 - lib/rpm_contrib/instrumentation/elastic_search.rb
 - lib/rpm_contrib/instrumentation/kyototycoon.rb
 - lib/rpm_contrib/instrumentation/mongo.rb
+- lib/rpm_contrib/instrumentation/mongoid.rb
 - lib/rpm_contrib/instrumentation/paperclip.rb
 - lib/rpm_contrib/instrumentation/picky.rb
-- lib/rpm_contrib/instrumentation/redis.rb
 - lib/rpm_contrib/instrumentation/resque.rb
 - lib/rpm_contrib/instrumentation/riak_client.rb
 - lib/rpm_contrib/instrumentation/ripple.rb
@@ -102,46 +86,39 @@ files:
 - test/schema.rb
 - test/test_curb.rb
 - test/test_picky.rb
-- test/test_redis.rb
 - test/test_resque.rb
 - test/test_workling.rb
 homepage: http://github.com/newrelic/rpm_contrib
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Contributed Instrumentation for New Relic RPM
 - -m
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1487779751657344136
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Contributed Instrumentation for New Relic RPM
 test_files: []
-

data/lib/rpm_contrib/instrumentation/redis.rb

@@ -1,42 +0,0 @@
-# Redis instrumentation contributed by Ashley Martens of ngmoco
-#
-DependencyDetection.defer do
-  @name = :redis
-
-  depends_on do
-    defined?(::Redis) && !NewRelic::Control.instance['disable_redis']
-  end
-
-  executes do
-    NewRelic::Agent.logger.debug 'Installing Redis instrumentation'
-  end
-
-  executes do
-    ::Redis::Client.class_eval do
-
-      include NewRelic::Agent::MethodTracer
-
-      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}",
-                   (NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction? ? 'Database/Redis/allWeb' : 'Database/Redis/allOther')]
-        self.class.trace_execution_scoped(metrics) do
-          # NewRelic::Control.instance.log.debug("Instrumenting Redis Call[#{method_name}]: #{args[0].inspect}")
-          raw_call_command_without_newrelic_trace(*args)
-        end
-      end
-
-      alias_method :raw_call_command_without_newrelic_trace, redis_call_method
-      alias_method redis_call_method, :raw_call_command_with_newrelic_trace
-
-    end
-  end
-end
-
-
-

data/test/test_redis.rb

@@ -1,34 +0,0 @@
-require "#{File.dirname(__FILE__)}/helper"
-begin
-  require 'redis'
-  require 'ruby-debug'
-rescue LoadError
-end
-
-require "#{File.dirname(__FILE__)}/../lib/rpm_contrib/instrumentation/redis"
-
-if defined?(::Redis)
-
-
-  class RedisTest < Test::Unit::TestCase
-
-    # Called before every test method runs. Can be used
-    # to set up fixture information.
-    def setup
-      # Do nothing
-    end
-
-    # Called after every test method runs. Can be used to tear
-    # down fixture information.
-
-    def teardown
-      # Do nothing
-    end
-
-    # Fake test
-    def test_fail
-
-
-    end
-  end
-end