rpm_contrib 1.0.7 → 1.0.8

data/CHANGELOG

@@ -1,3 +1,8 @@
+* Version 1.0.8
+
+  Redis instrumentation contributed by Ashley Martens
+  Authlogic moved into RPM Ruby Agent
+
 * Version 1.0.7
 
   Resque instrumentation now supports the resque-multi-job-forks plugin

data/{README.rdoc → README.md}

@@ -1,75 +1,74 @@
-= The RPM Contrib Gem
+# 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.
+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.
+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:
+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:
+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.
+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
+# 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.
+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
+### 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.
 
-=== Paperclip
+### Paperclip
 
 No special configuration required for Paperclip visibility.  You can disable
 it by setting `disable_paperclip` to true in the newrelic.yml file.
 
-=== Authlogic
-
-No special configuration required for Authlogic visibility.  You can disable
-it by setting `disable_authlogic` to true in the newrelic.yml file.
-
-=== MongoDB
+### MongoDB
 
 No special configuration required for MongoDB visibility.  You can disable
 it by setting `disable_mongodb` to true in the newrelic.yml file.
 
-=== Resque
+### Resque
 
 To disable resque, add this to your newrelic.yml:
 
     disable_resque: true
 
+### Redis
+
+Redis instrumentation will record operations as well as `allWeb` and `allOther`
+summary metrics under the `Database/Redis` metric namespace.
+
+To disable Redis instrumentation, add this to your newrelic.yml:
+
+    disable_redis: true
 
-= How to Add Custom Instrumentation
+# 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.
+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.
+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.
+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.
@@ -79,49 +78,53 @@ with this gem.
   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
 
 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
+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)
+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
+## 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).
+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)
+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
+## 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.
+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.
+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
 
 Supporting new frameworks can be pretty involved and generally involves both
 adding custom instrumentation as well as framework and dispatcher detection.
@@ -134,7 +137,7 @@ 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
+# Note on Patches/Pull Requests
  
 * Fork the http://www.github.com/newrelic/rpm_contrib project.
 * Add instrumentation files to `lib/rpm_contrib/instrumentation`.  These
@@ -147,15 +150,15 @@ we'll be happy to help you work through it.
   commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-= Further Information
+# Further Information
 
 Refer to the Agent API Documentation at http://newrelic.github.com/rpm
 
-See the support site faqs at http://support.newrelic.com/faqs for
-additional tips and documentation.
+See the support site faqs at http://support.newrelic.com/faqs for additional
+tips and documentation.
 
 Contact support@newrelic.com for help.
 
-=== Copyright
+### Copyright
 
 Copyright (c) 2009-2010 New Relic. See LICENSE for details.

data/Rakefile

@@ -6,21 +6,31 @@ def version
   @rpm_contrib_version ||= File.read("CHANGELOG")[/Version ([\d\.]+)$/, 1]
 end
 
+RDOC_FILES = FileList['README*','LICENSE','CHANGELOG']
+SUMMARY = "Contributed Instrumentation for New Relic RPM"
+DESCRIPTION = <<-EOF
+Community contributed instrumentation for various frameworks based on
+the New Relic Ruby monitoring gem newrelic_rpm.
+EOF
+
 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.summary = SUMMARY
+    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.11.1'
     gem.version = version
     gem.files = FileList['LICENSE', 'README*', 'lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+    gem.rdoc_options <<
+      "--line-numbers" <<
+      "--inline-source" <<
+      "--title" << SUMMARY <<
+      "-m" << "README.md"
+    gem.extra_rdoc_files = RDOC_FILES
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -55,11 +65,9 @@ require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "rpm_contrib #{version}"
-  rdoc.main = "README.rdoc"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE')
-  rdoc.rdoc_files.include('CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.main = "README.md"
+  rdoc.rdoc_files =  FileList['lib/**/*.rb'] + RDOC_FILES
+  rdoc.inline_source = true
 end
 
 begin

data/lib/new_relic/control/camping.rb

@@ -3,10 +3,12 @@ require 'new_relic/control/ruby'
 # 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'
+class NewRelic::Control #:nodoc:
+  class Camping < NewRelic::Control::Ruby
+    def init_config(options)
+      super
+      @local_env.dispatcher = 'camping'
+      self['app_name'] ||= 'Camping Application'
+    end
   end
 end

data/lib/rpm_contrib/detection/camping.rb

@@ -1,7 +1,8 @@
-# Detect when running under camping and set the framework and dispatcher.
-
-module NewRelic
-  class LocalEnvironment
+module NewRelic #:nodoc:
+  # The class defined in the
+  # newrelic_rpm[http://newrelic.github.com/rpm] which can be ammended
+  # to support new frameworks by defining modules in this namespace.
+  class LocalEnvironment #:nodoc:
     module Camping
       def discover_framework
         if defined?(::Camping)

data/lib/rpm_contrib/instrumentation/redis.rb

@@ -0,0 +1,26 @@
+# Redis instrumentation contributed by Ashley Martens of ngmoco
+#
+
+if defined?(::Redis) and not  NewRelic::Control.instance['disable_redis']
+  
+  ::Redis.class_eval do 
+    
+    include NewRelic::Agent::MethodTracer
+    
+    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_chain :raw_call_command, :newrelic_trace
+    alias raw_call_command_without_newrelic_trace raw_call_command
+    alias raw_call_command raw_call_command_with_newrelic_trace
+    
+  end
+
+end

data/lib/rpm_contrib/instrumentation/resque.rb

@@ -1,11 +1,11 @@
-# == 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
+    # == 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 ResqueInstrumentation
       ::Resque::Job.class_eval do
         include NewRelic::Agent::Instrumentation::ControllerInstrumentation

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 7
-  version: 1.0.7
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - Bill Kayser
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-14 00:00:00 -07:00
+date: 2010-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,28 +31,32 @@ dependencies:
         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"
+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: 
+- CHANGELOG
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - CHANGELOG
 - LICENSE
-- README.rdoc
+- 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/redis.rb
 - lib/rpm_contrib/instrumentation/resque.rb
 - test/helper.rb
 - test/schema.rb
@@ -64,6 +68,12 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
+- --line-numbers
+- --inline-source
+- --title
+- Contributed Instrumentation for New Relic RPM
+- -m
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/rpm_contrib/instrumentation/authlogic.rb

@@ -1,8 +0,0 @@
-if defined? Authlogic::Session::Base && !NewRelic::Control.instance['disable_authlogic']
-  Authlogic::Session::Base.class_eval do
-  #  add_method_tracer :record, 'Authlogic/record'
-    class << self
-      add_method_tracer :find, 'Authlogic/find'
-    end
-  end
-end