newrelic-redis 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-03-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/newrelic-redis.rb
+lib/newrelic_redis/instrumentation.rb
+lib/newrelic_redis/version.rb
+newrelic-redis.gemspec
+test/test_newrelic_redis.rb

data/README.txt

@@ -0,0 +1,58 @@
+= newrelic-redis
+
+* http://github.com/evanphx/newrelic-redis
+
+== DESCRIPTION:
+
+Redis instrumentation for Newrelic.
+
+== FEATURES/PROBLEMS:
+
+* Allows transactions to show time spent inside redis requests
+* Supports normal and pipelined commands
+
+== SYNOPSIS:
+
+  Just add the gem to your project!
+
+== REQUIREMENTS:
+
+* redis-rb
+
+== INSTALL:
+
+* gem install newrelic-redis
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Evan Phoenix
+
+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/Rakefile

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :bundler
+Hoe.plugin :gemspec
+Hoe.plugin :git
+
+HOE = Hoe.spec 'newrelic-redis' do
+  developer 'Evan Phoenix', 'evan@phx.io'
+
+  dependency "redis", "< 3.0"
+  dependency "newrelic_rpm", "~> 3.0"
+end
+
+file "#{HOE.spec.name}.gemspec" => ['Rakefile'] do |t|
+  puts "Generating #{t.name}"
+  File.open(t.name, 'wb') { |f| f.write HOE.spec.to_ruby }
+end
+
+desc "Generate or update the standalone gemspec file for the project"
+task :gemspec => ["#{HOE.spec.name}.gemspec"]
+
+# vim: syntax=ruby

data/lib/newrelic-redis.rb

@@ -0,0 +1 @@
+require 'newrelic_redis/instrumentation'

data/lib/newrelic_redis/instrumentation.rb

@@ -0,0 +1,72 @@
+require 'new_relic/agent/method_tracer'
+require 'redis'
+
+# Redis instrumentation.
+#  Originally contributed by Ashley Martens of ngmoco
+#  Rewritten, reorganized, and repackaged by Evan Phoenix
+
+# defined?(::Redis) && !NewRelic::Control.instance['disable_redis']
+
+NewRelic::Agent.logger.debug 'Installing Redis instrumentation'
+
+::Redis::Client.class_eval do
+
+  include NewRelic::Agent::MethodTracer
+
+  # Support older versions of Redis::Client that used the method
+  # +raw_call_command+.
+
+  call_method = 
+    ::Redis::Client.new.respond_to?(:call) ? :call : :raw_call_command
+
+    def call_with_newrelic_trace(*args)
+      if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+        total_metric = 'Database/Redis/allWeb'
+      else
+        total_metric = 'Database/Redis/allOther'
+      end
+
+      method_name = args[0].is_a?(Array) ? args[0][0] : args[0]
+      metrics = ["Database/Redis/#{method_name.to_s.upcase}", total_metric]
+
+      self.class.trace_execution_scoped(metrics) do
+        call_without_newrelic_trace(*args)
+      end
+    end
+
+  alias_method :call_without_newrelic_trace, call_method
+  alias_method call_method, :call_with_newrelic_trace
+
+  # Older versions of Redis handle pipelining completely differently.
+  # Don't bother supporting them for now.
+  #
+  if public_method_defined? :call_pipelined
+    def call_pipelined_with_newrelic_trace(commands, options={})
+      if NewRelic::Agent::Instrumentation::MetricFrame.recording_web_transaction?
+        total_metric = 'Database/Redis/allWeb'
+      else
+        total_metric = 'Database/Redis/allOther'
+      end
+
+      # Report each command as a metric under pipelined, so the user
+      # can at least see what all the commands were. This prevents
+      # metric namespace explosion.
+
+      metrics = [total_metric, "Database/Redis/Pipelined"]
+
+      commands.each do |c|
+        name = c.kind_of?(Array) ? c[0] : c
+        metrics << "Database/Redis/Pipelined/#{name.to_s.upcase}"
+      end
+
+      self.class.trace_execution_scoped(metrics) do
+        call_pipelined_without_newrelic_trace commands, options
+      end
+    end
+
+
+    alias_method :call_pipelined_without_newrelic_trace, :call_pipelined
+    alias_method :call_pipelined, :call_pipelined_with_newrelic_trace
+  end
+end
+

