newrelic-redis 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b9cfa808b80ff682a14999a13a5c0c9dac3c18
-  data.tar.gz: 6c59cfd9cc77752487d36880c5bc149bef109ca0
+  metadata.gz: 9f694726dbf03d588753badff81b3e75171cc1af
+  data.tar.gz: 9b2ca6a10ee6173dc8408cf559ffaaa1aef88faa
 SHA512:
-  metadata.gz: c922be001df8876065c2b7f59160e8a53bfed58a0aa8fcef4700537208815a49daf0fef6c526aec7e2164f7623253eed0ce472ca66a1a5995fe3caa4d2a23dd4
-  data.tar.gz: 54f332a9d7a0270baa66e608b04b30b2502887462e42afd0c5c0dab0354c7e7d7c5b92663b151f021643f1445778bfdb848fc37efb73984f80f1a0defedc7c75
+  metadata.gz: dcdaca1a1d930db69d67150ce617cf04e0686a9dd8467e323cf7b332b78d2cfe30cd0b7474e1e0a0bbac2af9fc10989c8a90b8bfa0953ad636994c007ca8b11a
+  data.tar.gz: 59bd9e713de9d368495dc6ec86a91cd72521a890f975e14b99b661570bf27765bfee5259347fd4a3076dcaa15d4cdc882ae08fd99fed50bf9aa4a314ee315e74

data/Manifest.txt

@@ -1,7 +1,7 @@
 .autotest
 History.txt
 Manifest.txt
-README.txt
+README.md
 Rakefile
 lib/newrelic-redis.rb
 lib/newrelic_redis/instrumentation.rb

data/{README.txt → README.md}

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

data/Rakefile

@@ -51,7 +51,9 @@ HOE = Hoe.spec 'newrelic-redis' do
   developer 'Evan Phoenix', 'evan@phx.io'
 
   dependency "redis", "< 4.0"
-  dependency "newrelic_rpm", "~> 3.0"
+  dependency "newrelic_rpm", "~> 3.11"
+
+  self.readme_file = "README.md"
 end
 
 file "#{HOE.spec.name}.gemspec" => ['Rakefile'] do |t|

data/lib/newrelic_redis/instrumentation.rb

@@ -14,10 +14,12 @@ DependencyDetection.defer do
   end
 
   executes do
-    NewRelic::Agent.logger.debug 'Installing Redis Instrumentation'
+    NewRelic::Agent.logger.info 'Installing Redis Instrumentation'
   end
 
   executes do
+    require 'new_relic/agent/datastores'
+
     ::Redis::Client.class_eval do
       # Support older versions of Redis::Client that used the method
       # +raw_call_command+.
@@ -25,23 +27,13 @@ DependencyDetection.defer do
       call_method = ::Redis::Client.new.respond_to?(:call) ? :call : :raw_call_command
 
       def call_with_newrelic_trace(*args, &blk)
-        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
-          start = Time.now
+        callback = proc do |result, metric, elapsed|
+          _send_to_new_relic(args, elapsed)
+        end
 
-          begin
-            call_without_newrelic_trace(*args, &blk)
-          ensure
-            _send_to_new_relic(args, start)
-          end
+        NewRelic::Agent::Datastores.wrap("Redis", method_name, nil, callback) do
+          call_without_newrelic_trace(*args, &blk)
         end
       end
 
@@ -53,44 +45,36 @@ DependencyDetection.defer do
       #
       if public_method_defined? :call_pipelined
         def call_pipelined_with_newrelic_trace(commands, *rest)
-          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 = ["Database/Redis/Pipelined", total_metric]
-
-          commands.each do |c|
+          # Report each command as a metric suffixed with _pipelined, so the
+          # user can at least see what all the commands were.
+          additional = commands.map do |c|
             name = c.kind_of?(Array) ? c[0] : c
-            metrics << "Database/Redis/Pipelined/#{name.to_s.upcase}"
+            "Datastore/operation/Redis/#{name.to_s.downcase}_pipelined"
           end
 
-          self.class.trace_execution_scoped(metrics) do
-            start = Time.now
-
-            begin
-              call_pipelined_without_newrelic_trace commands, *rest
-            ensure
-              _send_to_new_relic(commands, start)
+          callback = proc do |result, metric, elapsed|
+            _send_to_new_relic(commands, elapsed)
+            additional.each do |additional_metric|
+              NewRelic::Agent::MethodTracer.trace_execution_scoped(additional_metric) do
+                # No-op, just getting them as placeholders in the trace tree
+              end
             end
           end
