oboe 2.7.1.7 → 2.7.2.fuchs1

data/lib/oboe/api/memcache.rb

@@ -3,22 +3,24 @@
 
 module Oboe
   module API
+    ##
+    # Utility methods for the Memcache instrumentation
     module Memcache
-      MEMCACHE_OPS = %w{add append cas decr decrement delete fetch get incr increment prepend replace set}
+      MEMCACHE_OPS = %w(add append cas decr decrement delete fetch get incr increment prepend replace set)
 
       def memcache_hit?(result)
         result.nil? ? 0 : 1
       end
 
       def remote_host(key)
-        return unless defined?(Lib.memcached_server_by_key)\
-          and defined?(@struct) and defined?(is_unix_socket?)
+        return unless defined?(Lib.memcached_server_by_key) \
+          && defined?(@struct) && defined?(is_unix_socket?)
 
-        server_as_array = Lib.memcached_server_by_key(@struct, args[0].to_s)
+        server_as_array = Lib.memcached_server_by_key(@struct, key.to_s)
         if server_as_array.is_a?(Array)
           server = server_as_array.first
           if is_unix_socket?(server)
-            return "localhost"
+            return 'localhost'
           elsif defined?(server.hostname)
             return server.hostname
           end

data/lib/oboe/api/profiling.rb

@@ -3,8 +3,9 @@
 
 module Oboe
   module API
+    ##
+    # Module that provides profiling of arbitrary blocks of code
     module Profiling
-
       ##
       # Public: Profile a given block of code. Detect any exceptions thrown by
       # the block and report errors.
@@ -24,8 +25,7 @@ module Oboe
       #   end
       #
       # Returns the result of the block.
-      def profile(profile_name, report_kvs={}, with_backtrace=false)
-
+      def profile(profile_name, report_kvs = {}, with_backtrace = false)
         report_kvs[:Language] ||= :ruby
         report_kvs[:ProfileName] ||= profile_name
         report_kvs[:Backtrace] = Oboe::API.backtrace if with_backtrace
@@ -34,7 +34,7 @@ module Oboe
 
         begin
           yield
-        rescue Exception => e
+        rescue => e
           log_exception(nil, e)
           raise
         ensure

data/lib/oboe/api/tracing.rb

@@ -3,8 +3,9 @@
 
 module Oboe
   module API
+    ##
+    # Provides the higher-level tracing interface for the API.
     module Tracing
-
       # Public: Trace a given block of code. Detect any exceptions thrown by
       # the block and report errors.
       #
@@ -30,7 +31,7 @@ module Oboe
       #   result = computation_with_oboe(1000)
       #
       # Returns the result of the block.
-      def trace(layer, opts={}, protect_op=nil)
+      def trace(layer, opts = {}, protect_op = nil)
         log_entry(layer, opts, protect_op)
         begin
           yield
@@ -73,7 +74,7 @@ module Oboe
       # Returns a list of length two, the first element of which is the result
       # of the block, and the second element of which is the oboe context that
       # was set when the block completed execution.
-      def start_trace(layer, xtrace=nil, opts={})
+      def start_trace(layer, xtrace = nil, opts = {})
         log_start(layer, xtrace, opts)
         begin
           result = yield
@@ -114,7 +115,7 @@ module Oboe
       #   end
       #
       # Returns the result of the block.
-      def start_trace_with_target(layer, xtrace, target, opts={})
+      def start_trace_with_target(layer, xtrace, target, opts = {})
         log_start(layer, xtrace, opts)
         exit_evt = Oboe::Context.createEvent
         begin
@@ -124,7 +125,7 @@ module Oboe
           log_exception(layer, e)
           raise
         ensure
-          exit_evt.addEdge(Oboe::Context.get())
+          exit_evt.addEdge(Oboe::Context.get)
           log_event(layer, 'exit', exit_evt)
           Oboe::Context.clear
         end

data/lib/oboe/api/util.rb

@@ -5,6 +5,8 @@ require 'pp'
 
 module Oboe
   module API
+    ##
+    # General utility methods for the gem
     module Util
       BACKTRACE_CUTOFF = 200
 
