appoptics_apm 4.0.2

data/test/instrumentation/redis_strings_test.rb

@@ -0,0 +1,349 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+if defined?(::Redis)
+  describe "Redis Strings" do
+    attr_reader :entry_kvs, :exit_kvs, :redis, :redis_version
+
+    def min_server_version(version)
+      unless Gem::Version.new(@redis_version) >= Gem::Version.new(version.to_s)
+        skip "supported only on redis-server #{version} or greater"
+      end
+    end
+
+    before do
+      clear_all_traces
+
+      @redis ||= Redis.new(:host => ENV['APPOPTICS_REDIS_SERVER'] || '127.0.0.1')
+
+      @redis_version ||= @redis.info["redis_version"]
+
+      # These are standard entry/exit KVs that are passed up with all moped operations
+      @entry_kvs ||= { 'Layer' => 'redis_test', 'Label' => 'entry' }
+      @exit_kvs  ||= { 'Layer' => 'redis_test', 'Label' => 'exit' }
+    end
+
+    it "should trace append" do
+      @redis.set("yourkey", "test")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.append("yourkey", "blah")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "append"
+      traces[2]['KVKey'].must_equal "yourkey"
+    end
+
+    it "should trace bitcount (>=2.6)" do
+
+      min_server_version("2.6")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.bitcount("yourkey")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "bitcount"
+      traces[2]['start'].must_equal 0
+      traces[2]['stop'].must_equal (-1)
+    end
+
+    it "should trace bitop (>=2.6)" do
+
+      min_server_version("2.6")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.bitop("not", "bitopkey", "yourkey")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "bitop"
+      traces[2]['operation'].must_equal "not"
+      traces[2]['destkey'].must_equal "bitopkey"
+    end
+
+    it "should trace decr" do
+      @redis.setex("decr", 60, 0)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.decr("decr")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "decr"
+      traces[2]['KVKey'].must_equal "decr"
+    end
+
+    it "should trace decrby" do
+      @redis.setex("decr", 60, 0)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.decrby("decr", 1)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "decrby"
+      traces[2]['KVKey'].must_equal "decr"
+      traces[2]['decrement'].must_equal 1
+    end
+
+    it "should trace get" do
+      @redis.setex("diwore", 60, "okokok")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @rv = @redis.get("diwore")
+      end
+
+      @rv.must_equal "okokok"
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "get"
+      traces[2]['KVKey'].must_equal "diwore"
+    end
+
+    it "should trace getbit" do
+      min_server_version(2.2)
+
+      @redis.setex("diwore", 60, "okokok")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.getbit("diwore", 3)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "getbit"
+      traces[2]['KVKey'].must_equal "diwore"
+      traces[2]['offset'].must_equal 3
+    end
+
+    it "should trace getrange" do
+      min_server_version(2.2)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.getrange("yourkey", 0, 3)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "getrange"
+      traces[2]['KVKey'].must_equal "yourkey"
+      traces[2]['start'].must_equal 0
+      traces[2]['end'].must_equal 3
+    end
+
+    it "should trace getset" do
+      min_server_version(2.2)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.getset("dollar", 0)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "getset"
+      traces[2]['KVKey'].must_equal "dollar"
+      traces[2]['value'].must_equal "0"
+    end
+
+    it "should trace incr" do
+      @redis.setex("dotcom", 60, 0)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.incr("dotcom")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "incr"
+      traces[2]['KVKey'].must_equal "dotcom"
+    end
+
+    it "should trace incrby" do
+      @redis.setex("incr", 60, 0)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.incrby("incr", 1)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "incrby"
+      traces[2]['KVKey'].must_equal "incr"
+      traces[2]['increment'].must_equal 1
+    end
+
+    it "should trace incrbyfloat" do
+      min_server_version(2.6)
+
+      @redis.setex("incrfloat", 60, 0.0)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.incrbyfloat("incrfloat", 1.01)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "incrbyfloat"
+      traces[2]['KVKey'].must_equal "incrfloat"
+      traces[2]['increment'].must_equal 1.01
+    end
+
+    it "should trace mget" do
+      @redis.setex("france", 60, "ok")
+      @redis.setex("denmark", 60, "ok")
+      @redis.setex("germany", 60, "ok")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.mget(["france", "nothing", "denmark"])
+        @redis.mget("germany")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 6
+      traces[2]['KVOp'].must_equal "mget"
+      traces[2]['KVKeyCount'].must_equal 3
+      traces[2]['KVHitCount'].must_equal 2
+      traces[4]['KVOp'].must_equal "mget"
+      traces[4]['KVKeyCount'].must_equal 1
+      traces[4]['KVHitCount'].must_equal 1
+    end
+
+    it "should trace mset" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.mset(["one", 1, "two", 2, "three", 3])
+        @redis.mset("one", 1)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 6
+      traces[2]['KVOp'].must_equal "mset"
+      traces[2]['KVKeyCount'].must_equal 3
+      traces[4]['KVOp'].must_equal "mset"
+      traces[4]['KVKeyCount'].must_equal 1
+    end
+
+    it "should trace msetnx" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.msetnx(["one", 1, "two", 2, "three", 3])
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "msetnx"
+    end
+
+    it "should trace psetex (>= v2.6)" do
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.psetex("one", 60, "hello")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "psetex"
+      traces[2]['KVKey'].must_equal "one"
+      traces[2]['ttl'].must_equal 60
+    end
+
+    it "should trace basic set" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.set("one",   "hello")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "set"
+      traces[2]['KVKey'].must_equal "one"
+    end
+
+    it "should trace set + expiration" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.set("one", "hello", :ex => 12)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "set"
+      traces[2]['KVKey'].must_equal "one"
+      traces[2]['ex'].must_equal 12
+    end
+
+    it "should trace setbit" do
+      min_server_version(2.2)
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.setbit("yourkey", 3, 0)
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "setbit"
+      traces[2]['KVKey'].must_equal "yourkey"
+      traces[2]['offset'].must_equal 3
+    end
+
+    it "should trace setex" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.setex("one", 60, "hello")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "setex"
+      traces[2]['KVKey'].must_equal "one"
+      traces[2]['ttl'].must_equal 60
+    end
+
+    it "should trace setnx" do
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.setnx("one", "hello")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "setnx"
+      traces[2]['KVKey'].must_equal "one"
+    end
+
+    it "should trace setrange" do
+      min_server_version(2.2)
+
+      @redis.setex("spandau_ballet", 60, "XXXXXXXXXXXXXXX")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.setrange("yourkey", 2, "ok")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "setrange"
+      traces[2]['KVKey'].must_equal "yourkey"
+      traces[2]['offset'].must_equal 2
+    end
+
+    it "should trace strlen" do
+      min_server_version(2.2)
+
+      @redis.setex("talking_heads", 60, "burning down the house")
+
+      AppOpticsAPM::API.start_trace('redis_test', '', {}) do
+        @redis.strlen("talking_heads")
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      traces[2]['KVOp'].must_equal "strlen"
+      traces[2]['KVKey'].must_equal "talking_heads"
+    end
+  end
+end

