traceview 3.0.0

data/test/instrumentation/rack_test.rb

@@ -0,0 +1,116 @@
+require 'minitest_helper'
+require 'rack/test'
+require 'rack/lobster'
+require 'traceview/inst/rack'
+
+class RackTestApp < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use TraceView::Rack
+      map "/lobster" do
+        use Rack::Lint
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_get_the_lobster
+    clear_all_traces
+
+    get "/lobster"
+
+    traces = get_all_traces
+    traces.count.must_equal 3
+
+    validate_outer_layers(traces, 'rack')
+
+    kvs = {}
+    kvs["Label"] = "entry"
+    kvs["URL"] = "/lobster"
+    validate_event_keys(traces[0], kvs)
+
+    kvs.clear
+    kvs["Layer"] = "rack"
+    kvs["Label"] = "info"
+    kvs["HTTP-Host"] = "example.org"
+    kvs["Port"] = 80
+    kvs["Proto"] = "http"
+    kvs["Method"] = "GET"
+    kvs["ClientIP"] = "127.0.0.1"
+    validate_event_keys(traces[1], kvs)
+
+    assert traces[0].has_key?('SampleRate')
+    assert traces[0].has_key?('SampleSource')
+    assert traces[1].has_key?('ProcessID')
+    assert traces[1].has_key?('ThreadID')
+
+    assert traces[2]["Label"] == 'exit'
+    assert traces[2]["Status"] == 200
+
+    assert last_response.ok?
+
+    assert last_response['X-Trace']
+  end
+
+  def test_dont_trace_static_assets
+    clear_all_traces
+
+    get "/assets/static_asset.png"
+
+    traces = get_all_traces
+    assert traces.empty?
+
+    assert last_response.status == 404
+  end
+
+  def test_must_return_xtrace_header
+    clear_all_traces
+    get "/lobster"
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert TraceView::XTrace.valid?(xtrace)
+  end
+
+  def test_log_args_when_false
+    clear_all_traces
+
+    @log_args = TraceView::Config[:rack][:log_args]
+    TraceView::Config[:rack][:log_args] = false
+
+    get "/lobster?blah=1"
+
+    traces = get_all_traces
+
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert TraceView::XTrace.valid?(xtrace)
+
+    traces[0]['URL'].must_equal "/lobster"
+
+    TraceView::Config[:rack][:log_args] = @log_args
+  end
+
+  def test_log_args_when_true
+    clear_all_traces
+
+    @log_args = TraceView::Config[:rack][:log_args]
+    TraceView::Config[:rack][:log_args] = true
+
+    get "/lobster?blah=1"
+
+    traces = get_all_traces
+
+    xtrace = last_response['X-Trace']
+    assert xtrace
+    assert TraceView::XTrace.valid?(xtrace)
+
+    traces[0]['URL'].must_equal "/lobster?blah=1"
+
+    TraceView::Config[:rack][:log_args] = @log_args
+  end
+end
+

data/test/instrumentation/redis_hashes_test.rb

@@ -0,0 +1,265 @@
+require 'minitest_helper'
+require "redis"
+
+describe "Redis Hashes" 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 'Stock Redis should be loaded, defined and ready' do
+    defined?(::Redis).wont_match nil
+  end
+
+  it "should trace hdel" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hdel("whale", "color")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hdel"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['field'].must_equal "color"
+  end
+
+  it "should trace hdel multiple fields" do
+    min_server_version(2.4)
+
+    @redis.hset("whale", "color", "blue")
+    @redis.hset("whale", "size", "big")
+    @redis.hset("whale", "eyes", "green")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hdel("whale", ["color", "eyes"])
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hdel"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2].has_key?('field').must_equal false
+  end
+
+  it "should trace hexists" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hexists("whale", "color")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hexists"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['field'].must_equal "color"
+  end
+
+  it "should trace hget" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hget("whale", "color")
+      @redis.hget("whale", "noexist")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 6
+    traces[2]['KVOp'].must_equal "hget"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['KVHit'].must_equal 1
+    traces[2]['field'].must_equal "color"
+    traces[4]['KVHit'].must_equal 0
+  end
+
+  it "should trace hgetall" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hgetall("whale")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hgetall"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hincrby" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "age", 32)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hincrby("whale", "age", 1)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hincrby"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['field'].must_equal "age"
+    traces[2]['increment'].must_equal 1
+  end
+
+  it "should trace hincrbyfloat" do
+    min_server_version(2.6)
+
+    @redis.hset("whale", "age", 32)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hincrbyfloat("whale", "age", 1.3)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hincrbyfloat"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['field'].must_equal "age"
+    traces[2]['increment'].must_equal 1.3
+  end
+
+  it "should trace hkeys" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "age", 32)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hkeys("whale")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hkeys"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hlen" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "age", 32)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hlen("whale")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hlen"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hmget" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+    @redis.hset("whale", "size", "big")
+    @redis.hset("whale", "eyes", "green")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hmget("whale", "color", "size", "blah", "brown")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hmget"
+    traces[2]['KVKey'].must_equal "whale"
+    traces[2]['KVKeyCount'].must_equal 4
+    traces[2]['KVHitCount'].must_equal 2
+  end
+
+  it "should trace hmset" do
+    min_server_version(2.0)
+
+    @redis.hset("whale", "color", "blue")
+    @redis.hset("whale", "size", "big")
+    @redis.hset("whale", "eyes", "green")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hmset("whale", ["color", "red", "size", "very big"])
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hmset"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hset" do
+    min_server_version(2.0)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hset("whale", "eyes", "green")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hset"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hsetnx" do
+    min_server_version(2.0)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hsetnx("whale", "eyes", "green")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hsetnx"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hvals" do
+    min_server_version(2.0)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hvals("whale")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hvals"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+
+  it "should trace hscan" do
+    min_server_version(2.8)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.hscan("whale", 0)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "hscan"
+    traces[2]['KVKey'].must_equal "whale"
+  end
+end
+

