traceview 3.3.3 → 3.4.0

data/lib/traceview/api/memcache.rb

@@ -13,17 +13,18 @@ module TraceView
       end
 
       def remote_host(key)
-        return unless defined?(Lib.memcached_server_by_key) \
-          && defined?(@struct) && 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, key.to_s)
-        if server_as_array.is_a?(Array)
-          server = server_as_array.first
-          if is_unix_socket?(server)
-            return 'localhost'
-          elsif defined?(server.hostname)
-            return server.hostname
-          end
+
+        return unless server_as_array.is_a?(Array)
+
+        server = server_as_array.first
+        if is_unix_socket?(server)
+          'localhost'
+        elsif defined?(server.hostname)
+          server.hostname
         end
       end
     end

data/lib/traceview/api/profiling.rb

@@ -69,13 +69,12 @@ module TraceView
       #   TraceView::API.profile_method(Array, :sort, opts)
       #
       def profile_method(klass, method, opts = {}, extra_kvs = {})
-
         # If we're on an unsupported platform (ahem Mac), just act
         # like we did something to nicely play the no-op part.
         return true unless TraceView.loaded
 
         if RUBY_VERSION < '1.9.3'
-          TraceView.logger.warn "[traceview/error] profile_method: Use the legacy method profiling for Ruby versions before 1.9.3"
+          TraceView.logger.warn '[traceview/error] profile_method: Use the legacy method profiling for Ruby versions before 1.9.3'
           return false
 
         elsif !klass.is_a?(Module)
@@ -110,7 +109,7 @@ module TraceView
 
         # Check if already profiled
         if klass.instance_methods.include?(with_traceview.to_sym) ||
-          klass.singleton_methods.include?(with_traceview.to_sym)
+           klass.singleton_methods.include?(with_traceview.to_sym)
           TraceView.logger.warn "[traceview/error] profile_method: #{klass}::#{method} already profiled."
           TraceView.logger.warn "[traceview/error] profile_method: #{__FILE__}:#{__LINE__}"
           return false
@@ -130,17 +129,17 @@ module TraceView
 
         if instance_method
           klass.class_eval do
-            define_method(with_traceview) { | *args, &block |
+            define_method(with_traceview) do |*args, &block|
               profile_wrapper(without_traceview, report_kvs, opts, *args, &block)
-            }
+            end
 
             alias_method without_traceview, "#{method}"
             alias_method "#{method}", with_traceview
           end
         elsif class_method
-          klass.define_singleton_method(with_traceview) { | *args, &block |
+          klass.define_singleton_method(with_traceview) do |*args, &block|
             profile_wrapper(without_traceview, report_kvs, opts, *args, &block)
-          }
+          end
 
           klass.singleton_class.class_eval do
             alias_method without_traceview, "#{method}"

data/lib/traceview/api/util.rb

@@ -106,7 +106,7 @@ module TraceView
             # Class
             kv['Class'] = klass.to_s
 
-          elsif (!klass.is_a?(Class) && !klass.is_a?(Module))
+          elsif !klass.is_a?(Class) && !klass.is_a?(Module)
             # Class instance
             kv['Class'] = klass.class.to_s
 

data/lib/traceview/base.rb

@@ -75,7 +75,7 @@ module TraceViewBase
 
     # This gives us pretty accessors with questions marks at the end
     # e.g. is_continued_trace --> is_continued_trace?
-    TraceView.methods.select{ |m| m =~ /^is_|^has_/ }.each do |c|
+    TraceView.methods.select { |m| m =~ /^is_|^has_/ }.each do |c|
       unless c =~ /\?$|=$/
         # TraceView.logger.debug "aliasing #{c}? to #{c}"
         alias_method "#{c}?", c
@@ -111,7 +111,7 @@ module TraceViewBase
   # operation tracing or one instrumented operation calling another.
   #
   def tracing_layer?(layer)
-    return TraceView.layer == layer
+    TraceView.layer == layer
   end
 
   ##
@@ -131,6 +131,20 @@ module TraceViewBase
     end
   end
 
+  ##
+  # entry_layer?
+  #
+  # Determines if the passed layer is an entry only
+  # layer where we would want to use smart tracing.
+  #
+  # Entry only layers are layers that _only_ start traces
+  # and doesn't directly receive incoming context such as
+  # DelayedJob or Sidekiq workers.
+  #
+  def entry_layer?(layer)
+    %w(delayed_job-worker).include?(layer.to_s)
+  end
+
   ##
   # Returns true if the tracing_mode is set to always.
   # False otherwise
