solarwinds_apm 5.1.3 → 5.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c274381dffd0448ab7bd8075035f550bd7374161af063c8b2eb53b1170b71dc3
-  data.tar.gz: af7a66a8329b4c357a1368793d58b2be3e5c6db2a2d56f73287645f668e0cd9b
+  metadata.gz: 6b56699604e8448a606d69ed23ba957622c4b70d8d2cbcf070526105f2dcff87
+  data.tar.gz: 5b0f55643f2ea9072418c66c62a6f9ea4ca87fea74fbcec66574a341e0510c82
 SHA512:
-  metadata.gz: d3ce5239fa623d41cb982578c51280caf4f1c7b7e152dfd97232f7e6fbc1d0faf0453ad30ba6e2e04fbc22a0f319f2c2569c0a1b53ce3f9a4e9f4924c16d8252
-  data.tar.gz: 45b3d421e0acc5a90cdb9e61707d17e4739baf70d8ee916540b9e391c35ebd72c04b4493725358f94458c5ae0431e62f44fb5b087a08f86038bfd8b07d4ac398
+  metadata.gz: f77f2c0e8315832f92204bc0cdd29d6588f83cbf2751f8dfac2fb0402c65091c96238f0192da4473b99a0cf5197b44a66839f7d1c58fb5521bd11ce1a96defc6
+  data.tar.gz: 53c8e3740a5361fa4f9e403cf863f2044d821a58a7c42ac8708c859781c363b168af78e39da50b2ceeda783b752205cf0c0cb5bdf86afa7ffa4e63e80ae4dffe

data/.gitignore

@@ -41,11 +41,18 @@ gemfiles/vendor*
 lib/libsolarwinds_apm.so
 vendor/
 
-# test
+# test & test script
 tmp.rb
 apm.collector.st-ssp.solarwinds.com
 test/run_tests/.ruby_version_ubuntu
+test/run_tests/.ruby_version_alpine
+test/run_tests/.ruby_version_centos
+test/run_tests/.ruby_version_ubuntu
+
+redis-test.*
 
+# compiling
+ext/oboe_metal/verify
 
 # mac DS_Store
-.DS_Store
+.DS_Store

data/CHANGELOG.md

@@ -3,6 +3,20 @@ https://github.com/solarwindscloud/solarwinds-apm-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# solarwinds_apm 5.1.4 (11/23/2022)
+
+This release includes the following features:
+
+* Update to the latest redis-rb gem (> 5.x)
+* Update latest liboboe library (11.1.0)
+* Start to support solarwinds-apm-ruby arm64/aarch64 
+* Init message update for swo/nh backends
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/solarwinds_apm/versions/5.1.4
+
+
 # solarwinds_apm 5.1.0 (09/15/2022)
 
 This release includes the following features:

data/README.md

