bc-lightstep-ruby 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb51f610607ad4b815b647c6fa8f09dcd5125e6c27f33462ee2d91a25ba9c28f
-  data.tar.gz: 34319a63089a907ddd8c15c55442965b42ab1c905f623c5531b8f541a8851685
+  metadata.gz: 664ccd6841a41bafc3f8a3f932968c6b8155593b88185fa06351f884a6170e18
+  data.tar.gz: f0d69178509b3f639efd203750ff314717b930fc9c22b0cfa915b296a7e2a53e
 SHA512:
-  metadata.gz: 3ad475e7bf94c4c4d8de3328ea3944c7ccde4a2d1554f630c5d1410453646b2571dec5e2877ba673e99c764786d61efb5cb09ad4fec843e61182b795e3eddc97
-  data.tar.gz: a5ca0c2fc284a898cb92b29c8bef18f0a237c5b305713b55d4ccf42a4fca0c164e17ceb403be716ce2e399045af5313144026b90f224c4f72305b5f7981ee7a4
+  metadata.gz: ad43fa6c9be415924b6731efe73fac8a96f4c85e5e9dcc92463175de55586fe0d478c8e6cfae4d95783f1699e75b560e1309903c7234647a2f78469759b6fcde
+  data.tar.gz: c7197599a7b8b22a9e6e90cf0b17b11ca35e902ced91726a8c4332dcb79eb186716623f34c94b45bacc5bc20422d00f84ac0866da0d9148f046b22d5a24fc31c

data/CHANGELOG.md

@@ -2,7 +2,9 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.3.0
 
+- Adds automatic Redis instrumentation support
 
 h3. 1.2.2
 

data/README.md

@@ -73,7 +73,12 @@ end
 
 Spans will be built with the external service name. It's generally _not_ a good idea to use the Faraday adapter
 with internal services that are also instrumented with LightStep - use the Faraday adapter on external services
-or systems outside of your instrumenting control. 
+or systems outside of your instrumenting control.
+
+### Redis
+
+This gem will automatically detect and instrumnent Redis calls when they are made using the `Redis::Client` class.
+It will set as tags on the span the host, port, db instance, and the command (but no arguments). 
 
 ## License
 

data/lib/bigcommerce/lightstep.rb

@@ -23,6 +23,7 @@ require_relative 'lightstep/transport_factory'
 require_relative 'lightstep/transport'
 require_relative 'lightstep/rails_controller_instrumentation'
 require_relative 'lightstep/middleware/faraday'
+require_relative 'lightstep/redis/tracer'
 
 ##
 # Main base module
@@ -44,6 +45,8 @@ module Bigcommerce
       ::LightStep.instance.max_span_records = ::Bigcommerce::Lightstep.max_buffered_spans
       ::LightStep.instance.max_log_records = ::Bigcommerce::Lightstep.max_log_records
       ::LightStep.instance.report_period_seconds = ::Bigcommerce::Lightstep.max_reporting_interval_seconds
+
+      ::Bigcommerce::Lightstep::Redis::Wrapper.patch if ::Bigcommerce::Lightstep.enabled
     end
   end
 end

data/lib/bigcommerce/lightstep/redis/tracer.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require_relative 'wrapper'
+
+module Bigcommerce
+  module Lightstep
+    module Redis
+      ##
+      # Middleware tracer for Redis clients
+      #
+      class Tracer
+        ##
+        # @param [String] key
+        # @param [String] statement
+        # @param [String] instance
+        # @param [String] host
+        # @param [Integer] port
+        #
+        def trace(key:, statement:, instance:, host:, port:)
+          return yield unless tracer
+
+          tags = {
+            'db.type' => 'redis',
+            'db.statement' => statement.to_s.split(' ').first, # only take the command, not any arguments
+            'db.instance' => instance,
+            'db.host' => "redis://#{host}:#{port}",
+            'span.kind' => 'client'
+          }
+
+          tracer.start_span(key) do |span|
+            tags.each do |k, v|
+              span.set_tag(k, v)
+            end
+            begin
+              resp = yield
+            rescue StandardError => _
+              span.set_tag('error', true)
+              raise # re-raise the error
+            end
+            resp
+          end
+        end
+
+        ##
+        # @return [::Bigcommerce::Lightstep::Tracer]
+        #
+        def tracer
+          @tracer ||= ::Bigcommerce::Lightstep::Tracer.instance
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/redis/wrapper.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Bigcommerce
+  module Lightstep
+    module Redis
+      ##
+      # Instrumentation wrapper for Redis
+      #
+      module Wrapper
+        class << self
+          def patch
+            require 'redis' # thread and fork safety
+            return if @wrapped
+
+            wrap unless @wrapped
+            @wrapped = true
+          rescue ::LoadError => _
+            @wrapped = false
+            # noop
+          end
+
+          private
+
+          def wrap
+            raise ::LoadError, 'Redis not loaded' unless defined?(::Redis::Client)
+
+            ::Redis::Client.class_eval do
+              alias_method :call_original, :call
+              alias_method :call_pipeline_original, :call_pipeline
+
+              def call(command)
+                return call_original(command) unless bc_lightstep_tracer
+
+                bc_lightstep_tracer.trace(
+                  key: "redis.#{command[0]}",
+                  statement: command.join(' '),
+                  instance: db,
+                  host: host,
+                  port: port
+                ) do
+                  call_original(command)
+                end
+              end
+
+              def call_pipeline(pipeline)
+                return call_pipeline_original(pipeline) unless bc_lightstep_tracer
+
+                bc_lightstep_tracer.trace(
+                  key: 'redis.pipelined',
+                  statement: commands.empty? ? '' : commands.map { |arr| arr.join(' ') }.join(', '),
+                  instance: db,
+                  host: host,
+                  port: port
+                ) do
+                  call_pipeline_original(pipeline)
+                end
+              end
+
+              ##
+              # @return [::Bigcommerce::Lightstep::Redis::Tracer]
+              #
+              def bc_lightstep_tracer
+                @bc_lightstep_tracer ||= ::Bigcommerce::Lightstep::Redis::Tracer.new
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/version.rb

@@ -15,6 +15,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.2.2'.freeze
+    VERSION = '1.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,8 @@ files:
 - lib/bigcommerce/lightstep/errors.rb
 - lib/bigcommerce/lightstep/middleware/faraday.rb
 - lib/bigcommerce/lightstep/rails_controller_instrumentation.rb
+- lib/bigcommerce/lightstep/redis/tracer.rb
+- lib/bigcommerce/lightstep/redis/wrapper.rb
 - lib/bigcommerce/lightstep/tracer.rb
 - lib/bigcommerce/lightstep/transport.rb
 - lib/bigcommerce/lightstep/transport_factory.rb