traceview 3.0.0

data/test/instrumentation/redis_strings_test.rb

@@ -0,0 +1,333 @@
+require 'minitest_helper'
+require "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
+
+    @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")
+
+    TraceView::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")
+
+    TraceView::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")
+
+    TraceView::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)
+
+    TraceView::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)
+
+    TraceView::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")
+
+    TraceView::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")
+
+    TraceView::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)
+
+    TraceView::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)
+
+    TraceView::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)
+
+    TraceView::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)
+
+    TraceView::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)
+
+    TraceView::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")
+
+    TraceView::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
+    TraceView::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
+    TraceView::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
+
+    TraceView::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
+    TraceView::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 setbit" do
+    min_server_version(2.2)
+
+    TraceView::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
+    TraceView::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
+    TraceView::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")
+
+    TraceView::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")
+
+    TraceView::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

data/test/instrumentation/resque_test.rb

@@ -0,0 +1,62 @@
+require 'minitest_helper'
+
+describe "Resque" do
+  before do
+    clear_all_traces
+
+    # These are standard entry/exit KVs that are passed up with all moped operations
+    @entry_kvs = {
+      'Layer' => 'resque',
+      'Label' => 'entry' }
+
+    @exit_kvs = { 'Layer' => 'resque', 'Label' => 'exit' }
+  end
+
+  it 'Stock Resque should be loaded, defined and ready' do
+    defined?(::Resque).wont_match nil
+    defined?(::Resque::Worker).wont_match nil
+    defined?(::Resque::Job).wont_match nil
+  end
+
+  it 'Resque should have traceview methods defined' do
+    [ :enqueue, :enqueue_to, :dequeue ].each do |m|
+      ::Resque.method_defined?("#{m}_with_traceview").must_equal true
+    end
+
+    ::Resque::Worker.method_defined?("perform_with_traceview").must_equal true
+    ::Resque::Job.method_defined?("fail_with_traceview").must_equal true
+  end
+
+  it "should trace enqueue" do
+    skip
+    TraceView::API.start_trace('resque-client_test', '', {}) do
+      Resque.enqueue(TraceViewResqueJob, { :generate => :activerecord, :delay => rand(5..30).to_f })
+      Resque.enqueue(TraceViewResqueJobThatFails)
+      Resque.dequeue(TraceViewResqueJob, { :generate => :moped })
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'resque-client_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    validate_event_keys(traces[2], @exit_kvs)
+  end
+
+  it "should trace dequeue" do
+    skip
+    TraceView::API.start_trace('resque-client_test', '', {}) do
+      Resque.dequeue(TraceViewResqueJob, { :generate => :moped })
+    end
+
+    traces = get_all_traces
+
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'resque-client_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    validate_event_keys(traces[2], @exit_kvs)
+  end
+end
+

data/test/instrumentation/rest-client_test.rb

