appoptics_apm_mnfst 4.5.2

data/lib/appoptics_apm/inst/rack.rb

@@ -0,0 +1,199 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'uri'
+require 'cgi'
+
+if AppOpticsAPM.loaded
+  module AppOpticsAPM
+    ##
+    # AppOpticsAPM::Rack
+    #
+    # The AppOpticsAPM::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
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        # In the case of nested Ruby apps such as Grape inside of Rails
+        # or Grape inside of Grape, each app has it's own instance
+        # of rack middleware.  We avoid tracing rack more than once and
+        # instead start instrumenting from the first rack pass.
+        return call_app(env) if AppOpticsAPM.tracing? && AppOpticsAPM.layer == :rack
+
+        # if we already have a context, we don't want to send metrics in the end
+        return sampling_call(env) if AppOpticsAPM::Context.isValid
+
+        # else we also send metrics
+        metrics_sampling_call(env)
+      end
+
+      def self.noop?
+        false
+      end
+
+      private
+
+      def collect(req, env)
+        report_kvs = {}
+
+        begin
+          report_kvs[:'HTTP-Host']      = req.host
+          report_kvs[:Port]             = req.port
+          report_kvs[:Proto]            = req.scheme
+          report_kvs[:Method]           = req.request_method
+          report_kvs[:AJAX]             = true if req.xhr?
+          report_kvs[:ClientIP]         = req.ip
+
+          if AppOpticsAPM::Config[:rack][:log_args]
+            report_kvs[:'Query-String'] = ::CGI.unescape(req.query_string) unless req.query_string.empty?
+          end
+
+          report_kvs[:Backtrace]        = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:rack][:collect_backtraces]
+
+          # Report any request queue'ing headers.  Report as 'Request-Start' or the summed Queue-Time
+          report_kvs[:'Request-Start']     = env['HTTP_X_REQUEST_START']    if env.key?('HTTP_X_REQUEST_START')
+          report_kvs[:'Request-Start']     = env['HTTP_X_QUEUE_START']      if env.key?('HTTP_X_QUEUE_START')
+          report_kvs[:'Queue-Time']        = env['HTTP_X_QUEUE_TIME']       if env.key?('HTTP_X_QUEUE_TIME')
+
+          report_kvs[:'Forwarded-For']     = env['HTTP_X_FORWARDED_FOR']    if env.key?('HTTP_X_FORWARDED_FOR')
+          report_kvs[:'Forwarded-Host']    = env['HTTP_X_FORWARDED_HOST']   if env.key?('HTTP_X_FORWARDED_HOST')
+          report_kvs[:'Forwarded-Proto']   = env['HTTP_X_FORWARDED_PROTO']  if env.key?('HTTP_X_FORWARDED_PROTO')
+          report_kvs[:'Forwarded-Port']    = env['HTTP_X_FORWARDED_PORT']   if env.key?('HTTP_X_FORWARDED_PORT')
+
+          report_kvs[:'Ruby.AppOptics.Version'] = AppOpticsAPM::Version::STRING
+          report_kvs[:ProcessID]         = Process.pid
+          report_kvs[:ThreadID]          = Thread.current.to_s[/0x\w*/]
+        rescue StandardError => e
+          # Discard any potential exceptions. Debug log and report whatever we can.
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] Rack KV collection error: #{e.inspect}"
+        end
+        report_kvs
+      end
+
+      def call_app(env)
+        AppOpticsAPM.logger.debug "[appoptics_apm/rack] Rack skipped!"
+        @app.call(env)
+      end
+
+      # in this case we have an existing context
+      def sampling_call(env)
+        req = ::Rack::Request.new(env)
+        report_kvs = {}
+        report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
+
+        AppOpticsAPM::API.trace(:rack, report_kvs) do
+          report_kvs = collect(req, env)
+
+          # We log an info event with the HTTP KVs found in AppOpticsAPM::Rack.collect
+          # This is done here so in the case of stacks that try/catch/abort
+          # (looking at you Grape) we're sure the KVs get reported now as
+          # this code may not be returned to later.
+          AppOpticsAPM::API.log_info(:rack, report_kvs)
+          @app.call(env)
+        end
+      end
+
+      def metrics_sampling_call(env)
+        start = Time.now
+        AppOpticsAPM.transaction_name = nil
+        req = ::Rack::Request.new(env)
+        req_url = req.url   # saving it here because rails3.2 overrides it when there is a 500 error
+        status = 500        # initialize with 500
+
+        report_kvs = collect(req, env)
+        report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
+
+        # Check for and validate X-Trace request header to pick up tracing context
+        xtrace = env.is_a?(Hash) ? env['HTTP_X_TRACE'] : nil
+        xtrace = AppOpticsAPM::XTrace.valid?(xtrace) ? xtrace : nil
+
+        # TODO JRUBY
+        # Under JRuby, JAppOpticsAPM may have already started a trace.  Make note of this
+        # if so and don't clear context on log_end (see appoptics_apm/api/logging.rb)
+        # AppOpticsAPM.has_incoming_context = AppOpticsAPM.tracing?
+        # AppOpticsAPM.has_xtrace_header = xtrace
+        # AppOpticsAPM.is_continued_trace = AppOpticsAPM.has_incoming_context || AppOpticsAPM.has_xtrace_header
+
+        AppOpticsAPM::API.log_start(:rack, xtrace, report_kvs) unless AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
+
+        status, headers, response = @app.call(env)
+        confirmed_transaction_name = send_metrics(env, req, req_url, start, status)
+        xtrace = AppOpticsAPM::API.log_end(:rack, :Status => status, :TransactionName => confirmed_transaction_name)
+
+        # TODO revisit this JRUBY condition
+        # headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+        headers['X-Trace'] = xtrace if headers.is_a?(Hash)
+
+        [status, headers, response]
+      rescue Exception => e
+        # it is ok to rescue Exception here because we are reraising it (we just need a chance to log_end)
+        AppOpticsAPM::API.log_exception(:rack, e)
+        confirmed_transaction_name ||= send_metrics(env, req, req_url, start, status)
+        xtrace = AppOpticsAPM::API.log_end(:rack, :Status => status, :TransactionName => confirmed_transaction_name)
+
+        # TODO revisit this JRUBY condition
+        # headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+        headers['X-Trace'] = xtrace if headers.is_a?(Hash)
+
+        raise
+      end
+
+
+      def send_metrics(env, req, req_url, start, status)
+        return if AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
+
+        status = status.to_i
+        error = status.between?(500,599) ? 1 : 0
+        duration =(1000 * 1000 * (Time.now - start)).round(0)
+        method = req.request_method
+        AppOpticsAPM::Span.createHttpSpan(transaction_name(env), req_url, domain(req), duration, status, method, error) || ''
+      end
+
+      def domain(req)
+        if AppOpticsAPM::Config['transaction_name']['prepend_domain']
+          [80, 443].include?(req.port) ? req.host : "#{req.host}:#{req.port}"
+        end
+      end
+
+      def transaction_name(env)
+        if AppOpticsAPM.transaction_name
+          AppOpticsAPM.transaction_name
+        elsif env['appoptics_apm.controller'] && env['appoptics_apm.action']
+          [env['appoptics_apm.controller'], env['appoptics_apm.action']].join('.')
+        end
+      end
+
+    end
+  end
+else
+  module AppOpticsAPM
+    class Rack
+      attr_reader :app
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+
+      def self.noop?
+        true
+      end
+    end
+  end
+end

