oboe 2.6.5.5 → 2.6.6.1

data/lib/oboe/instrumentation.rb

@@ -10,7 +10,7 @@ module Oboe
         begin
           require f
         rescue => e
-          Oboe.logger.error "[oboe/loading] Error loading insrumentation file '#{f}' : #{e}"
+          Oboe.logger.error "[oboe/loading] Error loading instrumentation file '#{f}' : #{e}"
         end
       end
     end

data/lib/oboe/util.rb

@@ -4,13 +4,7 @@
 module Oboe
   module Util
     class << self
-      ##
-      # method_alias
-      #
-      # Centralized utility method to alias a method on an arbitrary
-      # class or module.
-      #
-      def method_alias(cls, method, name=nil)
+      def contextual_name(cls)
         # Attempt to infer a contextual name if not indicated
         #
         # For example:
@@ -18,21 +12,31 @@ module Oboe
         # => "AbstractMysqlAdapter"
         #
         begin
-          name ||= cls.to_s.split(/::/).last 
+          cls.to_s.split(/::/).last
         rescue
         end
+      end
+
+      ##
+      # method_alias
+      #
+      # Centralized utility method to alias a method on an arbitrary
+      # class or module.
+      #
+      def method_alias(cls, method, name=nil)
+        name ||= contextual_name(cls)
 
         if cls.method_defined? method.to_sym or cls.private_method_defined? method.to_sym
-          
+
           # Strip '!' or '?' from method if present
           safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
           safe_method_name ||= method
 
           without_oboe = "#{safe_method_name}_without_oboe"
           with_oboe    = "#{safe_method_name}_with_oboe"
-       
+
           # Only alias if we haven't done so already
-          unless cls.method_defined? without_oboe.to_sym or 
+          unless cls.method_defined? without_oboe.to_sym or
             cls.private_method_defined? without_oboe.to_sym
 
             cls.class_eval do
@@ -43,7 +47,45 @@ module Oboe
         else Oboe.logger.warn "[oboe/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
         end
       end
-  
+
+      ##
+      # class_method_alias
+      #
+      # Centralized utility method to alias a class method on an arbitrary
+      # class or module
+      #
+      def class_method_alias(cls, method, name=nil)
+        name ||= contextual_name(cls)
+
+        if cls.singleton_methods.include? method.to_sym
+
+          # Strip '!' or '?' from method if present
+          safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+          safe_method_name ||= method
+
+          without_oboe = "#{safe_method_name}_without_oboe"
+          with_oboe    = "#{safe_method_name}_with_oboe"
+
+          # Only alias if we haven't done so already
+          unless cls.singleton_methods.include? without_oboe.to_sym
+            cls.singleton_class.send(:alias_method, without_oboe, "#{method}")
+            cls.singleton_class.send(:alias_method, "#{method}", with_oboe)
+          end
+        else Oboe.logger.warn "[oboe/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
+        end
+      end
+
+      ##
+      # send_extend
+      #
+      # Centralized utility method to send an extend call for an
+      # arbitrary class
+      def send_extend(target_cls, cls)
+        if defined?(target_cls)
+          target_cls.send(:extend, cls)
+        end
+      end
+
       ##
       # send_include
       #

data/lib/oboe/version.rb

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

data/lib/oboe_metal.rb

@@ -56,7 +56,7 @@ module Oboe_metal
 
         # 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)
+        unless defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
           Oboe::API.report_init
         end
 

data/lib/rails/generators/oboe/install_generator.rb

@@ -22,7 +22,7 @@ module Oboe
 
         break if user_tracing_mode.blank?
         valid = ['always', 'through', 'never'].include?(user_tracing_mode)
-        
+
         say shell.set_color "Valid values are 'always', 'through' or 'never'", :red, :bold unless valid
         if valid
           @tracing_mode = user_tracing_mode
@@ -47,10 +47,10 @@ module Oboe
         say "-------------------"
         say ""
         say "Details on configuring your sample rate:"
-        say "http://support.tv.appneta.com/support/solutions/articles/86336-configuring-sampling"
+        say "https://support.appneta.com/cloud/configuring-sampling"
         say ""
         say "More information on instrumenting Ruby applications can be found here:"
-        say "http://support.tv.appneta.com/support/solutions/articles/86393-instrumenting-ruby-apps"
+        say "https://support.appneta.com/cloud/installing-ruby-instrumentation"
       end
 
       def print_body

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

@@ -2,22 +2,22 @@
 # http://www.appneta.com/products/traceview/
 #
 # Details on configuring your sample rate:
