appoptics_apm 4.0.2

data/test/instrumentation/memcache_test.rb

@@ -0,0 +1,260 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+# Since memcache is loaded late, the instrumentation
+# loaded out of order.  Here we force inject instrumentation
+require 'memcache'
+::MemCache.class_eval do
+  include AppOpticsAPM::Inst::MemCache
+end
+
+describe "Memcache" do
+  before do
+    clear_all_traces
+    @mc = ::MemCache.new('127.0.0.1')
+
+    # These are standard entry/exit KVs that are passed up with all mongo operations
+    @entry_kvs = {
+      'Layer' => 'memcache',
+      'Label' => 'entry' }
+
+    @info_kvs = {
+      'Layer' => 'memcache',
+      'Label' => 'info' }
+
+    @exit_kvs = { 'Layer' => 'memcache', 'Label' => 'exit' }
+    @collect_backtraces = AppOpticsAPM::Config[:memcache][:collect_backtraces]
+  end
+
+  after do
+    AppOpticsAPM::Config[:memcache][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Stock MemCache should be loaded, defined and ready' do
+    defined?(::MemCache).wont_match nil
+  end
+
+  it 'MemCache should have appoptics_apm methods defined' do
+    AppOpticsAPM::API::Memcache::MEMCACHE_OPS.each do |m|
+      if ::MemCache.method_defined?(m)
+        ::MemCache.method_defined?("#{m}_with_appoptics").must_equal true
+      end
+      ::MemCache.method_defined?(:request_setup_with_appoptics).must_equal true
+      ::MemCache.method_defined?(:cache_get_with_appoptics).must_equal true
+      ::MemCache.method_defined?(:get_multi_with_appoptics).must_equal true
+    end
+  end
+
+  it "should trace set" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.set('msg', 'blah')
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "set"
+    traces[1].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "msg"
+    traces[2].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace get" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.get('msg')
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 6
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "get"
+    traces[1].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "msg"
+    traces[2]['RemoteHost'].must_equal "127.0.0.1"
+    traces[2].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    traces[3].has_key?('KVHit').must_equal true
+    traces[3].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[4], @exit_kvs)
+  end
+
+  it "should trace get_multi" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.get_multi(['one', 'two', 'three', 'four', 'five', 'six'])
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "get_multi"
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKeyCount'].must_equal 6
+    traces[2].has_key?('KVHitCount').must_equal true
+    traces[2].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace add for existing key" do
+    @mc.set('testKey', 'x', 1200)
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.add('testKey', 'x', 1200)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "add"
+    traces[1].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "testKey"
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace append" do
+    @mc.set('rawKey', "Peanut Butter ", 600, :raw => true)
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.append('rawKey', "Jelly")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "append"
+    traces[1].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[2], @info_kvs)
+
+    traces[2]['KVKey'].must_equal "rawKey"
+    traces[2].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace decrement" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.decr('memcache_key_counter', 1)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+
+    traces[1]['KVOp'].must_equal "decr"
+    traces[1].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
+    traces[2].has_key?('Backtrace').must_equal AppOpticsAPM::Config[:memcache][:collect_backtraces]
+
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace increment" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.incr("memcache_key_counter", 1)
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "incr"
+    validate_event_keys(traces[2], @info_kvs)
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace replace" do
+    @mc.set("some_key", "blah")
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.replace("some_key", "woop")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "replace"
+    traces[2]['KVKey'].must_equal "some_key"
+    validate_event_keys(traces[2], @info_kvs)
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should trace delete" do
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.delete("some_key")
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 5
+    validate_outer_layers(traces, 'memcache_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    traces[1]['KVOp'].must_equal "delete"
+    traces[2]['KVKey'].must_equal "some_key"
+    validate_event_keys(traces[2], @info_kvs)
+    validate_event_keys(traces[3], @exit_kvs)
+  end
+
+  it "should obey :collect_backtraces setting when true" do
+    AppOpticsAPM::Config[:memcache][:collect_backtraces] = true
+
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.set('some_key', 1)
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'memcache', 'Backtrace')
+  end
+
+  it "should obey :collect_backtraces setting when false" do
+    AppOpticsAPM::Config[:memcache][:collect_backtraces] = false
+
+    AppOpticsAPM::API.start_trace('memcache_test', '', {}) do
+      @mc.set('some_key', 1)
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'memcache', 'Backtrace')
+  end
+end

data/test/instrumentation/memcached_test.rb