@@ -15,7 +17,7 @@ module Oboe
       #
       # Return a boolean indicating whether or not key is reserved.
       def valid_key?(key)
-        !%w[ Label Layer Edge Timestamp Timestamp_u ].include? key.to_s
+        !%w(Label Layer Edge Timestamp Timestamp_u).include? key.to_s
       end
 
       # Internal: Get the current backtrace.
@@ -25,7 +27,9 @@ module Oboe
       #          made.
       #
       # Returns a string with each frame of the backtrace separated by '\r\n'.
-      def backtrace(ignore=1)
+      #
+      # FIXME: ignore is not currently used (see BACKTRACE_CUTOFF)
+      def backtrace(_ignore = 1)
         trim_backtrace(Kernel.caller).join("\r\n")
       end
 
@@ -59,7 +63,7 @@ module Oboe
         # Ensure that the blacklist is an array
         unless Oboe::Config.blacklist.is_a?(Array)
           val = Oboe::Config[:blacklist]
-          Oboe::Config[:blacklist] = [ val.to_s ]
+          Oboe::Config[:blacklist] = [val.to_s]
         end
 
         Oboe::Config.blacklist.each do |h|
@@ -93,25 +97,25 @@ module Oboe
       # Returns a string representation of klass
       def get_class_name(klass)
         kv = {}
+
         if klass.to_s =~ /::/
           klass.class.to_s.rpartition('::').last
         else
-          if klass.is_a?(Class) and klass.is_a?(Module)
+          if klass.is_a?(Class) && klass.is_a?(Module)
             # Class
-            kv["Class"] = klass.to_s
+            kv['Class'] = klass.to_s
 
-          elsif (not klass.is_a?(Class) and not klass.is_a?(Module))
+          elsif (!klass.is_a?(Class) && !klass.is_a?(Module))
             # Class instance
-            kv["Class"] = klass.class.to_s
+            kv['Class'] = klass.class.to_s
 
           else
             # Module
-            kv["Module"] = klass.to_s
+            kv['Module'] = klass.to_s
           end
         end
         kv
       end
-
     end
   end
 end

data/lib/oboe/base.rb

@@ -22,6 +22,10 @@ SAMPLE_SOURCE_MASK = 0b1111000000000000000000000000
 ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
 ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
 
+##
+# This module is the base module for the various implementations of Oboe reporting.
+# Current variations as of 2014-09-10 are a c-extension, JRuby (using TraceView Java
+# instrumentation) and a Heroku c-extension (with embedded tracelyzer)
 module OboeBase
   extend ::Oboe::ThreadLocal
 
@@ -32,7 +36,11 @@ module OboeBase
   thread_local :layer_op
 
   def self.included(cls)
-    self.loaded = true
+    cls.loaded = true
+  end
+
+  def self.extended(cls)
+    cls.loaded = true
   end
 
   def tracing_layer_op?(operation)
@@ -43,26 +51,46 @@ module OboeBase
     end
   end
 
+  ##
+  # Returns true if the tracing_mode is set to always.
+  # False otherwise
+  #
   def always?
-    Oboe::Config[:tracing_mode].to_s == "always"
+    Oboe::Config[:tracing_mode].to_s == 'always'
   end
 
+  ##
+  # Returns true if the tracing_mode is set to never.
+  # False otherwise
+  #
   def never?
-    Oboe::Config[:tracing_mode].to_s == "never"
+    Oboe::Config[:tracing_mode].to_s == 'never'
   end
 
+  ##
+  # Returns true if the tracing_mode is set to always or through.
+  # False otherwise
+  #
   def passthrough?
-    ["always", "through"].include?(Oboe::Config[:tracing_mode])
+    %w(always through).include?(Oboe::Config[:tracing_mode])
   end
 
+  ##
+  # Returns true if the tracing_mode is set to through.
+  # False otherwise
+  #
   def through?
-    Oboe::Config[:tracing_mode] == "through"
+    Oboe::Config[:tracing_mode] == 'through'
   end
 
+  ##
+  # Returns true if we are currently tracing a request
+  # False otherwise
+  #
   def tracing?
     return false unless Oboe.loaded
 
-    Oboe::Context.isValid and not Oboe.never?
+    Oboe::Context.isValid && !Oboe.never?
   end
 
   def log(layer, label, options = {})