-# http://support.tv.appneta.com/support/solutions/articles/86336
+# https://support.appneta.com/cloud/configuring-sampling
 #
 # More information on instrumenting Ruby applications can be found here:
-# http://support.tv.appneta.com/support/solutions/articles/86393
+# https://support.appneta.com/cloud/installing-ruby-instrumentation
 
-if defined?(Oboe::Config) 
+if defined?(Oboe::Config)
   # Tracing Mode determines when traces should be initiated for incoming requests.  Valid
   # options are always, through (when using an instrumented Apache or Nginx) and never.
   #
   # If you're not using an instrumented Apache or Nginx, set this directive to always in
   # order to initiate tracing from Ruby.
   Oboe::Config[:tracing_mode] = '<%= @tracing_mode %>'
-  
+
   # sample_rate is a value from 0 - 1m indicating the fraction of requests per million to trace
   # Oboe::Config[:sample_rate] = <%= @sample_rate %>
-  
+
   # Verbose output of instrumentation initialization
   # Oboe::Config[:verbose] = <%= @verbose %>
 
@@ -25,8 +25,8 @@ if defined?(Oboe::Config)
   # Resque Options
   #
   # :link_workers - associates Resque enqueue operations with the jobs they queue by piggybacking
-  #                 an additional argument on the Redis queue that is stripped prior to job 
-  #                 processing 
+  #                 an additional argument on the Redis queue that is stripped prior to job
+  #                 processing
   #                 !!! Note: Make sure both the enqueue side and the Resque workers are instrumented
   #                 before enabling this or jobs will fail !!!
   #                 (Default: false)
@@ -34,7 +34,7 @@ if defined?(Oboe::Config)
   #
   # Set to true to disable Resque argument logging (Default: false)
   # Oboe::Config[:resque][:log_args] = false
- 
+
   # The oboe Ruby client has the ability to sanitize query literals
   # from SQL statements.  By default this is disabled.  Enable to
   # avoid collecting and reporting query literals to TraceView.
@@ -59,14 +59,14 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:enabled] = true
   # Oboe::Config[:redis][:enabled] = true
   # Oboe::Config[:resque][:enabled] = true
-  
+
   #
   # Enabling/Disabling Backtrace Collection
   #
   # Instrumentation can optionally collect backtraces as they collect
   # performance metrics.  Note that this has a negative impact on
   # performance but can be useful when trying to locate the source of
-  # a certain call or operation.  
+  # a certain call or operation.
   #
   # Oboe::Config[:action_controller][:collect_backtraces] = true
   # Oboe::Config[:active_record][:collect_backtraces] = true

data/test/frameworks/apps/grape_simple.rb

@@ -0,0 +1,12 @@
+require 'grape'
+
+class GrapeSimple < Grape::API
+  set :reload, true
+  
+  get '/json_endpoint' do
+    present({ :test => true })
+  end
+end
+
+use GrapeSimple
+

data/test/frameworks/grape_test.rb

@@ -0,0 +1,27 @@
+if RUBY_VERSION >= '1.9.3'
+  require 'minitest_helper'
+  require File.expand_path(File.dirname(__FILE__) + '/apps/grape_simple')
+
+  describe Grape do
+    before do
+      clear_all_traces
+    end
+
+    it "should trace a request to a simple grape stack" do
+      @app = GrapeSimple
+
+      r = get "/json_endpoint"
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      validate_outer_layers(traces, 'rack')
+
+      traces[1]['Layer'].must_equal "grape"
+      traces[2]['Layer'].must_equal "grape"
+      traces[2].has_key?('Controller').must_equal true
+      traces[2].has_key?('Action').must_equal true
+      traces[3]['Label'].must_equal "info"
+    end
+  end
+end

data/test/instrumentation/dalli_test.rb

@@ -2,7 +2,7 @@ require 'minitest_helper'
 
 describe Oboe::Inst::Dalli do
   before do
-    clear_all_traces 
+    clear_all_traces
     @dc = Dalli::Client.new
     @collect_backtraces = Oboe::Config[:dalli][:collect_backtraces]
   end
@@ -12,7 +12,7 @@ describe Oboe::Inst::Dalli do
   end
 
   it 'Stock Dalli should be loaded, defined and ready' do
-    defined?(::Dalli).wont_match nil 
+    defined?(::Dalli).wont_match nil
     defined?(::Dalli::Client).wont_match nil
   end
 
@@ -24,11 +24,11 @@ describe Oboe::Inst::Dalli do
 
   it 'should trace set' do
     Oboe::API.start_trace('dalli_test', '', {}) do
