oboe 2.4.0.1 → 2.5.0.7

data/lib/oboe/version.rb

@@ -4,9 +4,9 @@
 module Oboe
   module Version
     MAJOR = 2
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
-    BUILD = 1
+    BUILD = 7
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/lib/oboe/xtrace.rb

@@ -12,16 +12,13 @@ module Oboe
       #
       def valid?(xtrace)
         begin
-          xtrace = xtrace.to_s
-          valid = true
+          # The X-Trace ID shouldn't be an initialized empty ID
+          return false if (xtrace =~ /^1b0000000/i) == 0
 
           # Valid X-Trace IDs have a length of 58 bytes and start with '1b'
-          valid = false unless xtrace.length == 58 and (xtrace =~ /^1b/i) == 0
-
-          # The X-Trace ID shouldn't be an initialized empty ID
-          valid = false if (xtrace =~ /^1b0000000/i) == 0
+          return false unless xtrace.length == 58 and (xtrace =~ /^1b/i) == 0
 
-          valid
+          true
         rescue StandardError => e
           Oboe.logger.debug e.message
           Oboe.logger.debug e.backtrace

data/lib/oboe_metal.rb

@@ -52,7 +52,11 @@ module Oboe_metal
           Oboe.reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host])
         end
 
-        Oboe::API.report_init('rack') unless ["development", "test"].include? ENV['RACK_ENV']
+        # Only report __Init from here if we are not instrumenting a framework.
+        # Otherwise, frameworks will handle reporting __Init after full initialization
+        unless defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino)
+          Oboe::API.report_init('rack') unless ["development", "test"].include? ENV['RACK_ENV']
+        end
 
       rescue Exception => e
         $stderr.puts e.message

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -57,6 +57,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:mongo][:enabled] = true
   # Oboe::Config[:moped][:enabled] = true
   # Oboe::Config[:nethttp][:enabled] = true
+  # Oboe::Config[:redis][:enabled] = true
   # Oboe::Config[:resque][:enabled] = true
   
   #
@@ -77,6 +78,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:mongo][:collect_backtraces] = true
   # Oboe::Config[:moped][:collect_backtraces] = true
   # Oboe::Config[:nethttp][:collect_backtraces] = true
+  # Oboe::Config[:redis][:collect_backtraces] = false
   # Oboe::Config[:resque][:collect_backtraces] = true
   #
 

data/test/frameworks/apps/padrino_simple.rb

@@ -0,0 +1,37 @@
+PADRINO_ROOT = File.dirname(__FILE__) unless defined? PADRINO_ROOT
+# Remove this comment if you want do some like this: ruby PADRINO_ENV=test app.rb
+#
+# require 'rubygems'
+# require 'padrino-core'
+#
+
+class SimpleDemo < Padrino::Application
+  set :reload, true
+  before { true }
+  after  { true }
+  error(404) { "404" }
+end
+
+SimpleDemo.controllers do
+  get "/" do
+    'The magick number is: 2767356926488785838763860464013972991031534522105386787489885890443740254365!' # Change only the number!!!
+  end
+
+  get "/rand" do
+    rand(2 ** 256).to_s
+  end
+
+  get "/render" do
+    render :erb, "This is an erb render"
+  end
+end
+
+## If you want use this as a standalone app uncomment:
+#
+# Padrino.mount("SimpleDemo").to("/")
+# Padrino.run! unless Padrino.loaded? # If you enable reloader prevent to re-run the app
+#
+# Then run it from your console: ruby -I"lib" test/fixtures/apps/simple.rb
+#
+
+Padrino.load!

data/test/frameworks/test_padrino.rb

@@ -0,0 +1,32 @@
+require "minitest_helper"
+
+describe Padrino do
+  before do
+    clear_all_traces 
+  end
+
+  it "should do this" do
+
+    mock_app do
+      get("/") { render :erb, "ok" }
+    end
+    debugger
+    r = get "/"
+    
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'dalli_test')
+
+    traces[1].has_key?("KVOp").must_equal true
+    traces[1].has_key?("KVKey").must_equal true
+    traces[1]['Layer'].must_equal "memcache"
+    traces[1]['KVKey'].must_equal "some_key"
+
+    traces[2]['Layer'].must_equal "memcache"
+    traces[2]['Label'].must_equal "info"
+    traces[2].has_key?('KVHit')
+
+  end
+end
+

data/test/instrumentation/redis_hashes_test.rb

@@ -0,0 +1,265 @@
+require 'minitest_helper'
+require "redis"
+    
+describe Oboe::Inst::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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)
+
+    Oboe::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 Oboe::Inst::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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
+    Oboe::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)
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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"
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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")
+
+    Oboe::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)
+
+    Oboe::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
+