bc-lightstep-ruby 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664ccd6841a41bafc3f8a3f932968c6b8155593b88185fa06351f884a6170e18
-  data.tar.gz: f0d69178509b3f639efd203750ff314717b930fc9c22b0cfa915b296a7e2a53e
+  metadata.gz: 39888ce33cb784b4e9bf294ef12948c14117a68eb0f19ed556c3d1bda47ca35b
+  data.tar.gz: a321672c7e044a5db91d6e58d051058acfaf347fabcb2d736fcac2d1024bad86
 SHA512:
-  metadata.gz: ad43fa6c9be415924b6731efe73fac8a96f4c85e5e9dcc92463175de55586fe0d478c8e6cfae4d95783f1699e75b560e1309903c7234647a2f78469759b6fcde
-  data.tar.gz: c7197599a7b8b22a9e6e90cf0b17b11ca35e902ced91726a8c4332dcb79eb186716623f34c94b45bacc5bc20422d00f84ac0866da0d9148f046b22d5a24fc31c
+  metadata.gz: '009121dcef8ced54b459af1a4f3349cd50d49e08d5274afe99c14092507c16f48f661fdba98366faf895556053ea13365aaa7eadbe3b6c7aae75e17097c38a41'
+  data.tar.gz: 714da396916d0486762a9e7246bab4e94054ffab51a9db4cd5d14eb07136e03dd74e79abb05023a374d4481fa2fff72fe3b6655d949850799b0cc6e92cf98ea2

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.3.1
+
+- Add various options to suppress redis trace spam
+- Fix issue with pipeline commands in redis instrumentation
+
 h3. 1.3.0
 
 - Adds automatic Redis instrumentation support

data/README.md

@@ -80,6 +80,12 @@ or systems outside of your instrumenting control.
 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). 
 
+Note that this will not record redis timings if they are a root span. This is to prevent trace spamming. You can 
+re-enable this by setting the `redis_allow_root_spans` configuration option to `true`.
+
+It also excludes `ping` commands, and you can provide a custom list by setting the `redis_excluded_commands` 
+configuration option to an array of commands to exclude.
+
 ## License
 
 Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 

data/lib/bigcommerce/lightstep/configuration.rb

@@ -38,6 +38,8 @@ module Bigcommerce
         max_buffered_spans: 1_000,
         max_log_records: 1_000,
         max_reporting_interval_seconds: 3.0,
+        redis_excluded_commands: %w(ping),
+        redis_allow_root_spans: false,
         enabled: true
       }.freeze
 

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

@@ -22,6 +22,23 @@ module Bigcommerce
       # Middleware tracer for Redis clients
       #
       class Tracer
+        attr_accessor :tracer
+
+        ##
+        # @param [Bigcommerce::Lightstep::Tracer] tracer
+        # @param [Array<String>] excluded_commands
+        # @param [Boolean] allow_root_spans
+        #
+        def initialize(
+          tracer: nil,
+          excluded_commands: nil,
+          allow_root_spans: nil
+        )
+          @tracer = tracer || ::Bigcommerce::Lightstep::Tracer.instance
+          @excluded_commands = excluded_commands || ::Bigcommerce::Lightstep.redis_excluded_commands
+          @allow_root_spans = allow_root_spans.nil? ? ::Bigcommerce::Lightstep.redis_allow_root_spans : allow_root_spans
+        end
+
         ##
         # @param [String] key
         # @param [String] statement
@@ -30,17 +47,26 @@ module Bigcommerce
         # @param [Integer] port
         #
         def trace(key:, statement:, instance:, host:, port:)
-          return yield unless tracer
+          return yield unless @tracer
+
+          # only take the command, not any arguments
+          command = statement.to_s.split(' ').first
+
+          # skip excluded commands
+          return yield if excluded?(command.to_s)
+
+          # skip if not allowing root spans and there is no active span
+          return yield if !@allow_root_spans && !active_span?
 
           tags = {
             'db.type' => 'redis',
-            'db.statement' => statement.to_s.split(' ').first, # only take the command, not any arguments
+            'db.statement' => command,
             'db.instance' => instance,
             'db.host' => "redis://#{host}:#{port}",
             'span.kind' => 'client'
           }
 
-          tracer.start_span(key) do |span|
+          @tracer.start_span(key) do |span|
             tags.each do |k, v|
               span.set_tag(k, v)
             end
@@ -55,10 +81,18 @@ module Bigcommerce
         end
 
         ##
-        # @return [::Bigcommerce::Lightstep::Tracer]
+        # @param [String] command
+        # @return [Boolean]
+        #
+        def excluded?(command)
+          @excluded_commands.include?(command.to_s)
+        end
+
+        ##
+        # @return [Boolean]
         #
-        def tracer
-          @tracer ||= ::Bigcommerce::Lightstep::Tracer.instance
+        def active_span?
+          tracer.respond_to?(:active_span) && tracer.active_span
         end
       end
     end

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

@@ -58,6 +58,7 @@ module Bigcommerce
               def call_pipeline(pipeline)
                 return call_pipeline_original(pipeline) unless bc_lightstep_tracer
 
+                commands = pipeline.try(:commands) || []
                 bc_lightstep_tracer.trace(
                   key: 'redis.pipelined',
                   statement: commands.empty? ? '' : commands.map { |arr| arr.join(' ') }.join(', '),

data/lib/bigcommerce/lightstep/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Shaun McCormick