-      @dc.get('some_key')
+      @dc.set('some_key', 1234)
     end
 
     traces = get_all_traces
-    traces.count.must_equal 5
+    traces.count.must_equal 4
 
     validate_outer_layers(traces, 'dalli_test')
 
@@ -36,37 +36,35 @@ describe Oboe::Inst::Dalli do
     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
 
   it 'should trace get' do
     Oboe::API.start_trace('dalli_test', '', {}) do
-      @dc.set('some_key', 1)
+      @dc.get('some_key')
     end
-    
+
     traces = get_all_traces
-    traces.count.must_equal 4
-    
+    traces.count.must_equal 5
+
     validate_outer_layers(traces, 'dalli_test')
 
-    traces[1]['KVOp'].must_equal "set"
+    traces[1]['KVOp'].must_equal "get"
     traces[1]['KVKey'].must_equal "some_key"
-    traces[2]['Label'].must_equal "exit"
+    traces[2]['Label'].must_equal "info"
+    traces[2].has_key?('KVHit').must_equal true
+    traces[3]['Label'].must_equal "exit"
   end
 
   it 'should trace get_multi' do
     Oboe::API.start_trace('dalli_test', '', {}) do
       @dc.get_multi([:one, :two, :three, :four, :five, :six])
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 5
-    
+
     validate_outer_layers(traces, 'dalli_test')
-    
+
     traces[1]['KVOp'].must_equal "get_multi"
     traces[2]['Label'].must_equal "info"
     traces[2].has_key?('KVKeyCount').must_equal true
@@ -75,55 +73,63 @@ describe Oboe::Inst::Dalli do
   end
 
   it "should trace increment" do
+    @dc.incr("dalli_key_counter", 1, nil, 0)
+
     Oboe::API.start_trace('dalli_test', '', {}) do
-      @dc.incr("some_key_counter", 1, nil, 0)
+      @dc.incr("dalli_key_counter")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
-    
+
     validate_outer_layers(traces, 'dalli_test')
 
     traces[1]['KVOp'].must_equal "incr"
-    traces[1]['KVKey'].must_equal "some_key_counter"
+    traces[1]['KVKey'].must_equal "dalli_key_counter"
     traces[2]['Label'].must_equal "exit"
   end
 
   it "should trace decrement" do
+    @dc.incr("dalli_key_counter", 1, nil, 0)
+
     Oboe::API.start_trace('dalli_test', '', {}) do
-      @dc.decr("some_key_counter", 1, nil, 0)
+      @dc.decr("dalli_key_counter")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
-    
+
     validate_outer_layers(traces, 'dalli_test')
 
     traces[1]['KVOp'].must_equal "decr"
-    traces[1]['KVKey'].must_equal "some_key_counter"
+    traces[1]['KVKey'].must_equal "dalli_key_counter"
     traces[2]['Label'].must_equal "exit"
   end
 
   it "should trace replace" do
+    @dc.set('some_key', 1)
+
     Oboe::API.start_trace('dalli_test', '', {}) do
       @dc.replace("some_key", "woop")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
     validate_outer_layers(traces, 'dalli_test')
-    
+
     traces[1]['KVOp'].must_equal "replace"
     traces[1]['KVKey'].must_equal "some_key"
     traces[2]['Label'].must_equal "exit"
   end
 
   it "should trace delete" do
+    @dc.set('some_key', 1)
+
     Oboe::API.start_trace('dalli_test', '', {}) do
       @dc.delete("some_key")
     end
-    
+
     traces = get_all_traces
     traces.count.must_equal 4
 
@@ -132,8 +138,9 @@ describe Oboe::Inst::Dalli do
     traces[1]['KVOp'].must_equal "delete"
     traces[1]['KVKey'].must_equal "some_key"
   end
-  
+
   it "should obey :collect_backtraces setting when true" do
+    @dc.set('some_key', 1)
     Oboe::Config[:dalli][:collect_backtraces] = true
 
     Oboe::API.start_trace('dalli_test', '', {}) do

data/test/instrumentation/memcache_test.rb

@@ -3,7 +3,7 @@ require 'memcache'
 
 describe Oboe::API::Memcache do
   before do
-    clear_all_traces 
+    clear_all_traces
     @mc = ::MemCache.new('localhost')
 
     # These are standard entry/exit KVs that are passed up with all mongo operations
@@ -24,57 +24,57 @@ describe Oboe::API::Memcache do
   end
 
   it 'Stock MemCache should be loaded, defined and ready' do