@@ -160,7 +174,7 @@ module TraceViewBase
   # False otherwise
   #
   def through?
-    TraceView::Config[:tracing_mode] == 'through'
+    TraceView::Config[:tracing_mode].to_s == 'through'
   end
 
   ##
@@ -186,7 +200,7 @@ module TraceViewBase
   #
   def forking_webserver?
     if (defined?(::Unicorn) && ($PROGRAM_NAME =~ /unicorn/i)) ||
-       (defined?(::Puma)    && ($PROGRAM_NAME =~ /puma/i))
+       (defined?(::Puma) && ($PROGRAM_NAME =~ /puma/i))
       true
     else
       false
@@ -199,7 +213,7 @@ module TraceViewBase
   def pry!
     # Only valid for development or test environments
     env = ENV['RACK_ENV'] || ENV['RAILS_ENV']
-    return unless [ "development", "test" ].include? env
+    return unless %w(development, test).include? env
 
     if RUBY_VERSION > '1.8.7'
       require 'pry-byebug'
@@ -210,7 +224,7 @@ module TraceViewBase
         Pry.commands.alias_command 'n', 'next'
         Pry.commands.alias_command 'f', 'finish'
 
-        Pry::Commands.command /^$/, "repeat last command" do
+        Pry::Commands.command /^$/, 'repeat last command' do
           _pry_.run_command Pry.history.to_a.last
         end
       end
@@ -226,7 +240,7 @@ module TraceViewBase
   # or not
   #
   def framework?
-    defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
+    defined?(::Rails) && defined?(::Sinatra) && defined?(::Padrino) && defined?(::Grape)
   end
 
   ##

data/lib/traceview/config.rb

