traceview 3.8.1 → 3.8.2

data/lib/traceview/inst/rack.rb

@@ -5,6 +5,19 @@ require 'uri'
 require 'cgi'
 
 module TraceView
+  ##
+  # TraceView::Rack
+  #
+  # The TraceView::Rack middleware used to sample a subset of incoming
+  # requests for instrumentation and reporting.  Tracing context can
+  # be received here (via the X-Trace HTTP header) or initiated here
+  # based on configured tracing mode.
+  #
+  # After the rack layer passes on to the following layers (Rails, Sinatra,
+  # Padrino, Grape), then the instrumentation downstream will
+  # automatically detect whether this is a sampled request or not
+  # and act accordingly. (to instrument or not)
+  #
   class Rack
     attr_reader :app
 
@@ -82,7 +95,7 @@ module TraceView
       # if so and don't clear context on log_end (see traceview/api/logging.rb)
       TraceView.has_incoming_context = TraceView.tracing?
       TraceView.has_xtrace_header = xtrace_header
-      TraceView.is_continued_trace = TraceView.has_incoming_context or TraceView.has_xtrace_header
+      TraceView.is_continued_trace = TraceView.has_incoming_context || TraceView.has_xtrace_header
 
       TraceView::API.log_start(:rack, xtrace_header, report_kvs)
 
@@ -120,4 +133,3 @@ module TraceView
     end
   end
 end
-

data/lib/traceview/inst/redis.rb

@@ -8,7 +8,7 @@ module TraceView
         # The operations listed in this constant skip collecting KVKey
         NO_KEY_OPS = [:keys, :randomkey, :scan, :sdiff, :sdiffstore, :sinter,
                       :sinterstore, :smove, :sunion, :sunionstore, :zinterstore,
-                      :zunionstore, :publish, :select, :eval, :evalsha, :script]
+                      :zunionstore, :publish, :select, :eval, :evalsha, :script].freeze
 
         # Instead of a giant switch statement, we use a hash constant to map out what
         # KVs need to be collected for each of the many many Redis operations
@@ -39,7 +39,7 @@ module TraceView
           :bitop           => { :operation => 1, :destkey     => 2 },
           :hincrbyfloat    => { :field     => 2, :increment   => 3 },
           :zremrangebyrank => { :start     => 2, :stop        => 3 }
-        }
+        }.freeze
 
         # The following operations don't require any special handling. For these,
         # we only collect KVKey and KVOp
@@ -74,108 +74,105 @@ module TraceView
           kvs = {}
           op = command.first
 
-          begin
-            kvs[:KVOp] = command[0]
-            kvs[:RemoteHost] = @options[:host]
+          kvs[:KVOp] = command[0]
+          kvs[:RemoteHost] = @options[:host]
 
-            unless NO_KEY_OPS.include?(op) || (command[1].is_a?(Array) && command[1].count > 1)
-              if command[1].is_a?(Array)
-                kvs[:KVKey] = command[1].first
-              else
-                kvs[:KVKey] = command[1]
-              end
+          unless NO_KEY_OPS.include?(op) || (command[1].is_a?(Array) && command[1].count > 1)
+            if command[1].is_a?(Array)
+              kvs[:KVKey] = command[1].first
+            else
+              kvs[:KVKey] = command[1]
             end
+          end
 
-            if KV_COLLECT_MAP[op]
-              # Extract KVs from command for this op
-              KV_COLLECT_MAP[op].each { |k, v| kvs[k] = command[v] }
-            else
-              # This case statement handle special cases not handled
-              # by KV_COLLECT_MAP
-              case op
-              when :set
-                if command.count > 3
-                  if command[3].is_a?(Hash)
-                    options = command[3]
-                    kvs[:ex] = options[:ex] if options.key?(:ex)
-                    kvs[:px] = options[:px] if options.key?(:px)
-                    kvs[:nx] = options[:nx] if options.key?(:nx)
-                    kvs[:xx] = options[:xx] if options.key?(:xx)
-                  else
-                    options = command[3..-1]
-                    until (opts = options.shift(2)).empty?
-                      case opts[0]
-                      when 'EX' then; kvs[:ex] = opts[1]
-                      when 'PX' then; kvs[:px] = opts[1]
-                      when 'NX' then; kvs[:nx] = opts[1]
-                      when 'XX' then; kvs[:xx] = opts[1]
-                      end
+          if KV_COLLECT_MAP[op]
+            # Extract KVs from command for this op
+            KV_COLLECT_MAP[op].each { |k, v| kvs[k] = command[v] }
+          else
+            # This case statement handle special cases not handled
+            # by KV_COLLECT_MAP
+            case op
+            when :set
+              if command.count > 3
+                if command[3].is_a?(Hash)
+                  options = command[3]
+                  kvs[:ex] = options[:ex] if options.key?(:ex)
+                  kvs[:px] = options[:px] if options.key?(:px)
+                  kvs[:nx] = options[:nx] if options.key?(:nx)
+                  kvs[:xx] = options[:xx] if options.key?(:xx)
+                else
+                  options = command[3..-1]
+                  until (opts = options.shift(2)).empty?
+                    case opts[0]
+                    when 'EX' then; kvs[:ex] = opts[1]
+                    when 'PX' then; kvs[:px] = opts[1]
+                    when 'NX' then; kvs[:nx] = opts[1]
+                    when 'XX' then; kvs[:xx] = opts[1]
                     end
                   end
                 end