data/lib/newrelic_redis/version.rb

@@ -0,0 +1,3 @@
+class NewRelicRedis
+  VERSION = '1.0.0'
+end

data/newrelic-redis.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "newrelic-redis"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Evan Phoenix"]
+  s.date = "2012-03-09"
+  s.description = "Redis instrumentation for Newrelic."
+  s.email = ["evan@phx.io"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = [".autotest", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/newrelic_redis.rb", "lib/newrelic_redis/instrumentation.rb", "lib/newrelic_redis/version.rb", "test/test_newrelic_redis.rb", ".gemtest"]
+  s.homepage = "http://github.com/evanphx/newrelic-redis"
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "newrelic-redis"
+  s.rubygems_version = "1.8.17"
+  s.summary = "Redis instrumentation for Newrelic."
+  s.test_files = ["test/test_newrelic_redis.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, ["< 3.0"])
+      s.add_runtime_dependency(%q<newrelic_rpm>, ["~> 3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.10"])
+      s.add_development_dependency(%q<hoe>, ["~> 2.16"])
+    else
+      s.add_dependency(%q<redis>, ["< 3.0"])
+      s.add_dependency(%q<newrelic_rpm>, ["~> 3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.10"])
+      s.add_dependency(%q<hoe>, ["~> 2.16"])
+    end
+  else
+    s.add_dependency(%q<redis>, ["< 3.0"])
+    s.add_dependency(%q<newrelic_rpm>, ["~> 3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.10"])
+    s.add_dependency(%q<hoe>, ["~> 2.16"])
+  end
+end

data/test/test_newrelic_redis.rb

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'redis'
+
+require 'newrelic_redis/instrumentation'
+
+class TestNewRelicRedis < Test::Unit::TestCase
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+  module StubProcess
+    def establish_connection
+    end
+
+    def read(*args)
+    end
+
+    def process(*args)
+      @process_args = args
+    end
+
+    attr_reader :process_args
+
+  end
+
+  def setup
+    NewRelic::Agent.manual_start
+    @engine = NewRelic::Agent.instance.stats_engine
+    @engine.clear_stats
+
+    @redis = Redis.new :path => "/tmp/redis"
+    @client = @redis.client
+    class << @client
+      include StubProcess
+    end
+  end
+
+  def assert_metrics(*m)
+    assert_equal m.sort, @engine.metrics.sort
+  end
+
+  def test_call
+    @redis.hgetall "foo"
+    assert_equal [[[:hgetall, "foo"]]], @client.process_args
+    assert_metrics "Database/Redis/HGETALL", "Database/Redis/allOther"
+  end
+
+  def test_call_pipelined
+    @redis.pipelined do
+      @redis.hgetall "foo"
+      @redis.inc "bar"
+    end
+
+    assert_equal [[[:hgetall, "foo"], [:inc, "bar"]]], @client.process_args
+    assert_metrics "Database/Redis/Pipelined/HGETALL",
+                   "Database/Redis/Pipelined/INC",
+                   "Database/Redis/Pipelined",
+                   "Database/Redis/allOther"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: newrelic-redis
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Evan Phoenix
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: newrelic_rpm
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 16
+        version: "2.16"
+  type: :development
+  version_requirements: *id004
+description: Redis instrumentation for Newrelic.
+email: 
+- evan@phx.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/newrelic-redis.rb
+- lib/newrelic_redis/instrumentation.rb
+- lib/newrelic_redis/version.rb
+- newrelic-redis.gemspec
+- test/test_newrelic_redis.rb
+- .gemtest
+homepage: http://github.com/evanphx/newrelic-redis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: newrelic-redis
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Redis instrumentation for Newrelic.
+test_files: 
+- test/test_newrelic_redis.rb