@@ -0,0 +1,229 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+if RUBY_VERSION < '2.0' and not defined?(JRUBY_VERSION)
+  describe "Memcached" do
+    require 'memcached'
+    require 'memcached/rails'
+
+    before do
+      clear_all_traces
+      @mc = ::Memcached::Rails.new(:servers => ['127.0.0.1'])
+
+      # These are standard entry/exit KVs that are passed up with all mongo operations
+      @entry_kvs = {
+        'Layer' => 'memcache',
+        'Label' => 'entry' }
+
+      @info_kvs = {
+        'Layer' => 'memcache',
+        'Label' => 'info' }
+
+      @exit_kvs = { 'Layer' => 'memcache', 'Label' => 'exit' }
+      @collect_backtraces = AppOpticsAPM::Config[:memcached][:collect_backtraces]
+    end
+
+    after do
+      AppOpticsAPM::Config[:memcached][:collect_backtraces] = @collect_backtraces
+    end
+
+    it 'Stock Memcached should be loaded, defined and ready' do
+      defined?(::Memcached).wont_match nil
+      defined?(::Memcached::Rails).wont_match nil
+    end
+
+    it 'Memcached should have appoptics_apm methods defined' do
+      AppOpticsAPM::API::Memcache::MEMCACHE_OPS.each do |m|
+        if ::Memcached.method_defined?(m)
+          ::Memcached.method_defined?("#{m}_with_appoptics").must_equal true
+        end
+        ::Memcached::Rails.method_defined?(:get_multi_with_appoptics).must_equal true
+      end
+    end
+
+    it "should trace set" do
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.set('testKey', 'blah')
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "set"
+      traces[1]['KVKey'].must_equal "testKey"
+    end
+
+    it "should trace get" do
+      @mc.set('testKey', 'blah')
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.get('testKey')
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "get"
+      traces[1]['KVKey'].must_equal "testKey"
+    end
+
+    it "should trace get_multi" do
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.get_multi(['one', 'two', 'three', 'four', 'five', 'six'])
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @info_kvs)
+      validate_event_keys(traces[3], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "get_multi"
+
+      traces[2]['KVKeyCount'].must_equal 6
+      traces[2].has_key?('KVHitCount').must_equal true
+    end
+
+    it "should trace add for existing key" do
+      @mc.set('testKey', 'x', 1200)
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.add('testKey', 'x', 1200)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[3], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "add"
+      traces[1]['KVKey'].must_equal "testKey"
+
+      traces[2]['ErrorClass'].must_equal "Memcached::NotStored"
+      traces[2]['ErrorMsg'].must_equal "Memcached::NotStored"
+    end
+
+    it "should trace append" do
+      @mc.set('rawKey', "Peanut Butter ", 600, :raw => true)
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.append('rawKey', "Jelly")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "append"
+      traces[1]['KVKey'].must_equal "rawKey"
+    end
+
+    it "should trace decr" do
+      @mc.set('some_key_counter', "100", 0, false)
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.decr('some_key_counter', 1)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "decr"
+      traces[1]['KVKey'].must_equal "some_key_counter"
+    end
+
+    it "should trace increment" do
+      @mc.set('some_key_counter', "100", 0, false)
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.incr("some_key_counter", 1)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "incr"
+      traces[1]['KVKey'].must_equal "some_key_counter"
+    end
+
+    it "should trace replace" do
+      @mc.set('some_key', 'blah')
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.replace("some_key", "woop")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "replace"
+      traces[1]['KVKey'].must_equal "some_key"
+    end
+
+    it "should trace delete" do
+      @mc.set('some_key', 'blah')
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.delete("some_key")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'memcached_test')
+      validate_event_keys(traces[1], @entry_kvs)
+      validate_event_keys(traces[2], @exit_kvs)
+
+      traces[1]['KVOp'].must_equal "delete"
+      traces[1]['KVKey'].must_equal "some_key"
+    end
+
+    it "should obey :collect_backtraces setting when true" do
+      AppOpticsAPM::Config[:memcached][:collect_backtraces] = true
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.set('some_key', 1)
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'memcache', 'Backtrace')
+    end
+
+    it "should obey :collect_backtraces setting when false" do
+      AppOpticsAPM::Config[:memcached][:collect_backtraces] = false
+
+      AppOpticsAPM::API.start_trace('memcached_test', '', {}) do
+        @mc.set('some_key', 1)
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'memcache', 'Backtrace')
+    end
+  end
+end