oboe 2.6.5.5 → 2.6.6.1

data/test/instrumentation/memcached_test.rb

@@ -4,9 +4,9 @@ if RUBY_VERSION < '2.0'
   describe Oboe::Inst::Memcached do
     require 'memcached'
     require 'memcached/rails'
-  
+
     before do
-      clear_all_traces 
+      clear_all_traces
       @mc = ::Memcached::Rails.new(:servers => ['localhost'])
 
       # These are standard entry/exit KVs that are passed up with all mongo operations
@@ -27,16 +27,16 @@ if RUBY_VERSION < '2.0'
     end
 
     it 'Stock Memcached should be loaded, defined and ready' do
-      defined?(::Memcached).wont_match nil 
-      defined?(::Memcached::Rails).wont_match nil 
+      defined?(::Memcached).wont_match nil
+      defined?(::Memcached::Rails).wont_match nil
     end
 
     it 'Memcached should have oboe methods defined' do
       Oboe::API::Memcache::MEMCACHE_OPS.each do |m|
         if ::Memcached.method_defined?(m)
-          ::Memcached.method_defined?("#{m}_with_oboe").must_equal true 
+          ::Memcached.method_defined?("#{m}_with_oboe").must_equal true
         end
-        ::Memcached::Rails.method_defined?(:get_multi_with_oboe).must_equal true 
+        ::Memcached::Rails.method_defined?(:get_multi_with_oboe).must_equal true
       end
     end
 
@@ -44,110 +44,118 @@ if RUBY_VERSION < '2.0'
       Oboe::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')
+
       Oboe::API.start_trace('memcached_test', '', {}) do
-        @mc.get('msg')
+        @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 "msg"
+      traces[1]['KVKey'].must_equal "testKey"
     end
-    
+
     it "should trace get_multi" do
       Oboe::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)
+
       Oboe::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]['Message'].must_equal "Memcached::NotStored"
     end
-    
+
     it "should trace append" do
       @mc.set('rawKey', "Peanut Butter ", 600, :raw => true)
       Oboe::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)
+
       Oboe::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)
+
       Oboe::API.start_trace('memcached_test', '', {}) do
         @mc.incr("some_key_counter", 1)
       end
-      
+
       traces = get_all_traces
       traces.count.must_equal 4
 
@@ -158,20 +166,20 @@ if RUBY_VERSION < '2.0'
       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')
       Oboe::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
@@ -181,10 +189,10 @@ if RUBY_VERSION < '2.0'
       Oboe::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)
@@ -192,7 +200,7 @@ if RUBY_VERSION < '2.0'
       traces[1]['KVOp'].must_equal "delete"
       traces[1]['KVKey'].must_equal "some_key"
     end
-    
+
     it "should obey :collect_backtraces setting when true" do
       Oboe::Config[:memcached][:collect_backtraces] = true
 

data/test/instrumentation/mongo_test.rb

@@ -2,7 +2,7 @@ require 'minitest_helper'
 
 describe Oboe::Inst::Mongo do
   before do
-    clear_all_traces 
+    clear_all_traces
     @connection = Mongo::Connection.new("localhost", 27017, :slave_ok => true)
     @db = @connection.db("test-#{ENV['RACK_ENV']}")
 
@@ -21,13 +21,13 @@ describe Oboe::Inst::Mongo do
     @exit_kvs = { 'Layer' => 'mongo', 'Label' => 'exit' }
     @collect_backtraces = Oboe::Config[:mongo][:collect_backtraces]
   end
-  
+
   after do
     Oboe::Config[:mongo][:collect_backtraces] = @collect_backtraces
   end
 
   it 'Stock Mongo should be loaded, defined and ready' do
-    defined?(::Mongo).wont_match nil 
+    defined?(::Mongo).wont_match nil
     defined?(::Mongo::DB).wont_match nil
     defined?(::Mongo::Cursor).wont_match nil
     defined?(::Mongo::Collection).wont_match nil