data/test/instrumentation/resque_test.rb

@@ -0,0 +1,185 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+if RUBY_VERSION >= '1.9.3' && !defined?(JRUBY_VERSION)
+  require 'minitest_helper'
+  require_relative "../jobs/resque/remote_call_worker_job"
+  require_relative "../jobs/resque/error_worker_job"
+
+  class ResqueClientTest < Minitest::Test
+    def setup
+      clear_all_traces
+      @collect_backtraces = AppOpticsAPM::Config[:resqueclient][:collect_backtraces]
+      @log_args = AppOpticsAPM::Config[:resqueclient][:log_args]
+    end
+
+    def teardown
+      AppOpticsAPM::Config[:resqueclient][:collect_backtraces] = @collect_backtraces
+      AppOpticsAPM::Config[:resqueclient][:log_args] = @log_args
+    end
+
+    def test_appoptics_methods_defined
+      [ :enqueue, :enqueue_to, :dequeue ].each do |m|
+        assert_equal true, ::Resque.method_defined?("#{m}_with_appoptics")
+      end
+
+      assert_equal true, ::Resque::Worker.method_defined?("perform_with_appoptics")
+      assert_equal true, ::Resque::Job.method_defined?("fail_with_appoptics")
+    end
+
+    def not_tracing_validation
+      assert_equal true, Resque.enqueue(ResqueRemoteCallWorkerJob), "not tracing; enqueue return value"
+      assert_equal true, Resque.enqueue(ResqueRemoteCallWorkerJob, 1, 2, "3"), "not tracing; enqueue extra params"
+    end
+
+    def test_enqueue
+      AppOpticsAPM::API.start_trace('resque-client_test', '', {}) do
+        Resque.enqueue(ResqueRemoteCallWorkerJob)
+      end
+
+      traces = get_all_traces
+
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                       traces[4]['Label'], "exit event label"
+    end
+
+    def test_dequeue
+      AppOpticsAPM::API.start_trace('resque-client_test', '', {}) do
+        Resque.dequeue(ResqueRemoteCallWorkerJob, { :generate => :moped })
+      end
+
+      traces = get_all_traces
+
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                        traces[4]['Label'], "exit event label"
+    end
+
+    def test_legacy_resque_config
+      assert_equal true, (AppOpticsAPM::Config[:resque][:enabled] = true), "set legacy resque config options don't die"
+      assert_equal true, (AppOpticsAPM::Config[:resque][:link_workers] = true), "set legacy resque config options don't die"
+    end
+
+    def test_collect_backtraces_default_value
+      assert_equal AppOpticsAPM::Config[:resqueclient][:collect_backtraces], true, "default backtrace collection"
+    end
+
+    def test_log_args_default_value
+      assert_equal AppOpticsAPM::Config[:resqueclient][:log_args], true, "log_args default "
+    end
+
+    def test_obey_collect_backtraces_when_false
+      AppOpticsAPM::Config[:resqueclient][:collect_backtraces] = false
+
+      # Queue up a job to be run
+      ::AppOpticsAPM::API.start_trace('resque-client_test') do
+        Resque.enqueue(ResqueRemoteCallWorkerJob, [1, 2, 3])
+      end
+
+      traces = get_all_traces
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal false,           traces[1].key?('Backtrace')
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                       traces[4]['Label'], "exit event label"
+    end
+
+    def test_obey_collect_backtraces_when_true
+      AppOpticsAPM::Config[:resqueclient][:collect_backtraces] = true
+
+      # Queue up a job to be run
+      ::AppOpticsAPM::API.start_trace('resque-client_test') do
+        Resque.enqueue(ResqueRemoteCallWorkerJob, [1, 2, 3])
+      end
+
+      traces = get_all_traces
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal true,           traces[1].key?('Backtrace')
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                       traces[4]['Label'], "exit event label"
+    end
+
+    def test_obey_log_args_when_false
+      AppOpticsAPM::Config[:resqueclient][:log_args] = false
+
+      # Queue up a job to be run
+      ::AppOpticsAPM::API.start_trace('resque-client_test') do
+        Resque.enqueue(ResqueRemoteCallWorkerJob, [1, 2, 3])
+      end
+
+      traces = get_all_traces
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal false,           traces[1].key?('Args')
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                       traces[4]['Label'], "exit event label"
+    end
+
+    def test_obey_log_args_when_true
+      AppOpticsAPM::Config[:resqueclient][:log_args] = true
+
+      # Queue up a job to be run
+      ::AppOpticsAPM::API.start_trace('resque-client_test') do
+        Resque.enqueue(ResqueRemoteCallWorkerJob, 1, 2, 3)
+      end
+
+      traces = get_all_traces
+      assert_equal 6, traces.count, "trace count"
+      validate_outer_layers(traces, 'resque-client_test')
+
+      assert_equal true,            traces[1].key?('Args')
+      assert_equal "[1,2,3]",     traces[1]['Args']
+
+      assert_equal "resque-client",              traces[1]['Layer'], "entry event layer name"
+      assert_equal "entry",                      traces[1]['Label'], "entry event label"
+      assert_equal "pushq",                      traces[1]['Spec']
+      assert_equal "resque",                     traces[1]['Flavor']
+      assert_equal "ResqueRemoteCallWorkerJob",  traces[1]['JobName']
+      assert_equal "critical",                   traces[1]['Queue']
+      assert_equal "resque-client",              traces[4]['Layer'], "exit event layer name"
+      assert_equal "exit",                       traces[4]['Label'], "exit event label"
+    end
+  end
+end