@@ -71,31 +99,42 @@ module OboeBase
   end
 
   def heroku?
-    false
+    ENV.key?('TRACEVIEW_URL')
   end
 
+  ##
+  # Determines if we are running under a forking webserver
+  #
   def forking_webserver?
-    (defined?(::Unicorn) and ($0 =~ /unicorn/i)) ? true : false
+    (defined?(::Unicorn) && ($PROGRAM_NAME =~ /unicorn/i)) ? true : false
+  end
+
+  ##
+  # Indicates whether a supported framework is in use
+  # or not
+  #
+  def framework?
+    defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
   end
 
   ##
   # These methods should be implemented by the descendants
   # (Oboe_metal, Oboe_metal (JRuby), Heroku_metal)
   #
-  def sample?(opts = {})
-    raise "sample? should be implemented by metal layer."
+  def sample?(_opts = {})
+    fail 'sample? should be implemented by metal layer.'
   end
 
-  def log(layer, label, options = {})
-    raise "log should be implemented by metal layer."
+  def log(_layer, _label, _options = {})
+    fail 'log should be implemented by metal layer.'
   end
 
-  def set_tracing_mode(mode)
-    raise "set_tracing_mode should be implemented by metal layer."
+  def set_tracing_mode(_mode)
+    fail 'set_tracing_mode should be implemented by metal layer.'
   end
 
-  def set_sample_rate(rate)
-    raise "set_sample_rate should be implemented by metal layer."
+  def set_sample_rate(_rate)
+    fail 'set_sample_rate should be implemented by metal layer.'
   end
 end
 

data/lib/oboe/config.rb

@@ -11,9 +11,9 @@ module Oboe
   module Config
     @@config = {}
 
-    @@instrumentation = [ :action_controller, :action_view, :active_record,
-                          :cassandra, :dalli, :em_http_request, :nethttp, :memcached,
-                          :memcache, :mongo, :moped, :rack, :redis, :resque]
+    @@instrumentation = [:action_controller, :action_view, :active_record,
+                         :cassandra, :dalli, :em_http_request, :faraday, :nethttp, :memcached,
+                         :memcache, :mongo, :moped, :rack, :redis, :resque]
     ##
     # Return the raw nested hash.
     #
@@ -21,7 +21,7 @@ module Oboe
       @@config
     end
 
-    def self.initialize(data={})
+    def self.initialize(_data = {})
       # Setup default instrumentation values
       @@instrumentation.each do |k|
         @@config[k] = {}
@@ -39,6 +39,7 @@ module Oboe
       Oboe::Config[:action_view][:collect_backtraces] = true
       Oboe::Config[:cassandra][:collect_backtraces] = true
       Oboe::Config[:dalli][:collect_backtraces] = false
+      Oboe::Config[:faraday][:collect_backtraces] = false
       Oboe::Config[:em_http_request][:collect_backtraces] = false
       Oboe::Config[:memcache][:collect_backtraces] = false
       Oboe::Config[:memcached][:collect_backtraces] = false
@@ -61,23 +62,23 @@ module Oboe
       @@config[:blacklist] = []
 
       # Access Key is empty until loaded from config file or env var
-      @@config[:access_key] = ""
+      @@config[:access_key] = ''
 
       # 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.
       @@config[:sanitize_sql] = false
 
-      if ENV.has_key?('OPENSHIFT_TRACEVIEW_TLYZER_IP')
+      if ENV.key?('OPENSHIFT_TRACEVIEW_TLYZER_IP')
         # We're running on OpenShift
-        @@config[:tracing_mode] = "always"
+        @@config[:tracing_mode] = 'always'
         @@config[:reporter_host] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_IP']
         @@config[:reporter_port] = ENV['OPENSHIFT_TRACEVIEW_TLYZER_PORT']
       else
         # The default configuration
-        @@config[:tracing_mode] = "through"
-        @@config[:reporter_host] = "127.0.0.1"
-        @@config[:reporter_port] = "7831"
+        @@config[:tracing_mode] = 'through'
+        @@config[:reporter_host] = '127.0.0.1'
+        @@config[:reporter_port] = '7831'
       end
 
       @@config[:verbose] = false