@@ -11,7 +11,8 @@ It requires an [Solarwinds] account to view metrics.  Get yours,
 
 [![Gem Version](https://badge.fury.io/rb/solarwinds_apm.svg)](https://badge.fury.io/rb/solarwinds_apm)
 
-[![Run all Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml)
+[![Run all Tests](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/test_on_4_linux.yml/badge.svg)](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/test_on_4_linux.yml)
+
 [![C++ Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml)
 
 [comment]: <> ([![Maintainability]&#40;https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability&#41;]&#40;https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability&#41;)
@@ -363,7 +364,7 @@ To make this simpler, we've included a few rake tasks to automate this process:
 
 ```bash
 rake clean                             # make sure no old stuff is around
-rake fetch_oboe_file_from_staging      # download c-files from staging
+rake fetch_oboe_file["stg"]     # download c-files from staging
 rake compile                           # Build the gem's c extension
 ```
 
@@ -381,3 +382,4 @@ See the README in the test directory.
 Copyright (c) 2018 SolarWinds, LLC
 
 Released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+

data/ext/oboe_metal/extconf.rb

@@ -27,26 +27,39 @@ ao_include = File.join(ext_dir, 'src')
 
 # Download the appropriate liboboe from Staging or Production
 version = File.read(File.join(ao_include, 'VERSION')).strip
-if ENV['OBOE_STAGING'].to_s.downcase == 'true'
+if ENV['OBOE_DEV'].to_s.downcase == 'true'
+  ao_path = "https://solarwinds-apm-staging.s3.us-west-2.amazonaws.com/apm/c-lib/nightly"
+  puts 'Fetching c-lib from DEVELOPMENT Build'
+elsif ENV['OBOE_STAGING'].to_s.downcase == 'true'
   ao_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
   puts 'Fetching c-lib from STAGING'
 else
   ao_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version)
 end
 
-ao_arch = 'x86_64'
+ao_arch = "x86_64"
+system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
+case system_arch.gsub("\n","")
+when "x86_64"
+  ao_arch = "x86_64"
+when "aarch64"
+  ao_arch = "aarch64"
+end
+
 if File.exist?('/etc/alpine-release')
   version = File.read('/etc/alpine-release').strip
 
+  tmp_ao_arch = ao_arch.clone
   ao_arch =
     if Gem::Version.new(version) < Gem::Version.new('3.9')
-      'alpine-libressl-x86_64'
+      "alpine-libressl-#{tmp_ao_arch}"
     else # openssl
-      'alpine-x86_64'
+      "alpine-#{tmp_ao_arch}"
     end
 end
 
 ao_clib = "liboboe-1.0-#{ao_arch}.so.0.0.0"
+ao_clib = "liboboe-1.0-#{ao_arch}.so" if ENV['OBOE_DEV'].to_s.downcase == 'true' # for dev build only
 ao_item = File.join(ao_path, ao_clib)
 ao_checksum_file = File.join(ao_lib_dir, "#{ao_clib}.sha256")
 clib = File.join(ao_lib_dir, ao_clib)
@@ -138,4 +151,4 @@ if success
     $stderr.puts   '=================================================================='
     create_makefile('oboe_noop', 'noop')
   end
-end
+end

data/ext/oboe_metal/lib/liboboe-1.0-aarch64.so.0.0.0.sha256

@@ -0,0 +1 @@
+ae491260c3b2dfbb2ada97de0c94e78424b2eb5bf19b2b752c25301057270c30

data/ext/oboe_metal/lib/liboboe-1.0-alpine-aarch64.so.0.0.0.sha256

@@ -0,0 +1 @@
+a1f5406931ce82b0297bbb1b2b22b151c544e47babc43f0116274f95002ce85e

data/ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.0.0.0.sha256

@@ -1 +1 @@
-08e53f05aebb831b3bb27410ad3163e193b4e3d7dbef3ac280e799f024623d95
+ede3fcc827faba4d6cf09d2dd59a41325c462c9093994c2c2df202ae57416733

data/ext/oboe_metal/lib/liboboe-1.0-x86_64.so.0.0.0.sha256

@@ -1 +1 @@
-69ae267c2a31e29b1f518f9a30149e3bce1dd9a9e3a5a1c91c032f1b15ba3360
+079abfef35a869c3469908a62b97ad6f0f98f85a6f79e3c60265b251dc07dac3

data/ext/oboe_metal/src/VERSION

@@ -1,2 +1,2 @@
-11.0.0
+11.1.0
 

data/lib/solarwinds_apm/inst/redis.rb

@@ -57,10 +57,9 @@ module SolarWindsAPM
         # KVOp (no KVKey)
 
         def self.included(klass)
-          # We wrap two of the Redis methods to instrument
-          # operations
-          SolarWindsAPM::Util.method_alias(klass, :call, ::Redis::Client)
-          SolarWindsAPM::Util.method_alias(klass, :call_pipeline, ::Redis::Client)
+          # call_pipelined is alias of call in redisclient middlewares
+          SolarWindsAPM::Util.method_alias(klass, :call, ::RedisClient)
+          SolarWindsAPM::Util.method_alias(klass, :call_pipelined, ::RedisClient)
         end
 
         # Given any Redis operation command array, this method
@@ -69,12 +68,14 @@ module SolarWindsAPM
         # @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)
+        def extract_trace_details(command, r, config)
+          SolarWindsAPM.logger.debug "extract_trace_details command => #{command.inspect}"
           kvs = {}
           op = command.first
+          op = op.to_sym
 
           kvs[:KVOp] = command[0]
-          kvs[:RemoteHost] = @options[:host]
+          kvs[:RemoteHost] = config.host
           unless NO_KEY_OPS.include?(op) || op == :del && command[1..-1].flatten.count > 1
             if command[1].is_a?(Array)
               kvs[:KVKey] = command[1].first
@@ -115,7 +116,7 @@ module SolarWindsAPM
               kvs[:KVHit] = r.nil? ? 0 : 1
 
             when :hdel, :hexists, :hget, :hset, :hsetnx
-              kvs[:field] = command[2] unless command[2].is_a?(Array)
+              kvs[:field] = command[2] unless (command[2] && command[3]) # replace the idiom of command[2].is_a?(Array)
               if op == :hget
                 kvs[:KVHit] = r.nil? ? 0 : 1
               end
@@ -136,7 +137,7 @@ module SolarWindsAPM
                 else
                   kvs[:Script] = command[2]
                 end
-              elsif command[1] == :exists
+              elsif command[1] == "exists"
                 if command[2].is_a?(Array)
                   kvs[:KVKey] = command[2].inspect
                 else
@@ -166,6 +167,10 @@ module SolarWindsAPM
               end
             end # case op
           end # if KV_COLLECT_MAP[op]
+          # turn every string into number
+          # kvs.each do |k,v|
+          #   kvs[k] = v.to_i if v.is_a(String)
+          # end
         rescue StandardError => e
           SolarWindsAPM.logger.debug "[solarwinds_apm/redis] Error collecting redis KVs: #{e.message}"
           SolarWindsAPM.logger.debug e.backtrace.join('\n')
@@ -178,16 +183,17 @@ module SolarWindsAPM
         #
         # @param pipeline [Redis::Pipeline] the Redis pipeline instance
         # @return [Hash] the Key/Values to report
-        def extract_pipeline_details(pipeline)
+        def extract_pipeline_details(commands, config)
+          SolarWindsAPM.logger.debug "extract_pipeline_details command => #{commands.inspect}"
           kvs = {}
 
-          kvs[:RemoteHost] = @options[:host]
+          kvs[:RemoteHost] = config.host
           kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:redis][:collect_backtraces]
 
-          command_count = pipeline.commands.count
+          command_count = commands.count
           kvs[:KVOpCount] = command_count
 
-          kvs[:KVOp] = if pipeline.commands.first == :multi
+          kvs[:KVOp] = if commands.first == :multi
             :multi
           else
             :pipeline
@@ -197,7 +203,7 @@ module SolarWindsAPM
           # of ops is reasonable
           if command_count < 12
             ops = []
-            pipeline.commands.each do |c|
+            commands.each do |c|
               ops << c.first
             end
             kvs[:KVOps] = ops.join(', ')
@@ -210,17 +216,19 @@ module SolarWindsAPM
         end
 
         #
-        # The wrapper method for Redis::Client.call.  Here
+        # The wrapper method for RedisClient.call.  Here
         # (when tracing) we capture KVs to report and pass
         # the call along
         #
-        def call_with_sw_apm(command, &block)
+        def call_with_sw_apm(command, config, &block)
+          SolarWindsAPM.logger.debug "call_with_sw_apm command => #{command.inspect}"
           if SolarWindsAPM.tracing?
             SolarWindsAPM::API.log_entry(:redis, {})
 
             begin
-              r = call_without_sw_apm(command, &block)
-              report_kvs = extract_trace_details(command, r)
+              r = call_without_sw_apm(command, config, &block)
+              report_kvs = extract_trace_details(command, r, config)
+              SolarWindsAPM.logger.debug "call_with_sw_apm command => #{report_kvs.inspect}"
               r
             rescue StandardError => e
               SolarWindsAPM::API.log_exception(:redis, e)
@@ -230,26 +238,25 @@ module SolarWindsAPM
             end
 
           else
-            call_without_sw_apm(command, &block)
+            call_without_sw_apm(command, config, &block)
           end
         end
 
         #
-        # The wrapper method for Redis::Client.call_pipeline.  Here
+        # The wrapper method for RedisClient.call_pipeline.  Here
         # (when tracing) we capture KVs to report and pass the call along
-        #
-        def call_pipeline_with_sw_apm(pipeline)
+        # 5.0.0 + removed the deprecated pipelined and multi signature. Commands now MUST be called on the block argument, not the original redis instance
+        def call_pipelined_with_sw_apm(commands, config, &block)
+          SolarWindsAPM.logger.debug "call_pipelined_with_sw_apm command => #{commands.inspect}"
           if SolarWindsAPM.tracing?
             # Fall back to the raw tracing API so we can pass KVs
             # back on exit (a limitation of the SolarWindsAPM::API.trace
             # block method)  This removes the need for an info
             # event to send additonal KVs
             SolarWindsAPM::API.log_entry(:redis, {})
-
-            report_kvs = extract_pipeline_details(pipeline)
-
+            report_kvs = extract_pipeline_details(commands, config)
             begin
-              call_pipeline_without_sw_apm(pipeline)
+              call_pipelined_without_sw_apm(commands, config, &block)
             rescue StandardError => e
               SolarWindsAPM::API.log_exception(:redis, e)
               raise
@@ -257,7 +264,7 @@ module SolarWindsAPM
               SolarWindsAPM::API.log_exit(:redis, report_kvs)
             end
           else
-            call_pipeline_without_sw_apm(pipeline)
+            call_pipelined_without_sw_apm(commands, config, &block)
           end
         end
       end
@@ -266,8 +273,8 @@ module SolarWindsAPM
 end
 
 if SolarWindsAPM::Config[:redis][:enabled]
-  if defined?(Redis) && Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0.0')
-    SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting redis' if SolarWindsAPM::Config[:verbose]
-    SolarWindsAPM::Util.send_include(Redis::Client, SolarWindsAPM::Inst::Redis::Client)
+  if defined?(::RedisClient)
+    SolarWindsAPM.logger.info "[solarwinds_apm/loading] Instrumenting redis #{Redis::VERSION}" if SolarWindsAPM::Config[:verbose]
+    ::RedisClient.register(SolarWindsAPM::Inst::Redis::Client)
   end
 end

data/lib/solarwinds_apm/inst/redis_v4.rb

@@ -0,0 +1,273 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Inst
+    module RedisV4
+      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
+          SolarWindsAPM::Util.method_alias(klass, :call, ::Redis::Client)
+          SolarWindsAPM::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 SolarWinds         # 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) || op == :del && command[1..-1].flatten.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] = SolarWindsAPM::API.backtrace if SolarWindsAPM::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
+          SolarWindsAPM.logger.debug "[solarwinds_apm/redis] Error collecting redis KVs: #{e.message}"
+          SolarWindsAPM.logger.debug e.backtrace.join('\n')
+        ensure
+          return kvs
+        end
+
+        # Extracts the Key/Values to report from a pipelined
+        # call to the SolarWinds 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] = SolarWindsAPM::API.backtrace if SolarWindsAPM::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
+          SolarWindsAPM.logger.debug "[solarwinds_apm/debug] Error extracting pipelined commands: #{e.message}"
+          SolarWindsAPM.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_sw_apm(command, &block)
+          if SolarWindsAPM.tracing?
+            SolarWindsAPM::API.log_entry(:redis, {})
+
+            begin
+              r = call_without_sw_apm(command, &block)
+              report_kvs = extract_trace_details(command, r)
+              r
+            rescue StandardError => e
+              SolarWindsAPM::API.log_exception(:redis, e)
+              raise
+            ensure
+              SolarWindsAPM::API.log_exit(:redis, report_kvs)
+            end
+
+          else
+            call_without_sw_apm(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_sw_apm(pipeline)
+          if SolarWindsAPM.tracing?
+            # Fall back to the raw tracing API so we can pass KVs
+            # back on exit (a limitation of the SolarWindsAPM::API.trace
+            # block method)  This removes the need for an info
+            # event to send additonal KVs
+            SolarWindsAPM::API.log_entry(:redis, {})
+
+            report_kvs = extract_pipeline_details(pipeline)
+
+            begin
+              call_pipeline_without_sw_apm(pipeline)
+            rescue StandardError => e
+              SolarWindsAPM::API.log_exception(:redis, e)
+              raise
+            ensure
+              SolarWindsAPM::API.log_exit(:redis, report_kvs)
+            end
+          else
+            call_pipeline_without_sw_apm(pipeline)
+          end
+        end
+      end
+    end
+  end
+end
+
+if SolarWindsAPM::Config[:redis][:enabled]
+  if defined?(::Redis) && ::Redis::VERSION < '5' && ::Redis::VERSION > '3'
+    SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting redis' if SolarWindsAPM::Config[:verbose]
+    SolarWindsAPM::Util.send_include(::Redis::Client, SolarWindsAPM::Inst::RedisV4::Client)
+  end
+end