+              end
+
+            when :get
+              kvs[:KVHit] = r.nil? ? 0 : 1
 
-              when :get
+            when :hdel, :hexists, :hget, :hset, :hsetnx
+              kvs[:field] = command[2] unless command[2].is_a?(Array)
+              if op == :hget
                 kvs[:KVHit] = r.nil? ? 0 : 1
+              end
 
-              when :hdel, :hexists, :hget, :hset, :hsetnx
-                kvs[:field] = command[2] unless command[2].is_a?(Array)
-                if op == :hget
-                  kvs[:KVHit] = r.nil? ? 0 : 1
-                end
+            when :eval
+              if command[1].length > 1024
+                kvs[:Script] = command[1][0..1023] + '(...snip...)'
+              else
+                kvs[:Script] = command[1]
+              end
 
-              when :eval
+            when :script
+              kvs[:subcommand] = command[1]
+              kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:redis][:collect_backtraces]
+              if command[1] == 'load'
                 if command[1].length > 1024
-                  kvs[:Script] = command[1][0..1023] + '(...snip...)'
+                  kvs[:Script] = command[2][0..1023] + '(...snip...)'
                 else
-                  kvs[:Script] = command[1]
+                  kvs[:Script] = command[2]
                 end
-
-              when :script
-                kvs[:subcommand] = command[1]
-                kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:redis][:collect_backtraces]
-                if command[1] == 'load'
-                  if command[1].length > 1024
-                    kvs[:Script] = command[2][0..1023] + '(...snip...)'
-                  else
-                    kvs[:Script] = command[2]
-                  end
-                elsif command[1] == :exists
-                  if command[2].is_a?(Array)
-                    kvs[:KVKey] = command[2].inspect
-                  else
-                    kvs[:KVKey] = command[2]
-                  end
-                end
-
-              when :mget
-                if command[1].is_a?(Array)
-                  kvs[:KVKeyCount] = command[1].count
+              elsif command[1] == :exists
+                if command[2].is_a?(Array)
+                  kvs[:KVKey] = command[2].inspect
                 else
-                  kvs[:KVKeyCount] = command.count - 1
+                  kvs[:KVKey] = command[2]
                 end
-                values = r.select { |i| i }
-                kvs[:KVHitCount] = values.count
-
-              when :hmget
-                kvs[:KVKeyCount] = command.count - 2
-                values = r.select { |i| i }
-                kvs[:KVHitCount] = values.count
+              end
 
-              when :mset, :msetnx
-                if command[1].is_a?(Array)
-                  kvs[:KVKeyCount] = command[1].count / 2
-                else
-                  kvs[:KVKeyCount] = (command.count - 1) / 2
-                end
-              end # case op
-            end # if KV_COLLECT_MAP[op]
+            when :mget
+              if command[1].is_a?(Array)
+                kvs[:KVKeyCount] = command[1].count
+              else
+                kvs[:KVKeyCount] = command.count - 1
+              end
+              values = r.select { |i| i }
+              kvs[:KVHitCount] = values.count
 
-          rescue StandardError => e
-            TraceView.logger.debug "Error collecting redis KVs: #{e.message}"
-            TraceView.logger.debug e.backtrace.join('\n')
-          end
+            when :hmget
+              kvs[:KVKeyCount] = command.count - 2
+              values = r.select { |i| i }
+              kvs[:KVHitCount] = values.count
 
-          kvs
+            when :mset, :msetnx
+              if command[1].is_a?(Array)
+                kvs[:KVKeyCount] = command[1].count / 2
+              else
+                kvs[:KVKeyCount] = (command.count - 1) / 2
+              end
+            end # case op
+          end # if KV_COLLECT_MAP[op]
+        rescue StandardError => e
+          TraceView.logger.debug "Error collecting redis KVs: #{e.message}"
+          TraceView.logger.debug e.backtrace.join('\n')
+        ensure
+          return kvs
         end
 
         # Extracts the Key/Values to report from a pipelined