@@ -0,0 +1,294 @@
+require 'minitest_helper'
+
+if RUBY_VERSION >= '1.9.3'
+  describe "RestClient" do
+    before do
+      clear_all_traces
+      @collect_backtraces = TraceView::Config[:rest_client][:collect_backtraces]
+    end
+
+    after do
+      TraceView::Config[:rest_client][:collect_backtraces] = @collect_backtraces
+    end
+
+    it 'RestClient should be defined and ready' do
+      defined?(::RestClient).wont_match nil
+    end
+
+    it 'RestClient should have traceview methods defined' do
+      [ :execute_with_traceview ].each do |m|
+        ::RestClient::Request.method_defined?(m).must_equal true
+      end
+    end
+
+    it "should report rest-client version in __Init" do
+      init_kvs = ::TraceView::Util.build_init_report
+
+      init_kvs.key?('Ruby.RestClient.Version').must_equal true
+      init_kvs['Ruby.RestClient.Version'].must_equal "RestClient-#{::RestClient::VERSION}"
+    end
+
+    it "should trace a request to an instr'd app" do
+      response = nil
+
+      TraceView::API.start_trace('rest_client_test') do
+        response = RestClient.get 'http://127.0.0.1:8101/'
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 10
+
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'info'
+      traces[6]['IsService'].must_equal 1
+      traces[6]['RemoteProtocol'].must_equal 'HTTP'
+      traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+      traces[6]['ServiceArg'].must_equal '/'
+      traces[6]['HTTPMethod'].must_equal 'GET'
+      traces[6]['HTTPStatus'].must_equal "200"
+      traces[6].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'exit'
+
+      traces[8]['Layer'].must_equal 'rest-client'
+      traces[8]['Label'].must_equal 'exit'
+
+      response.headers.key?(:x_trace).wont_equal nil
+      xtrace = response.headers[:x_trace]
+      TraceView::XTrace.valid?(xtrace).must_equal true
+    end
+
+    it 'should trace a raw GET request' do
+      response = nil
+
+      TraceView::API.start_trace('rest_client_test') do
+        response = RestClient.get 'http://127.0.0.1:8101/?a=1'
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 10
+
+      # FIXME: We need to switch from making external calls to an internal test
+      # stack instead so we can validate cross-app traces.
+      # valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'info'
+      traces[6]['IsService'].must_equal 1
+      traces[6]['RemoteProtocol'].must_equal 'HTTP'
+      traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+      traces[6]['ServiceArg'].must_equal '/?a=1'
+      traces[6]['HTTPMethod'].must_equal 'GET'
+      traces[6]['HTTPStatus'].must_equal "200"
+      traces[6].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'exit'
+
+      traces[8]['Layer'].must_equal 'rest-client'
+      traces[8]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace a raw POST request' do
+      response = nil
+
+      TraceView::API.start_trace('rest_client_test') do
+        response = RestClient.post 'http://127.0.0.1:8101/', :param1 => 'one', :nested => { :param2 => 'two' }
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 10
+
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'info'
+      traces[6]['IsService'].must_equal 1
+      traces[6]['RemoteProtocol'].must_equal 'HTTP'
+      traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+      traces[6]['ServiceArg'].must_equal '/'
+      traces[6]['HTTPMethod'].must_equal 'POST'
+      traces[6]['HTTPStatus'].must_equal "200"
+      traces[6].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'exit'
+
+      traces[8]['Layer'].must_equal 'rest-client'
+      traces[8]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace a ActiveResource style GET request' do
+      response = nil
+
+      TraceView::API.start_trace('rest_client_test') do
+        resource = RestClient::Resource.new 'http://127.0.0.1:8101/?a=1'
+        response = resource.get
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 10
+
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'info'
+      traces[6]['IsService'].must_equal 1
+      traces[6]['RemoteProtocol'].must_equal 'HTTP'
+      traces[6]['RemoteHost'].must_equal '127.0.0.1:8101'
+      traces[6]['ServiceArg'].must_equal '/?a=1'
+      traces[6]['HTTPMethod'].must_equal 'GET'
+      traces[6]['HTTPStatus'].must_equal "200"
+      traces[6].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'exit'
+
+      traces[8]['Layer'].must_equal 'rest-client'
+      traces[8]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace requests with redirects' do
+      response = nil
+
+      TraceView::API.start_trace('rest_client_test') do
+        resource = RestClient::Resource.new 'http://www.appneta.com/products/traceview?a=1'
+        response = resource.get
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 12
+
+      # FIXME: We need to switch from making external calls to an internal test
+      # stack instead so we can validate cross-app traces.
+      # valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'net-http'
+      traces[2]['Label'].must_equal 'entry'
+
+      traces[3]['Layer'].must_equal 'net-http'
+      traces[3]['Label'].must_equal 'info'
+      traces[3]['IsService'].must_equal 1
+      traces[3]['RemoteProtocol'].must_equal 'HTTP'
+      traces[3]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[3]['ServiceArg'].must_equal '/products/traceview?a=1'
+      traces[3]['HTTPMethod'].must_equal 'GET'
+      traces[3]['HTTPStatus'].must_equal "301"
+      traces[3].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[4]['Layer'].must_equal 'net-http'
+      traces[4]['Label'].must_equal 'exit'
+
+      traces[5]['Layer'].must_equal 'rest-client'
+      traces[5]['Label'].must_equal 'entry'
+
+      traces[6]['Layer'].must_equal 'net-http'
+      traces[6]['Label'].must_equal 'entry'
+
+      traces[7]['Layer'].must_equal 'net-http'
+      traces[7]['Label'].must_equal 'info'
+      traces[7]['IsService'].must_equal 1
+      traces[7]['RemoteProtocol'].must_equal 'HTTP'
+      traces[7]['RemoteHost'].must_equal 'www.appneta.com'
+      traces[7]['ServiceArg'].must_equal '/products/traceview/?a=1'
+      traces[7]['HTTPMethod'].must_equal 'GET'
+      traces[7]['HTTPStatus'].must_equal "200"
+      traces[7].key?('Backtrace').must_equal TraceView::Config[:nethttp][:collect_backtraces]
+
+      traces[8]['Layer'].must_equal 'net-http'
+      traces[8]['Label'].must_equal 'exit'
+
+      traces[9]['Layer'].must_equal 'rest-client'
+      traces[9]['Label'].must_equal 'exit'
+
+      traces[10]['Layer'].must_equal 'rest-client'
+      traces[10]['Label'].must_equal 'exit'
+    end
+
+    it 'should trace and capture raised exceptions' do
+      TraceView::API.start_trace('rest_client_test') do
+        begin
+          RestClient.get 'http://s6KTgaz7636z/resource'
+        rescue
+          # We want an exception to be raised.  Just don't raise
+          # it beyond this point.
+        end
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      valid_edges?(traces).must_equal true
+      validate_outer_layers(traces, 'rest_client_test')
+
+      traces[1]['Layer'].must_equal 'rest-client'
+      traces[1]['Label'].must_equal 'entry'
+
+      traces[2]['Layer'].must_equal 'rest-client'
+      traces[2]['Label'].must_equal 'error'
+      traces[2]['ErrorClass'].must_equal 'SocketError'
+      traces[2].key?('ErrorMsg').must_equal true
+      traces[2].key?('Backtrace').must_equal true
+
+      traces[3]['Layer'].must_equal 'rest-client'
+      traces[3]['Label'].must_equal 'exit'
+    end
+
+    it 'should obey :collect_backtraces setting when true' do
+      TraceView::Config[:rest_client][:collect_backtraces] = true
+
+      TraceView::API.start_trace('rest_client_test') do
+        RestClient.get('http://127.0.0.1:8101/', {:a => 1})
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'rest-client', 'Backtrace')
+    end
+
+    it 'should obey :collect_backtraces setting when false' do
+      TraceView::Config[:rest_client][:collect_backtraces] = false
+
+      TraceView::API.start_trace('rest_client_test') do
+        RestClient.get('http://127.0.0.1:8101/', {:a => 1})
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'rest-client', 'Backtrace')
+    end
+  end
+end