-    defined?(::MemCache).wont_match nil 
+    defined?(::MemCache).wont_match nil
   end
 
   it 'MemCache should have oboe methods defined' do
     Oboe::API::Memcache::MEMCACHE_OPS.each do |m|
       if ::MemCache.method_defined?(m)
-        ::MemCache.method_defined?("#{m}_with_oboe").must_equal true 
+        ::MemCache.method_defined?("#{m}_with_oboe").must_equal true
       end
-      ::MemCache.method_defined?(:request_setup_with_oboe).must_equal true 
-      ::MemCache.method_defined?(:cache_get_with_oboe).must_equal true 
-      ::MemCache.method_defined?(:get_multi_with_oboe).must_equal true 
+      ::MemCache.method_defined?(:request_setup_with_oboe).must_equal true
+      ::MemCache.method_defined?(:cache_get_with_oboe).must_equal true
+      ::MemCache.method_defined?(:get_multi_with_oboe).must_equal true
     end
   end
-  
+
   it "should trace set" do
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.set('msg', 'blah')
     end
-    
+
     traces = get_all_traces
 
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "set"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[2], @info_kvs)
     traces[2]['KVKey'].must_equal "msg"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
 
     validate_event_keys(traces[3], @exit_kvs)
   end
-  
+
   it "should trace get" do
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.get('msg')
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 6
     validate_outer_layers(traces, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "get"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[2], @info_kvs)
     traces[2]['KVKey'].must_equal "msg"
     traces[2]['RemoteHost'].must_equal "localhost"
@@ -85,21 +85,21 @@ describe Oboe::API::Memcache do
 
     validate_event_keys(traces[4], @exit_kvs)
   end
-  
+
   it "should trace get_multi" do
     Oboe::API.start_trace('memcache_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, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "get_multi"
-    
+
     validate_event_keys(traces[2], @info_kvs)
     traces[2]['KVKeyCount'].must_equal "6"
     traces[2].has_key?('KVHitCount').must_equal true
@@ -107,88 +107,88 @@ describe Oboe::API::Memcache do
 
     validate_event_keys(traces[3], @exit_kvs)
   end
-    
+
   it "should trace add for existing key" do
     @mc.set('testKey', 'x', 1200)
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.add('testKey', 'x', 1200)
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "add"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[2], @info_kvs)
     traces[2]['KVKey'].must_equal "testKey"
-    
+
     validate_event_keys(traces[3], @exit_kvs)
   end
-  
+
   it "should trace append" do
     @mc.set('rawKey', "Peanut Butter ", 600, :raw => true)
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.append('rawKey', "Jelly")
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "append"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[2], @info_kvs)
-    
+
     traces[2]['KVKey'].must_equal "rawKey"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[3], @exit_kvs)
   end
-  
-  it "should trace decr" do
+
+  it "should trace decrement" do
     Oboe::API.start_trace('memcache_test', '', {}) do
-      @mc.decr('some_key_counter', 1)
+      @mc.decr('memcache_key_counter', 1)
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
     validate_event_keys(traces[1], @entry_kvs)
-    
+
     traces[1]['KVOp'].must_equal "decr"
     traces[1].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
-    traces[2]['KVKey'].must_equal "some_key_counter"
+
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
-    
+
     validate_event_keys(traces[3], @exit_kvs)
   end
 
   it "should trace increment" do
     Oboe::API.start_trace('memcache_test', '', {}) do
-      @mc.incr("some_key_counter", 1)
+      @mc.incr("memcache_key_counter", 1)
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
-    
+
     validate_event_keys(traces[1], @entry_kvs)
     traces[1]['KVOp'].must_equal "incr"
     validate_event_keys(traces[2], @info_kvs)
-    traces[2]['KVKey'].must_equal "some_key_counter"
+    traces[2]['KVKey'].must_equal "memcache_key_counter"
     validate_event_keys(traces[3], @exit_kvs)
   end
 
@@ -197,9 +197,9 @@ describe Oboe::API::Memcache do
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.replace("some_key", "woop")
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
@@ -214,9 +214,9 @@ describe Oboe::API::Memcache do
     Oboe::API.start_trace('memcache_test', '', {}) do
       @mc.delete("some_key")
     end
-    
+
     traces = get_all_traces
-    
+
     traces.count.must_equal 5
     validate_outer_layers(traces, 'memcache_test')
 
@@ -226,7 +226,7 @@ describe Oboe::API::Memcache do
     validate_event_keys(traces[2], @info_kvs)
     validate_event_keys(traces[3], @exit_kvs)
   end
-    
+
   it "should obey :collect_backtraces setting when true" do
     Oboe::Config[:memcache][:collect_backtraces] = true