bc-lightstep-ruby 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7589e9edaad478590eb9d013c737a3ea8a49f20ee84edfcb4ee8e6af9900a068
-  data.tar.gz: fb544f39b1f223111ab96c47839fd4706d0e1c0772b737add936b21a83f82cd6
+  metadata.gz: 9b7c7f73bcd9b15e33f59fab40d2f60124d83747547f2cdde65b49f7325b844e
+  data.tar.gz: fc8eca4e8a2d9eb94731c6388ac8354ce96bb6e66af5e2407e10db5182d9631b
 SHA512:
-  metadata.gz: 4bd6e24028f387fe63d59a23d4adee468a60fa2493a4614975159f3498ea9331d71fb55cc9db8727f06cfdfaaa5890a70e50d199247997abba5f2db1f8c034df
-  data.tar.gz: 534f92acb60ee987cbc852d845a6b8b1cd65e96e9876818f848bfae5d90220f5b0faf8d8465f1f25087528fee615c91dea557a90f19a8e96e0694a37b3e9f4ac
+  metadata.gz: befcf28e38ee07348960d9458d4f2d933e95e418b80c6f330d818dd45fa05406bef2da7a8a4402ff34a6e2e31d8bab07e1e84a1d02cf5579e2727f6721749553
+  data.tar.gz: 74b3b64044faaf7dfe0a153828856f60ecc09c078354122c1ac8b5104f0f345aa2b8ffede65ce5eca1f68cb9b9bb88bd9baa26c54be304fdc9472b2109f59f11

data/CHANGELOG.md

@@ -2,6 +2,13 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.6.1
+
+- Add interception context for thread-safe interception per trace
+- Fix issue when there are no interceptors configured
+- Fix issue where there is more than one interceptor configured
+- Only pass env tags if root span for service
+
 h3. 1.6.0
 
 - Allow for instantiation of interceptors at initialization time

data/lib/bigcommerce/lightstep.rb

@@ -20,6 +20,7 @@ require 'faraday'
 require_relative 'lightstep/version'
 require_relative 'lightstep/errors'
 require_relative 'lightstep/interceptors/registry'
+require_relative 'lightstep/interceptors/context'
 require_relative 'lightstep/configuration'
 require_relative 'lightstep/tracer'
 require_relative 'lightstep/transport_factory'

data/lib/bigcommerce/lightstep/interceptors/context.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# 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 Interceptors
+      ##
+      # Runs interceptors in a given context
+      #
+      class Context
+        ##
+        # Initialize the interception context
+        #
+        # @param [Array<Bigcommerce::Lightstep::Interceptors::Base>] interceptors
+        # @param [::Logger] logger
+        #
+        def initialize(interceptors: nil, logger: nil)
+          @interceptors = interceptors || ::Bigcommerce::Lightstep.interceptors.all
+          @logger = logger || ::Bigcommerce::Lightstep.logger
+        end
+
+        ##
+        # Intercept a trace with all interceptors
+        #
+        # @param [::LightStep::Span] span
+        #
+        def intercept(span)
+          return yield span if @interceptors.none?
+
+          interceptor = @interceptors.pop
+
+          return yield span unless interceptor
+
+          @logger.debug "[bigcommerce-lightstep] Intercepting request with interceptor: #{interceptor.class}"
+
+          interceptor.call(span: span) do |yielded_span|
+            if @interceptors.any?
+              intercept(yielded_span) { yield yielded_span }
+            else
+              yield yielded_span
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/interceptors/env.rb

@@ -32,7 +32,7 @@ module Bigcommerce
         }.freeze
 
         PRESET_HOSTNAME = {
-          'hostname': 'HOSTNAME',
+          'hostname': 'HOSTNAME'
         }.freeze
 
         ##
@@ -52,6 +52,8 @@ module Bigcommerce
         # @param [::LightStep::Span] span
         #
         def call(span:)
+          return yield span unless root_span?(span)
+
           value_mutex do
             @values.each do |span_key, value|
               span.set_tag(span_key, value)
@@ -63,6 +65,10 @@ module Bigcommerce
 
         private
 
+        def root_span?(span)
+          span.instance_variable_get(:@root_span) == true
+        end
+
         ##
         # Pre-collect values at start
         #

data/lib/bigcommerce/lightstep/interceptors/registry.rb

@@ -41,24 +41,6 @@ module Bigcommerce
           end
         end
 
-        ##
-        # Intercept a trace with all interceptors
-        #
-        def intercept(span)
-          interceptors = all
-          interceptor = interceptors.pop
-
-          return yield unless interceptor
-
-          interceptor.call(span: span) do |yielded_span|
-            if interceptors.any?
-              intercept(yielded_span) { yield yielded_span }
-            else
-              yield yielded_span
-            end
-          end
-        end
-
         ##
         # Clear the registry
         #

data/lib/bigcommerce/lightstep/tracer.rb

@@ -21,14 +21,6 @@ module Bigcommerce
     # Global tracer
     #
     class Tracer
-      private
-
-      def initialize
-        @interceptors = Bigcommerce::Lightstep.interceptors || Bigcommerce::Lightstep::Interceptors::Registry.new
-      end
-
-      public
-
       include Singleton
 
       ##
@@ -62,13 +54,15 @@ module Bigcommerce
         # create new span
         span = ::LightStep.start_span(name, child_of: current_parent, start_time: start_time, tags: tags)
 
+        mark_root_span(span) if active_span.nil?
+
         # set it as the active span
         self.active_span = span
 
         # run the process
         result = nil
         begin
-          @interceptors.intercept(span) do |inner_span|
+          build_context.intercept(span) do |inner_span|
             result = yield inner_span
           end
         rescue StandardError
@@ -118,6 +112,13 @@ module Bigcommerce
 
       private
 
+      ##
+      # @return [::Bigcommerce::Lightstep::Interceptors::Context]
+      #
+      def build_context
+        ::Bigcommerce::Lightstep::Interceptors::Context.new
+      end
+
       ##
       # Determine the active parent
       #
@@ -146,6 +147,14 @@ module Bigcommerce
       def tracer
         LightStep.instance
       end
+
+      ##
+      # Because LightStep doesn't allow changing the span return class, or adding any arbitrary attributes, we need
+      # to do this here to mark what is the "root" span in a service.
+      #
+      def mark_root_span(span)
+        span.instance_variable_set(:@root_span, true)
+      end
     end
   end
 end

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.6.0'
+    VERSION = '1.6.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/bigcommerce/lightstep/configuration.rb
 - lib/bigcommerce/lightstep/errors.rb
 - lib/bigcommerce/lightstep/interceptors/base.rb
+- lib/bigcommerce/lightstep/interceptors/context.rb
 - lib/bigcommerce/lightstep/interceptors/env.rb
 - lib/bigcommerce/lightstep/interceptors/registry.rb
 - lib/bigcommerce/lightstep/middleware/faraday.rb
@@ -145,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Gem for lightstep distributed tracing