+
+          NewRelic::Agent::Datastores.wrap("Redis", "pipelined", nil, callback) do
+            call_pipelined_without_newrelic_trace commands, *rest
+          end
         end
 
         alias_method :call_pipelined_without_newrelic_trace, :call_pipelined
         alias_method :call_pipelined, :call_pipelined_with_newrelic_trace
       end
 
-      def _send_to_new_relic(args, start)
+      def _send_to_new_relic(args, elapsed)
         if NewRelic::Control.instance["transaction_tracer.record_sql"] == "obfuscated"
           args.map! { |arg| [arg.first] + ["?"] * (arg.count - 1) }
         end
-        s = NewRelic::Agent.instance.transaction_sampler
-        s.notice_nosql(args.inspect, (Time.now - start).to_f) rescue nil
+        NewRelic::Agent::Datastores.notice_statement(args.inspect, elapsed)
       end
     end
   end

data/lib/newrelic_redis/version.rb

@@ -1,3 +1,3 @@
 class NewRelicRedis
-  VERSION = '1.5.0'
+  VERSION = '2.0.0'
 end

data/newrelic-redis.gemspec

@@ -1,42 +1,43 @@
 # -*- encoding: utf-8 -*-
+# stub: newrelic-redis 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "newrelic-redis"
-  s.version = "1.3.2"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Evan Phoenix"]
-  s.date = "2012-05-18"
+  s.date = "2015-03-18"
   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", "newrelic-redis.gemspec", "test/test.conf", "test/test_newrelic_redis.rb", ".gemtest"]