data/test/instrumentation/redis_keys_test.rb

@@ -0,0 +1,318 @@
+require 'minitest_helper'
+require "redis"
+
+describe "Redis Keys" 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 'Stock Redis should be loaded, defined and ready' do
+    defined?(::Redis).wont_match nil
+  end
+
+  it "should trace del" do
+    @redis.setex("del_test", 60, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.del("del_test")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "del"
+    traces[2]['KVKey'].must_equal "del_test"
+  end
+
+  it "should trace del of multiple keys" do
+    @redis.setex("del_test", 60, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.del(["del_test", "noexist", "maybe"])
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "del"
+    traces[2].has_key?('KVKey').must_equal false
+  end
+
+  it "should trace dump" do
+    min_server_version(2.6)
+
+    @redis.setex("dump_test", 60, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.dump("del_test")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "dump"
+    traces[2]['KVKey'].must_equal "del_test"
+  end
+
+  it "should trace exists" do
+    @redis.setex("talking_heads", 60, "burning down the house")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @it_exists = @redis.exists("talking_heads")
+    end
+
+    @it_exists.must_equal true
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "exists"
+    traces[2]['KVKey'].must_equal "talking_heads"
+  end
+
+  it "should trace expire" do
+    @redis.set("expire_please", "burning down the house")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.expire("expire_please", 120)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "expire"
+    traces[2]['KVKey'].must_equal "expire_please"
+  end
+
+  it "should trace expireat" do
+    @redis.set("expireat_please", "burning down the house")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.expireat("expireat_please", Time.now.to_i)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "expireat"
+    traces[2]['KVKey'].must_equal "expireat_please"
+  end
+
+  it "should trace keys" do
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.keys("del*")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "keys"
+    traces[2]['pattern'].must_equal "del*"
+  end
+
+  it "should trace basic move" do
+    @redis.set("piano", Time.now)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.move("piano", 1)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "move"
+    traces[2]['KVKey'].must_equal "piano"
+    traces[2]['db'].must_equal 1
+  end
+
+  it "should trace persist" do
+    min_server_version(2.2)
+
+    @redis.setex("mine", 60, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.persist("mine")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "persist"
+    traces[2]['KVKey'].must_equal "mine"
+  end
+
+  it "should trace pexpire" do
+    min_server_version(2.6)
+
+    @redis.set("sand", "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @rv = @redis.pexpire("sand", 8000)
+    end
+
+    @rv.must_equal true
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "pexpire"
+    traces[2]['KVKey'].must_equal "sand"
+    traces[2]['milliseconds'].must_equal 8000
+  end
+
+  it "should trace pexpireat" do
+    min_server_version(2.6)
+
+    @redis.set("sand", "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @rv = @redis.pexpireat("sand", 8000)
+    end
+
+    @rv.must_equal true
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "pexpireat"
+    traces[2]['KVKey'].must_equal "sand"
+    traces[2]['milliseconds'].must_equal 8000
+  end
+
+  it "should trace pttl" do
+    min_server_version(2.6)
+
+    @redis.setex("sand", 120, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.pttl("sand")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "pttl"
+    traces[2]['KVKey'].must_equal "sand"
+  end
+
+  it "should trace randomkey" do
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.randomkey()
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "randomkey"
+  end
+
+  it "should trace rename" do
+    @redis.setex("sand", 120, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.rename("sand", "sandy")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "rename"
+    traces[2]['KVKey'].must_equal "sand"
+    traces[2]['newkey'].must_equal "sandy"
+  end
+
+  it "should trace renamenx" do
+    @redis.setex("sand", 120, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.renamenx("sand", "sandy")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "renamenx"
+    traces[2]['KVKey'].must_equal "sand"
+    traces[2]['newkey'].must_equal "sandy"
+  end
+
+  it "should trace restore" do
+    min_server_version(2.6)
+
+    @redis.setex("qubit", 60, "zero")
+    x = @redis.dump("qubit")
+    @redis.del "blue"
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.restore("blue", 0, x)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "restore"
+    traces[2]['KVKey'].must_equal "blue"
+    traces[2]['ttl'].must_equal 0
+  end
+
+  it "should trace sort" do
+    min_server_version(2.2)
+
+    @redis.rpush("penguin", "one")
+    @redis.rpush("penguin", "two")
+    @redis.rpush("penguin", "three")
+    @redis.rpush("penguin", "four")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.sort("penguin", :order => "desc alpha", :store => "target")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "sort"
+    traces[2]['KVKey'].must_equal "penguin"
+  end
+
+  it "should trace ttl" do
+    min_server_version(2.6)
+
+    @redis.setex("sand", 120, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.ttl("sand")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "ttl"
+    traces[2]['KVKey'].must_equal "sand"
+  end
+
+  it "should trace type" do
+    min_server_version(2.6)
+
+    @redis.setex("sand", 120, "blah")
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.type("sand")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "type"
+    traces[2]['KVKey'].must_equal "sand"
+  end
+
+  it "should trace scan" do
+    min_server_version(2.8)
+
+    TraceView::API.start_trace('redis_test', '', {}) do
+      @redis.scan(0)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    traces[2]['KVOp'].must_equal "scan"
+  end
+end
+