data/lib/appoptics_apm/inst/redis.rb

@@ -0,0 +1,275 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module Redis
+      module Client
+        # The operations listed in this constant skip collecting KVKey
+        NO_KEY_OPS = [:auth, :keys, :randomkey, :scan, :sdiff, :sdiffstore, :sinter,
+                      :sinterstore, :smove, :sunion, :sunionstore, :zinterstore,
+                      :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
+        # Hash formatting by undiagnosed OCD
+        KV_COLLECT_MAP = {
+          :brpoplpush  => { :destination  => 2 }, :rpoplpush   => { :destination  => 2 },
+          :sdiffstore  => { :destination  => 1 }, :sinterstore => { :destination  => 1 },
+          :sunionstore => { :destination  => 1 }, :zinterstore => { :destination  => 1 },
+          :zunionstore => { :destination  => 1 }, :publish     => { :channel      => 1 },
+          :incrby      => { :increment    => 2 }, :incrbyfloat => { :increment    => 2 },
+          :pexpire     => { :milliseconds => 2 }, :pexpireat   => { :milliseconds => 2 },
+          :expireat    => { :timestamp    => 2 }, :decrby      => { :decrement    => 2 },
+          :psetex      => { :ttl     => 2 },      :restore  => { :ttl     => 2 },
+          :setex       => { :ttl     => 2 },      :setnx    => { :ttl     => 2 },
+          :move        => { :db      => 2 },      :select   => { :db      => 1 },
+          :lindex      => { :index   => 2 },      :getset   => { :value   => 2 },
+          :keys        => { :pattern => 1 },      :expire   => { :seconds => 2 },
+          :rename      => { :newkey  => 2 },      :renamenx => { :newkey  => 2 },
+          :getbit      => { :offset  => 2 },      :setbit   => { :offset  => 2 },
+          :setrange    => { :offset  => 2 },      :evalsha  => { :sha     => 1 },
+          :getrange    => { :start => 2, :end       => 3 },
+          :zrange      => { :start => 2, :end       => 3 },
+          :bitcount    => { :start => 2, :stop      => 3 },
+          :lrange      => { :start => 2, :stop      => 3 },
+          :zrevrange   => { :start => 2, :stop      => 3 },
+          :hincrby     => { :field => 2, :increment => 3 },
+          :smove           => { :source    => 1, :destination => 2 },
+          :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
+        #
+        # :append, :blpop, :brpop, :decr, :del, :dump, :exists,
+        # :hgetall, :hkeys, :hlen, :hvals, :hmset, :incr, :linsert,
+        # :llen, :lpop, :lpush, :lpushx, :lrem, :lset, :ltrim,
+        # :persist, :pttl, :hscan, :rpop, :rpush, :rpushx, :sadd,
+        # :scard, :sismember, :smembers, :strlen, :sort, :spop,
+        # :srandmember, :srem, :sscan, :ttl, :type, :zadd, :zcard,
+        # :zcount, :zincrby, :zrangebyscore, :zrank, :zrem,
+        # :zremrangebyscore, :zrevrank, :zrevrangebyscore, :zscore
+        #
+        # For the operations in NO_KEY_OPS (above) we only collect
+        # KVOp (no KVKey)
+
+        def self.included(klass)
+          # We wrap two of the Redis methods to instrument
+          # operations
+          AppOpticsAPM::Util.method_alias(klass, :call, ::Redis::Client)
+          AppOpticsAPM::Util.method_alias(klass, :call_pipeline, ::Redis::Client)
+        end
+
+        # Given any Redis operation command array, this method
+        # extracts the Key/Values to report to the AppOptics
+        # dashboard.
+        #
+        # @param command [Array] the Redis operation array
+        # @param r [Return] the return value from the operation
+        # @return [Hash] the Key/Values to report
+        def extract_trace_details(command, r)
+          kvs = {}
+          op = command.first
+
+          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
+          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 :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 :script
+              kvs[:subcommand] = command[1]
+              kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::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
+              else
+                kvs[:KVKeyCount] = command.count - 1
+              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
+
+            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
+          AppOpticsAPM.logger.debug "[appoptics_apm/redis] Error collecting redis KVs: #{e.message}"
+          AppOpticsAPM.logger.debug e.backtrace.join('\n')
+        ensure
+          return kvs
+        end
+
+        # Extracts the Key/Values to report from a pipelined
+        # call to the AppOptics dashboard.
+        #
+        # @param pipeline [Redis::Pipeline] the Redis pipeline instance
+        # @return [Hash] the Key/Values to report
+        def extract_pipeline_details(pipeline)
+          kvs = {}
+
+          kvs[:RemoteHost] = @options[:host]
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:redis][:collect_backtraces]
+
+          command_count = pipeline.commands.count
+          kvs[:KVOpCount] = command_count
+
+          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(', ')
+          end
+        rescue StandardError => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] Error extracting pipelined commands: #{e.message}"
+          AppOpticsAPM.logger.debug e.backtrace
+        ensure
+          return kvs
+        end
+
+        #
+        # The wrapper method for Redis::Client.call.  Here
+        # (when tracing) we capture KVs to report and pass
+        # the call along
+        #
+        def call_with_appoptics(command, &block)
+          if AppOpticsAPM.tracing?
+            AppOpticsAPM::API.log_entry(:redis, {})
+
+            begin
+              r = call_without_appoptics(command, &block)
+              report_kvs = extract_trace_details(command, r)
+              r
+            rescue StandardError => e
+              AppOpticsAPM::API.log_exception(:redis, e)
+              raise
+            ensure
+              AppOpticsAPM::API.log_exit(:redis, report_kvs)
+            end
+
+          else
+            call_without_appoptics(command, &block)
+          end
+        end
+
+        #
+        # The wrapper method for Redis::Client.call_pipeline.  Here
+        # (when tracing) we capture KVs to report and pass the call along
+        #
+        def call_pipeline_with_appoptics(pipeline)
+          if AppOpticsAPM.tracing?
+            # Fall back to the raw tracing API so we can pass KVs
+            # back on exit (a limitation of the AppOpticsAPM::API.trace
+            # block method)  This removes the need for an info
+            # event to send additonal KVs
+            AppOpticsAPM::API.log_entry(:redis, {})
+
+            report_kvs = extract_pipeline_details(pipeline)
+
+            begin
+              call_pipeline_without_appoptics(pipeline)
+            rescue StandardError => e
+              AppOpticsAPM::API.log_exception(:redis, e)
+              raise
+            ensure
+              AppOpticsAPM::API.log_exit(:redis, report_kvs)
+            end
+          else
+            call_pipeline_without_appoptics(pipeline)
+          end
+        end
+      end
+    end
+  end
+end
+
+if AppOpticsAPM::Config[:redis][:enabled]
+  if defined?(Redis) && Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0.0')
+    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting redis' if AppOpticsAPM::Config[:verbose]
+    AppOpticsAPM::Util.send_include(Redis::Client, AppOpticsAPM::Inst::Redis::Client)
+  end
+end