+  s.files = [".autotest", ".gemtest", "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.conf", "test/test_newrelic_redis.rb"]
   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.22"
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.md"]
+  s.rubygems_version = "2.2.2"
   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
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<redis>, ["< 4.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"])
+      s.add_runtime_dependency(%q<newrelic_rpm>, ["~> 3.11"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.13"])
     else
       s.add_dependency(%q<redis>, ["< 4.0"])
-      s.add_dependency(%q<newrelic_rpm>, ["~> 3.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.10"])
-      s.add_dependency(%q<hoe>, ["~> 2.16"])
+      s.add_dependency(%q<newrelic_rpm>, ["~> 3.11"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.13"])
     end
   else
     s.add_dependency(%q<redis>, ["< 4.0"])
-    s.add_dependency(%q<newrelic_rpm>, ["~> 3.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.10"])
-    s.add_dependency(%q<hoe>, ["~> 2.16"])
+    s.add_dependency(%q<newrelic_rpm>, ["~> 3.11"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.13"])
   end
 end

data/test/test_newrelic_redis.rb

@@ -1,61 +1,72 @@
 require 'test/unit'
 require 'redis'
 
+require 'newrelic_rpm'
 require 'newrelic_redis/instrumentation'
 
-class TestNewRelicRedis < Test::Unit::TestCase
-  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+DependencyDetection.detect!
+
+NewRelic::Agent.require_test_helper
 
+class TestNewRelicRedis < Test::Unit::TestCase
   PORT = 6381
   OPTIONS = {:port => PORT, :db => 15, :timeout => 0.1}
 
   def setup
-    NewRelic::Agent.manual_start
-    @engine = NewRelic::Agent.instance.stats_engine
-    @engine.clear_stats
-
-    @sampler = NewRelic::Agent.instance.transaction_sampler
-    @sampler.enable
-    @sampler.reset!
-    @sampler.start_builder
+    NewRelic::Agent.drop_buffered_data
 
     @redis = Redis.new OPTIONS
     @client = @redis.client
-
-    DependencyDetection.detect!
   end
 
-  def teardown
-    @sampler.clear_builder
+  def assert_metrics(*m)
+    assert_metrics_recorded(m)
   end
 
-  def assert_metrics(*m)
-    m.each do |x|
-      assert @engine.metrics.include?(x), "#{x} not in metrics"
-    end
+  def assert_segment_has_key(segment_name, expected)
+    sample = NewRelic::Agent.agent.transaction_sampler.tl_builder.sample
+    segment = find_segment_with_name(sample, segment_name)
+    assert_equal expected, segment.params[:statement]
   end
 
   def test_call
-    @redis.hgetall "foo"
-    assert_metrics "Database/Redis/HGETALL", "Database/Redis/allOther"
+    with_config(:'transaction_tracer.record_sql' => 'raw') do
+      in_transaction do
+        @redis.hgetall "foo"
+        assert_segment_has_key "Datastore/operation/Redis/select", "[[:select, 15]]"
+        assert_segment_has_key "Datastore/operation/Redis/hgetall", "[[:hgetall, \"foo\"]]"
+      end
+    end
 
-    prm = @sampler.builder.current_segment.params
-    assert_equal "[[:select, 15]];\n[[:hgetall, \"foo\"]]", prm[:key]
+    assert_metrics "Datastore/all",
+                   "Datastore/allOther",
+                   "Datastore/Redis/all",
+                   "Datastore/Redis/allOther",
+                   "Datastore/operation/Redis/select",
+                   "Datastore/operation/Redis/hgetall"
   end
 
   def test_call_pipelined
-    @redis.pipelined do
-      @redis.hgetall "foo"
-      @redis.incr "bar"
+    with_config(:'transaction_tracer.record_sql' => 'raw') do
+      in_transaction do
+        @redis.pipelined do
+          @redis.hgetall "foo"
+          @redis.incr "bar"
+        end
+
+        assert_segment_has_key "Datastore/operation/Redis/select", "[[:select, 15]]"
+        assert_segment_has_key "Datastore/operation/Redis/pipelined", "[[:hgetall, \"foo\"], [:incr, \"bar\"]]"
+      end
     end
 
-    assert_metrics "Database/Redis/Pipelined",
-                   "Database/Redis/Pipelined/HGETALL",
-                   "Database/Redis/Pipelined/INCR",
-                   "Database/Redis/allOther"
-
-    prm = @sampler.builder.current_segment.params
-    assert_equal "[[:select, 15]];\n[[:hgetall, \"foo\"], [:incr, \"bar\"]]", prm[:key]
+    assert_metrics "Datastore/all",
+                   "Datastore/allOther",
+                   "Datastore/Redis/all",
+                   "Datastore/Redis/allOther",
+                   "Datastore/operation/Redis/select",
+                   "Datastore/operation/Redis/pipelined",
+                   "Datastore/operation/Redis/hgetall_pipelined",
+                   "Datastore/operation/Redis/incr_pipelined"
   end
 
   def test_call_with_block
@@ -73,18 +84,25 @@ class TestNewRelicRedis < Test::Unit::TestCase
   end
 
   def test_obfuscated
-    NewRelic::Control.instance["transaction_tracer.record_sql"] = "obfuscated"
-    @redis.pipelined do
-      @redis.hgetall "foo"
-      @redis.incr "bar"
+    with_config(:'transaction_tracer.record_sql' => 'obfuscated') do
+      in_transaction do
+        @redis.pipelined do
+          @redis.hgetall "foo"
+          @redis.incr "bar"
+        end
+
+        assert_segment_has_key "Datastore/operation/Redis/select", "[[:select, \"?\"]]"
+        assert_segment_has_key "Datastore/operation/Redis/pipelined", "[[:hgetall, \"?\"], [:incr, \"?\"]]"
+      end
     end
 
-    assert_metrics "Database/Redis/Pipelined",
-                   "Database/Redis/Pipelined/HGETALL",
-                   "Database/Redis/Pipelined/INCR",
-                   "Database/Redis/allOther"
-
-    prm = @sampler.builder.current_segment.params
-    assert_equal "[[:select, \"?\"]];\n[[:hgetall, \"?\"], [:incr, \"?\"]]", prm[:key]
+    assert_metrics "Datastore/all",
+                   "Datastore/allOther",
+                   "Datastore/Redis/all",
+                   "Datastore/Redis/allOther",
+                   "Datastore/operation/Redis/select",
+                   "Datastore/operation/Redis/pipelined",
+                   "Datastore/operation/Redis/hgetall_pipelined",
+                   "Datastore/operation/Redis/incr_pipelined"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newrelic-redis
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 description: Redis instrumentation for Newrelic.
 email:
 - evan@phx.io
@@ -74,13 +74,13 @@ extensions: []
 extra_rdoc_files:
 - History.txt
 - Manifest.txt
-- README.txt
+- README.md
 files:
 - ".autotest"
 - ".gemtest"
 - History.txt
 - Manifest.txt
-- README.txt
+- README.md
 - Rakefile
 - lib/newrelic-redis.rb
 - lib/newrelic_redis/instrumentation.rb
@@ -95,7 +95,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.txt
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -114,5 +114,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Redis instrumentation for Newrelic.
-test_files:
-- test/test_newrelic_redis.rb
+test_files: []