@@ -186,33 +183,32 @@ module TraceView
         def extract_pipeline_details(pipeline)
           kvs = {}
 
-          begin
-            kvs[:RemoteHost] = @options[:host]
-            kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:redis][:collect_backtraces]
+          kvs[:RemoteHost] = @options[:host]
+          kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:redis][:collect_backtraces]
 
-            command_count = pipeline.commands.count
-            kvs[:KVOpCount] = command_count
+          command_count = pipeline.commands.count
+          kvs[:KVOpCount] = command_count
 
-            if pipeline.commands.first == :multi
-              kvs[:KVOp] = :multi
-            else
-              kvs[:KVOp] = :pipeline
-            end
+          kvs[:KVOp] = if pipeline.commands.first == :multi
+            :multi
+          else
+            :pipeline
+          end
 
-            # Report pipelined operations  if the number
-            # of ops is reasonable
-            if command_count < 12
-              ops = []
-              pipeline.commands.each do |c|
-                ops << c.first
-              end
-              kvs[:KVOps] = ops.join(', ')
+          # Report pipelined operations  if the number
+          # of ops is reasonable
+          if command_count < 12
+            ops = []
+            pipeline.commands.each do |c|
+              ops << c.first
             end
-          rescue StandardError => e
-            TraceView.logger.debug "[traceview/debug] Error extracting pipelined commands: #{e.message}"
-            TraceView.logger.debug e.backtrace
+            kvs[:KVOps] = ops.join(', ')
           end
-          kvs
+        rescue StandardError => e
+          TraceView.logger.debug "[traceview/debug] Error extracting pipelined commands: #{e.message}"
+          TraceView.logger.debug e.backtrace
+        ensure
+          return kvs
         end
 
         #
@@ -266,7 +262,6 @@ module TraceView
             call_pipeline_without_traceview(pipeline)
           end
         end
-
       end
     end
   end
@@ -278,4 +273,3 @@ if TraceView::Config[:redis][:enabled]
     ::TraceView::Util.send_include(::Redis::Client, ::TraceView::Inst::Redis::Client)
   end
 end
-

data/lib/traceview/inst/sequel.rb

@@ -3,7 +3,19 @@
 
 module TraceView
   module Inst
+    ##
+    # TraceView::Inst::Sequel
+    #
+    # The common (shared) methods used by the TraceView Sequel instrumentation
+    # across multiple modules/classes.
+    #
     module Sequel
+      ##
+      # extract_trace_details
+      #
+      # Given SQL and the options hash, this method extracts the interesting
+      # bits for reporting to the TraceView dashboard.
+      #
       def extract_trace_details(sql, opts)
         kvs = {}
 
@@ -17,7 +29,7 @@ module TraceView
         else
           # Report raw SQL and any binds if they exist
           kvs[:Query] = sql.to_s
-          kvs[:QueryArgs] = opts[:arguments] if opts.is_a?(Hash) and opts.key?(:arguments)
+          kvs[:QueryArgs] = opts[:arguments] if opts.is_a?(Hash) && opts.key?(:arguments)
         end
         kvs[:IsPreparedStatement] = true if sql.is_a?(Symbol)
 
@@ -40,35 +52,43 @@ module TraceView
       ensure
         return kvs
       end
-    end
-
-    module SequelDatabase
-      def self.included(klass)
-        ::TraceView::Util.method_alias(klass, :run, ::Sequel::Database)
-        ::TraceView::Util.method_alias(klass, :execute_ddl, ::Sequel::Database)
-        ::TraceView::Util.method_alias(klass, :execute_dui, ::Sequel::Database)
-        ::TraceView::Util.method_alias(klass, :execute_insert, ::Sequel::Database)
-      end
 
-      def run_with_traceview(sql, opts=::Sequel::OPTS)
+      ##
+      # exec_with_traceview
+      #
+      # This method wraps and routes the call to the specified
+      # original method call
+      #
+      def exec_with_traceview(method, sql, opts = ::Sequel::OPTS, &block)
         kvs = extract_trace_details(sql, opts)
 
         TraceView::API.log_entry(:sequel, kvs)
 
-        run_without_traceview(sql, opts)
+        send(method, sql, opts, &block)
       rescue => e
         TraceView::API.log_exception(:sequel, e)
         raise e
       ensure
         TraceView::API.log_exit(:sequel)
       end
+    end
+
+    module SequelDatabase
+      include TraceView::Inst::Sequel
 