@@ -12,10 +12,12 @@ module TraceView
     @@config = {}
 
     @@instrumentation = [:action_controller, :action_view, :active_record,
-                         :cassandra, :curb, :dalli, :em_http_request, :excon, :faraday,
-                         :grape, :httpclient, :nethttp, :memcached, :memcache, :mongo,
-                         :moped, :rack, :redis, :resqueclient, :resqueworker,
-                         :rest_client, :sequel, :sidekiqclient, :sidekiqworker, :typhoeus]
+                         :cassandra, :curb, :dalli, :delayed_jobclient,
+                         :delayed_jobworker, :em_http_request, :excon,
+                         :faraday, :grape, :httpclient, :nethttp, :memcached,
+                         :memcache, :mongo, :moped, :rack, :redis, :resqueclient,
+                         :resqueworker, :rest_client, :sequel, :sidekiqclient,
+                         :sidekiqworker, :typhoeus]
 
     # Subgrouping of instrumentation
     @@http_clients = [:curb, :excon, :em_http_request, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
@@ -46,6 +48,8 @@ module TraceView
       TraceView::Config[:cassandra][:collect_backtraces] = true
       TraceView::Config[:curb][:collect_backtraces] = true
       TraceView::Config[:dalli][:collect_backtraces] = false
+      TraceView::Config[:delayed_jobclient][:collect_backtraces] = false
+      TraceView::Config[:delayed_jobworker][:collect_backtraces] = false
       TraceView::Config[:em_http_request][:collect_backtraces] = false
       TraceView::Config[:excon][:collect_backtraces] = true
       TraceView::Config[:faraday][:collect_backtraces] = false

data/lib/traceview/frameworks/padrino.rb

@@ -22,7 +22,7 @@ module TraceView
             r = dispatch_without_traceview
 
             # Report Controller/Action as best possible
-            if request.controller and not request.controller.empty?
+            if request.controller && !request.controller.empty?
               report_kvs[:Controller] = request.controller
             else
               report_kvs[:Controller] = self.class
@@ -44,7 +44,7 @@ end
 if defined?(::Padrino)
   # This instrumentation is a superset of the Sinatra instrumentation similar
   # to how Padrino is a superset of Sinatra itself.
-  ::TraceView.logger.info "[traceview/loading] Instrumenting Padrino" if TraceView::Config[:verbose]
+  ::TraceView.logger.info '[traceview/loading] Instrumenting Padrino' if TraceView::Config[:verbose]
 
   require 'traceview/frameworks/padrino/templates'
 

data/lib/traceview/frameworks/rails.rb

@@ -11,34 +11,30 @@ module TraceView
       @@rum_ftr_tmpl = File.read(File.dirname(__FILE__) + '/rails/helpers/rum/rum_footer.js.erb')
 
       def traceview_rum_header
-        begin
-          return unless TraceView::Config.rum_id
-          if TraceView.tracing?
-            if request.xhr?
-              return raw(ERB.new(@@rum_xhr_tmpl).result)
-            else
-              return raw(ERB.new(@@rum_hdr_tmpl).result)
-            end
+        return unless TraceView::Config.rum_id
+        if TraceView.tracing?
+          if request.xhr?
+            return raw(ERB.new(@@rum_xhr_tmpl).result)
+          else
+            return raw(ERB.new(@@rum_hdr_tmpl).result)
           end
-        rescue StandardError => e
-          TraceView.logger.warn "traceview_rum_header: #{e.message}."
-          return ""
         end
+      rescue StandardError => e
+        TraceView.logger.warn "traceview_rum_header: #{e.message}."
+        return ''
       end
       alias_method :oboe_rum_header, :traceview_rum_header
 
       def traceview_rum_footer
-        begin
-          return unless TraceView::Config.rum_id
-          if TraceView.tracing?
-            # Even though the footer template is named xxxx.erb, there are no ERB tags in it so we'll
-            # skip that step for now
-            return raw(@@rum_ftr_tmpl)
-          end
-        rescue StandardError => e
-          TraceView.logger.warn "traceview_rum_footer: #{e.message}."
-          return ""
+        return unless TraceView::Config.rum_id
+        if TraceView.tracing?
+          # Even though the footer template is named xxxx.erb, there are no ERB tags in it so we'll
+          # skip that step for now
+          return raw(@@rum_ftr_tmpl)
         end
+      rescue StandardError => e
+        TraceView.logger.warn "traceview_rum_footer: #{e.message}."
+        return ''
       end
       alias_method :oboe_rum_footer, :traceview_rum_footer
     end # Helpers
@@ -47,7 +43,7 @@ module TraceView
       # Force load the TraceView Rails initializer if there is one
       # Prefer traceview.rb but give priority to the legacy tracelytics.rb if it exists
       if ::Rails::VERSION::MAJOR > 2
-        rails_root = "#{::Rails.root.to_s}"
+        rails_root = "#{::Rails.root}"
       else
         rails_root = "#{RAILS_ROOT}"
       end
@@ -55,16 +51,16 @@ module TraceView
       #
       # We've been through 3 initializer names.  Try each one.
       #
-      if File.exists?("#{rails_root}/config/initializers/tracelytics.rb")
+      if File.exist?("#{rails_root}/config/initializers/tracelytics.rb")
         tr_initializer = "#{rails_root}/config/initializers/tracelytics.rb"
 
-      elsif File.exists?("#{rails_root}/config/initializers/oboe.rb")
+      elsif File.exist?("#{rails_root}/config/initializers/oboe.rb")
         tr_initializer = "#{rails_root}/config/initializers/oboe.rb"
 
       else
         tr_initializer = "#{rails_root}/config/initializers/traceview.rb"
       end
-      require tr_initializer if File.exists?(tr_initializer)
+      require tr_initializer if File.exist?(tr_initializer)
     end
 
     def self.load_instrumentation
@@ -94,7 +90,6 @@ module TraceView
         ActionView::Base.send :include, TraceView::Rails::Helpers
       end
     end
-
   end # Rails
 end # TraceView
 
@@ -104,18 +99,17 @@ if defined?(::Rails)
   if ::Rails::VERSION::MAJOR > 2
     module TraceView
       class Railtie < ::Rails::Railtie
-
         initializer 'traceview.helpers' do
           TraceView::Rails.include_helpers
         end
 
         initializer 'traceview.rack' do |app|
-          TraceView.logger.info "[traceview/loading] Instrumenting rack" if TraceView::Config[:verbose]
-          app.config.middleware.insert 0, "TraceView::Rack"
+          TraceView.logger.info '[traceview/loading] Instrumenting rack' if TraceView::Config[:verbose]
+          app.config.middleware.insert 0, 'TraceView::Rack'
         end
 
         config.after_initialize do
-          TraceView.logger = ::Rails.logger if ::Rails.logger
+          TraceView.logger = ::Rails.logger if ::Rails.logger && !ENV.key?('TRACEVIEW_GEM_TEST')
 
           TraceView::Loading.load_access_key
           TraceView::Inst.load_instrumentation
@@ -133,8 +127,8 @@ if defined?(::Rails)
     TraceView::Loading.load_access_key
 
     Rails.configuration.after_initialize do
-      TraceView.logger.info "[traceview/loading] Instrumenting rack" if TraceView::Config[:verbose]
-      Rails.configuration.middleware.insert 0, "TraceView::Rack"
+      TraceView.logger.info '[traceview/loading] Instrumenting rack' if TraceView::Config[:verbose]
+      Rails.configuration.middleware.insert 0, 'TraceView::Rack'
 
       TraceView::Inst.load_instrumentation
       TraceView::Rails.load_instrumentation

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

@@ -19,12 +19,12 @@ module TraceView
       def has_handler?(exception)
         # Don't log exceptions if they have a rescue handler set
         has_handler = false
-        rescue_handlers.detect { | klass_name, handler |
+        rescue_handlers.detect do |klass_name, _handler|
           # Rescue handlers can be specified as strings or constant names
           klass = self.class.const_get(klass_name) rescue nil
           klass ||= klass_name.constantize rescue nil
           has_handler = exception.is_a?(klass) if klass
-        }
+        end
         has_handler
       rescue => e
         TraceView.logger.debug "[traceview/debug] Error searching Rails handlers: #{e.message}"
@@ -101,7 +101,7 @@ module TraceView
       def process_action_with_traceview(*args)
         report_kvs = {
           :Controller   => self.class.name,
-          :Action       => self.action_name,
+          :Action       => action_name,
         }
         TraceView::API.log(nil, 'info', report_kvs)
 

data/lib/traceview/frameworks/rails/inst/action_view.rb

@@ -23,7 +23,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
           entry_kvs[:Module]       = :ActionView
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
-        rescue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
         TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do
@@ -41,7 +42,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
           entry_kvs[:Module]       = :ActionView
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
-        rescue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
         TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do

data/lib/traceview/frameworks/rails/inst/action_view_2x.rb

@@ -19,7 +19,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
             entry_kvs[:Module]       = :ActionView
             entry_kvs[:File]         = __FILE__
             entry_kvs[:LineNumber]   = __LINE__
-          rescue
+          rescue => e
+            TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
           end
 
           TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do
@@ -40,7 +41,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
           entry_kvs[:Module]       = :ActionView
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
-        rescue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
         TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do

data/lib/traceview/frameworks/rails/inst/action_view_30.rb

@@ -16,7 +16,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
           entry_kvs[:Module]       = 'ActionView::Partials'
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
-        rescue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
         TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do
@@ -34,7 +35,8 @@ if defined?(ActionView::Base) && TraceView::Config[:action_view][:enabled]
           entry_kvs[:Module]       = 'ActionView::Partials'
           entry_kvs[:File]         = __FILE__
           entry_kvs[:LineNumber]   = __LINE__
-        rescue
+        rescue => e
+          TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
         TraceView::API.profile(name, entry_kvs, TraceView::Config[:action_view][:collect_backtraces]) do

data/lib/traceview/frameworks/rails/inst/connection_adapters/utils.rb

@@ -28,9 +28,9 @@ module TraceView
               config = ::Rails.application.config.database_configuration[::Rails.env]
             end
 
-            opts[:Database]   = config['database'] if config.key?('database')
-            opts[:RemoteHost] = config['host']     if config.key?('host')
-            opts[:Flavor]     = config['adapter']  if config.key?('adapter')
+            opts[:Database]   = config['database'] if config && config.key?('database')
+            opts[:RemoteHost] = config['host']     if config && config.key?('host')
+            opts[:Flavor]     = config['adapter']  if config && config.key?('adapter')
           rescue StandardError => e
             TraceView.logger.debug "Exception raised capturing ActiveRecord KVs: #{e.inspect}"
             TraceView.logger.debug e.backtrace.join('\n')

data/lib/traceview/frameworks/sinatra.rb

@@ -85,7 +85,7 @@ if defined?(::Sinatra)
 
   # When in the gem TEST environment, we load this instrumentation regardless.
   # Otherwise, only when Padrino isn't around.
-  unless defined?(::Padrino) and not (ENV.key?('TRACEVIEW_GEM_TEST'))
+  unless defined?(::Padrino) && !ENV.key?('TRACEVIEW_GEM_TEST')
     # Padrino has 'enhanced' routes and rendering so the Sinatra
     # instrumentation won't work anyways.  Only load for pure Sinatra apps.
     ::TraceView::Util.send_include(::Sinatra::Base,      ::TraceView::Sinatra::Base)

data/lib/traceview/frameworks/sinatra/templates.rb

@@ -27,7 +27,7 @@ module TraceView
               report_kvs[:LineNumber]   = __LINE__
             rescue StandardError => e
               ::TraceView.logger.debug e.message
-              ::TraceView.logger.debug e.backtrace.join(", ")
+              ::TraceView.logger.debug e.backtrace.join(', ')
             end
 
             TraceView::API.profile(name, report_kvs, false) do