@@ -101,17 +102,18 @@ module Oboe
       @@config[key.to_sym] = value
 
       if key == :sampling_rate
-        Oboe.logger.warn "WARNING: :sampling_rate is not a supported setting for Oboe::Config.  Please use :sample_rate."
+        Oboe.logger.warn 'sampling_rate is not a supported setting for Oboe::Config.  ' \
+                         'Please use :sample_rate.'
       end
 
       if key == :sample_rate
-        unless value.is_a?(Integer) or value.is_a?(Float)
-          raise "oboe :sample_rate must be a number between 1 and 1000000 (1m)"
+        unless value.is_a?(Integer) || value.is_a?(Float)
+          fail 'oboe :sample_rate must be a number between 1 and 1000000 (1m)'
         end
 
         # Validate :sample_rate value
         unless value.between?(1, 1e6)
-          raise "oboe :sample_rate must be between 1 and 1000000 (1m)"
+          fail 'oboe :sample_rate must be between 1 and 1000000 (1m)'
         end
 
         # Assure value is an integer
@@ -134,7 +136,7 @@ module Oboe
       if sym.to_s =~ /(.+)=$/
         self[$1] = args.first
       else
-        unless @@config.has_key?(sym)
+        unless @@config.key?(sym)
           Oboe.logger.warn "[oboe/warn] Unknown method call on Oboe::Config: #{sym}"
         end
         self[sym]

data/lib/oboe/frameworks/padrino.rb

@@ -61,6 +61,4 @@ if defined?(::Padrino)
     # Report __Init after fork when in Heroku
     Oboe::API.report_init unless Oboe.heroku?
   end
-
 end
-

data/lib/oboe/frameworks/padrino/templates.rb

@@ -8,10 +8,8 @@ module Oboe
         ::Oboe::Util.method_alias(klass, :render, ::Padrino::Rendering)
       end
 
-      def render_with_oboe(engine, data=nil, options={}, locals={}, &block)
-        unless Oboe.tracing?
-          render_without_oboe(engine, data, options, locals, &block)
-        else
+      def render_with_oboe(engine, data = nil, options = {}, locals = {}, &block)
+        if Oboe.tracing?
           report_kvs = {}
 
           if data
@@ -32,7 +30,7 @@ module Oboe
               report_kvs[:LineNumber]   = __LINE__
             rescue StandardError => e
               ::Oboe.logger.debug e.message
-              ::Oboe.logger.debug e.backtrace.join(", ")
+              ::Oboe.logger.debug e.backtrace.join(', ')
             end
 
             Oboe::API.profile(report_kvs[:template], report_kvs, false) do
@@ -51,9 +49,10 @@ module Oboe
               ::Oboe::API.log_exit('render', report_kvs)
             end
           end
+        else
+          render_without_oboe(engine, data, options, locals, &block)
         end
       end
     end
   end
 end
-

data/lib/oboe/frameworks/rails.rb

@@ -136,4 +136,3 @@ if defined?(::Rails)
     end
   end
 end
-

data/lib/oboe/frameworks/rails/inst/action_controller.rb

@@ -69,7 +69,7 @@ module Oboe
   end
 end
 
-if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enabled]
+if defined?(ActionController::Base) && Oboe::Config[:action_controller][:enabled]
   if ::Rails::VERSION::MAJOR == 4
 
     class ActionController::Base
@@ -98,8 +98,8 @@ if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enable
 
       def perform_action(*arguments)
         report_kvs = {
-            :Controller  => @_request.path_parameters['controller'],
-            :Action      => @_request.path_parameters['action']
+          :Controller  => @_request.path_parameters['controller'],
+          :Action      => @_request.path_parameters['action']
         }
         Oboe::API.log(nil, 'info', report_kvs)
         perform_action_without_oboe(*arguments)
@@ -117,7 +117,6 @@ if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enable
       end
     end
   end
-  Oboe.logger.info "[oboe/loading] Instrumenting actioncontroler" if Oboe::Config[:verbose]
+  Oboe.logger.info '[oboe/loading] Instrumenting actioncontroler' if Oboe::Config[:verbose]
 end
 # vim:set expandtab:tabstop=2
-