@@ -56,7 +56,7 @@ describe Oboe::Inst::Mongo do
     Oboe::API.start_trace('mongo_test', '', {}) do
       @db.create_collection("create_and_drop_collection_test")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -72,11 +72,11 @@ describe Oboe::Inst::Mongo do
   it "should trace drop_collection" do
     # Create a collection so we have one to drop
     @db.create_collection("create_and_drop_collection_test")
-    
+
     Oboe::API.start_trace('mongo_test', '', {}) do
       @db.drop_collection("create_and_drop_collection_test")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -95,7 +95,7 @@ describe Oboe::Inst::Mongo do
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.count(:query => {:name => "MyName"})
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 6
 
@@ -105,14 +105,14 @@ describe Oboe::Inst::Mongo do
 
     traces[3]['QueryOp'].must_equal "count"
   end
-  
+
   it "should trace find_and_modify" do
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.find_and_modify({ :query => { :name => "MyName" }, :update => { :count => 203 }})
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -125,7 +125,7 @@ describe Oboe::Inst::Mongo do
     traces[1]['QueryOp'].must_equal "find_and_modify"
     traces[1]['Update_Document'].must_equal "{:count=>203}"
   end
-  
+
   it "should trace insert" do
     coll = @db.collection("testCollection")
 
@@ -133,21 +133,21 @@ describe Oboe::Inst::Mongo do
       doc = {"name" => "MyName", "type" => "MyType", "count" => 1, "info" => {"x" => 203, "y" => '102'}}
       id = coll.insert(doc)
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "insert"
     # Don't test exact hash value since to_json hash ordering varies between 1.8.7 and 1.9+
     traces[1].has_key?('Query').must_equal true
   end
-  
+
   it "should trace map_reduce" do
     coll = @db.collection("testCollection")
 
@@ -156,14 +156,14 @@ describe Oboe::Inst::Mongo do
       reduce = "function(k, vals) { var sum = 0; for(var i in vals) sum += vals[i]; return sum; }"
       coll.map_reduce(map, reduce, { :out => "mr_results", :limit => 100, :read => :primary })
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "map_reduce"
@@ -171,14 +171,14 @@ describe Oboe::Inst::Mongo do
     traces[1]['Reduce_Function'].must_equal "function(k, vals) { var sum = 0; for(var i in vals) sum += vals[i]; return sum; }"
     traces[1]['Limit'].must_equal "100"
   end
-  
+
   it "should trace remove" do
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.remove(:name => "SaveOp")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -191,7 +191,7 @@ describe Oboe::Inst::Mongo do
     traces[1]['QueryOp'].must_equal "remove"
     traces[1]['Query'].must_equal "{\"name\":\"SaveOp\"}"
   end
-  
+
   it "should trace rename" do
     coll = @db.collection("testCollection")
     new_name = (0...10).map{ ('a'..'z').to_a[rand(26)] }.join
@@ -199,19 +199,19 @@ describe Oboe::Inst::Mongo do
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.rename(new_name)
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "rename"
     traces[1]['New_Collection_Name'].must_equal new_name
-    
+
     # Clean up after test and set collection name back to original
     coll.rename("testCollection")
   end
@@ -222,23 +222,23 @@ describe Oboe::Inst::Mongo do
     Oboe::API.start_trace('mongo_test', '', {}) do
       # Two types of update calls
       coll.update({"_id" => 1}, { "$set" => {"name" => "MongoDB Ruby"}}, :multi => true)
-      
+
       doc = {"name" => "MyOtherName", "type" => "MyType", "count" => 1, "info" => {"x" => 203, "y" => '102'}}
       coll.update({"_id" => 1}, doc)
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 6
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "update"
     traces[1]['Query'].must_equal "{\"_id\":1}"
-    
+
     validate_event_keys(traces[3], @entry_kvs)
     validate_event_keys(traces[4], @exit_kvs)
 
@@ -246,33 +246,44 @@ describe Oboe::Inst::Mongo do
     traces[3]['QueryOp'].must_equal "update"
     traces[3]['Query'].must_equal "{\"_id\":1}"
   end