-      def exec_with_traceview(method, sql, opts=::Sequel::OPTS, &block)
+      def self.included(klass)
+        ::TraceView::Util.method_alias(klass, :run, ::Sequel::Database)
+        ::TraceView::Util.method_alias(klass, :execute_ddl, ::Sequel::Database)
+        ::TraceView::Util.method_alias(klass, :execute_dui, ::Sequel::Database)
+        ::TraceView::Util.method_alias(klass, :execute_insert, ::Sequel::Database)
+      end
+
+      def run_with_traceview(sql, opts = ::Sequel::OPTS)
         kvs = extract_trace_details(sql, opts)
 
         TraceView::API.log_entry(:sequel, kvs)
 
-        send(method, sql, opts, &block)
+        run_without_traceview(sql, opts)
       rescue => e
         TraceView::API.log_exception(:sequel, e)
         raise e
@@ -76,7 +96,7 @@ module TraceView
         TraceView::API.log_exit(:sequel)
       end
 
-      def execute_ddl_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_ddl_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         # If we're already tracing a sequel operation, then this call likely came
         # from Sequel::Dataset.  In this case, just pass it on.
         return execute_ddl_without_traceview(sql, opts, &block) if TraceView.tracing_layer?(:sequel)
@@ -84,7 +104,7 @@ module TraceView
         exec_with_traceview(:execute_ddl_without_traceview, sql, opts, &block)
       end
 
-      def execute_dui_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_dui_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         # If we're already tracing a sequel operation, then this call likely came
         # from Sequel::Dataset.  In this case, just pass it on.
         return execute_dui_without_traceview(sql, opts, &block) if TraceView.tracing_layer?(:sequel)
@@ -92,7 +112,7 @@ module TraceView
         exec_with_traceview(:execute_dui_without_traceview, sql, opts, &block)
       end
 
-      def execute_insert_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_insert_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         # If we're already tracing a sequel operation, then this call likely came
         # from Sequel::Dataset.  In this case, just pass it on.
         return execute_insert_without_traceview(sql, opts, &block) if TraceView.tracing_layer?(:sequel)
@@ -102,6 +122,7 @@ module TraceView
     end # module SequelDatabase
 
     module SequelDataset
+      include TraceView::Inst::Sequel
 
       def self.included(klass)
         ::TraceView::Util.method_alias(klass, :execute, ::Sequel::Dataset)
@@ -110,32 +131,19 @@ module TraceView
         ::TraceView::Util.method_alias(klass, :execute_insert, ::Sequel::Dataset)
       end
 
-      def exec_with_traceview(method, sql, opts=::Sequel::OPTS, &block)
-        kvs = extract_trace_details(sql, opts)
-
-        TraceView::API.log_entry(:sequel, kvs)
-
-        send(method, sql, opts, &block)
-      rescue => e
-        TraceView::API.log_exception(:sequel, e)
-        raise e
-      ensure
-        TraceView::API.log_exit(:sequel)
-      end
-
-      def execute_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         exec_with_traceview(:execute_without_traceview, sql, opts, &block)
       end
 
-      def execute_ddl_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_ddl_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         exec_with_traceview(:execute_ddl_without_traceview, sql, opts, &block)
       end
 
-      def execute_dui_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_dui_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         exec_with_traceview(:execute_dui_without_traceview, sql, opts, &block)
       end
 
-      def execute_insert_with_traceview(sql, opts=::Sequel::OPTS, &block)
+      def execute_insert_with_traceview(sql, opts = ::Sequel::OPTS, &block)
         exec_with_traceview(:execute_insert_without_traceview, sql, opts, &block)
       end
 
@@ -144,7 +152,7 @@ module TraceView
 end # module TraceView
 
 if TraceView::Config[:sequel][:enabled]
-  if defined?(::Sequel) && ::Sequel::VERSION < "4.0.0"
+  if defined?(::Sequel) && ::Sequel::VERSION < '4.0.0'
     # For versions before 4.0.0, Sequel::OPTS wasn't defined.
     # Define it as an empty hash for backwards compatibility.
     module ::Sequel
@@ -154,9 +162,7 @@ if TraceView::Config[:sequel][:enabled]
 
   if defined?(::Sequel)
     TraceView.logger.info '[traceview/loading] Instrumenting sequel' if TraceView::Config[:verbose]
-    ::TraceView::Util.send_include(::Sequel::Database, ::TraceView::Inst::Sequel)
     ::TraceView::Util.send_include(::Sequel::Database, ::TraceView::Inst::SequelDatabase)
-    ::TraceView::Util.send_include(::Sequel::Dataset, ::TraceView::Inst::Sequel)
     ::TraceView::Util.send_include(::Sequel::Dataset, ::TraceView::Inst::SequelDataset)
   end
 end