-  
+
   it "should trace distinct" do
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.distinct("count")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "distinct"
   end
-  
+
   it "should trace find" do
     coll = @db.collection("testCollection")
+    result = nil
+
+    # Insert a doc to assure we get a result
+    doc = {"name" => "MyName", "type" => "MyType", "count" => 1, "info" => {"x" => 203, "y" => '102'}}
+    id = coll.insert(doc)
+
+    # If given an optional block +find+ will yield a Cursor to that block,
+    # close the cursor, and then return nil. This guarantees that partially
+    # evaluated cursors will be closed. If given no block +find+ returns a
+    # cursor.
+    # https://github.com/mongodb/mongo-ruby-driver/blob/1.10.1/lib/mongo/collection.rb#L178
 
     Oboe::API.start_trace('mongo_test', '', {}) do
-      coll.find(:name => "MyName", :limit => 1)
+      result = coll.find(:name => "MyName", :limit => 1)
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -280,13 +291,48 @@ describe Oboe::Inst::Mongo do
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
 
+    result.wont_match nil
+    result.is_a?(Mongo::Cursor).must_equal true
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "find"
     traces[1].has_key?('Query').must_equal true
     traces[1]['Limit'].must_equal "1"
   end
-  
+
+  it "should trace find (with block)" do
+    coll = @db.collection("testCollection")
+    result = []
+
+    # Insert a doc to assure we get a result
+    doc = {"name" => "MyName", "type" => "MyType", "count" => 1, "info" => {"x" => 203, "y" => '102'}}
+    id = coll.insert(doc)
+
+    # If given an optional block +find+ will yield a Cursor to that block,
+    # close the cursor, and then return nil. This guarantees that partially
+    # evaluated cursors will be closed. If given no block +find+ returns a
+    # cursor.
+    # https://github.com/mongodb/mongo-ruby-driver/blob/1.10.1/lib/mongo/collection.rb#L178
+
+    Oboe::API.start_trace('mongo_test', '', {}) do
+      blk = lambda { |x| x }
+      result = coll.find(:name => "MyName", :limit => 10, &blk)
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'mongo_test')
+    validate_event_keys(traces[1], @entry_kvs)
+    validate_event_keys(traces[2], @exit_kvs)
+
+    result.must_equal nil
+    traces[1]['Collection'].must_equal "testCollection"
+    traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
+    traces[1]['QueryOp'].must_equal "find"
+    traces[1].has_key?('Query').must_equal true
+  end
+
   it "should trace group" do
     coll = @db.collection("testCollection")
 
@@ -296,14 +342,14 @@ describe Oboe::Inst::Mongo do
                   :initial =>  { :count => 0 },
                   :reduce => 'function(obj,prev) { prev.count += obj.c; }')
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "group"
@@ -319,14 +365,14 @@ describe Oboe::Inst::Mongo do
       coll.ensure_index("i")
       coll.drop_index("i_1")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 8
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "create_index"
@@ -345,48 +391,48 @@ describe Oboe::Inst::Mongo do
     traces[5].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[5]['QueryOp'].must_equal "drop_index"
   end
-  
+
   it "should trace drop_indexes" do
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.drop_indexes
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "drop_indexes"
   end
-  
+
   it "should trace index_information" do
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
       coll.index_information
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'mongo_test')
     validate_event_keys(traces[1], @entry_kvs)
     validate_event_keys(traces[2], @exit_kvs)
-    
+
     traces[1]['Collection'].must_equal "testCollection"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:mongo][:collect_backtraces]
     traces[1]['QueryOp'].must_equal "index_information"
   end
-  
+
   it "should obey :collect_backtraces setting when true" do
     Oboe::Config[:mongo][:collect_backtraces] = true
-    
+
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do
@@ -400,7 +446,7 @@ describe Oboe::Inst::Mongo do
 
   it "should obey :collect_backtraces setting when false" do
     Oboe::Config[:mongo][:collect_backtraces] = false
-    
+
     coll = @db.collection("testCollection")
 
     Oboe::API.start_trace('mongo_test', '', {}) do