bc-lightstep-ruby 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75614155acef737a30e80669b9decb41b2289f18f1519c049732bcdb78f034d4
-  data.tar.gz: 4b937baecd5fdb865b462a5a5ff92d30f9f88e4f1c9f555c994c5c61fdcec76d
+  metadata.gz: '08af660ec2183d4ec8eaff0050ce5d6476a7147b108d4ca69dfcec92f68c99e3'
+  data.tar.gz: d6ccbfa3aece6cc5b339ff0e45e05e078d822ec4f42e5d4894fee48ce66f0129
 SHA512:
-  metadata.gz: d1e310ce0281e96dc8bdbe176cbf88a1d43067e90313f53933e163cc5bf53c30cc1275b27b8f3eede24de85d5c834e888a9e399d5ef344869ba44176face4373
-  data.tar.gz: d64dc9e30cddbc9dd9e0bedb56d738738f1a709b21e9e26190ea530114eae9748310738e07238e796b2a8c5bd69c24c6fe3e53e204512b06a3ce1201c354f640
+  metadata.gz: 4e4232a04e274587f4c04f4544b6926e039ec8b1619bc0cb82405fdf46764f3da8433340aac51afba064426342a7bb64f5c1be271f6758a262a6afd72e5cd305
+  data.tar.gz: c4a7bc4b47f07343ba1cc2131ea508c1bcd43b4b24c45e410700d51f4485a5334e1051d885ba2d64027b45f777299b201116eb8206eb31809121c6be533aed18

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.5.0
+
+- Add interceptors that allow for global injection of tags into spans
+
 h3. 1.4.0
 
 - Add `frozen_string_literal: true` to all files

data/lib/bigcommerce/lightstep.rb

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

data/lib/bigcommerce/lightstep/configuration.rb

@@ -27,6 +27,7 @@ module Bigcommerce
         controller_trace_prefix: 'controllers.',
         access_token: '',
         host: 'lightstep-collector.linkerd',
+        interceptors: nil,
         port: 4140,
         ssl_verify_peer: true,
         open_timeout: 20,
@@ -106,6 +107,7 @@ module Bigcommerce
         self.verbosity = ENV.fetch('LIGHTSTEP_VERBOSITY', 1).to_i
         self.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
         self.enabled = ENV.fetch('LIGHTSTEP_ENABLED', 1).to_i.positive?
+        self.interceptors = ::Bigcommerce::Lightstep::Interceptors::Registry.new
       end
 
       ##

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

@@ -0,0 +1,36 @@
+# 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
+      ##
+      # Hydrates span tags with specified ENV vars
+      #
+      class Base
+        def initialize(*); end
+
+        ##
+        # @param [::LightStep::Span] span
+        #
+        def call(*)
+          raise NotImplementedError, 'Please implement .call on your subclassed interceptor'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# 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
+      ##
+      # Hydrates span tags with specified ENV vars
+      #
+      class Env < Base
+        PRESET_NOMAD = {
+          'container.cpu': 'NOMAD_CPU_LIMIT',
+          'container.mem': 'NOMAD_MEMORY_LIMIT',
+          'git.sha': 'NOMAD_META_SHA',
+          'nomad.task_name': 'NOMAD_TASK_NAME',
+          'provider.region': 'NOMAD_REGION',
+          'provider.datacenter': 'NOMAD_DC'
+        }.freeze
+
+        ##
+        # @param [Hash] keys A hash of span->env key mappings
+        # @param [ENV] env The ENV class to get variables from
+        # @param [Array<Symbol>] presets Specify presets that automatically setup keys
+        #
+        def initialize(keys: nil, env: nil, presets: [])
+          @keys = keys || {}
+          @presets = presets || []
+          @env = env || ENV
+          augment_keys_with_presets!
+        end
+
+        ##
+        # @param [::LightStep::Span] span
+        #
+        def call(span:)
+          @keys.each do |span_key, env_key|
+            value = @env.fetch(env_key.to_s, nil)
+            span.set_tag(span_key.to_s.downcase.tr('-', '_').strip, value.nil? ? '' : value)
+          end
+
+          yield span
+        end
+
+        private
+
+        ##
+        # Augment keys based on presets
+        #
+        def augment_keys_with_presets!
+          @presets.each do |preset|
+            case preset
+            when :nomad
+              @keys.merge!(PRESET_NOMAD)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-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
+      ##
+      # Thread-safe registry for interceptors
+      #
+      class Registry
+        def initialize
+          @registry = []
+        end
+
+        ##
+        # Add to the thread-safe registry
+        #
+        # @param [Class] klass The class to add
+        # @param [Hash] options A hash of options to pass into the class during initialization
+        #
+        def use(klass, options = {})
+          registry_mutex do
+            @registry << {
+              klass: klass,
+              options: options
+            }
+          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
+        #
+        def clear
+          registry_mutex do
+            @registry = []
+          end
+        end
+
+        ##
+        # @return [Integer] The number of items currently loaded
+        #
+        def count
+          registry_mutex do
+            @registry ||= []
+            @registry.count
+          end
+        end
+
+        ##
+        # Return a list of the classes in the registry in their execution order
+        #
+        # @return [Array<Class>]
+        #
+        def list
+          registry_mutex do
+            @registry.map { |h| h[:klass] }
+          end
+        end
+
+        ##
+        # Load and return all items
+        #
+        # @return [Array<Object>]
+        #
+        def all
+          is = []
+          registry_mutex do
+            @registry.each do |o|
+              is << o[:klass].new(o[:options])
+            end
+          end
+          is
+        end
+
+        private
+
+        ##
+        # Handle mutations to the registry in a thread-safe manner
+        #
+        def registry_mutex(&block)
+          @registry_mutex ||= begin
+            require 'monitor'
+            Monitor.new
+          end
+          @registry_mutex.synchronize(&block)
+        end
+      end
+    end
+  end
+end
+
+require_relative 'base'
+require_relative 'env'

data/lib/bigcommerce/lightstep/tracer.rb

@@ -23,7 +23,9 @@ module Bigcommerce
     class Tracer
       private
 
-      def initialize; end
+      def initialize
+        @interceptors = Bigcommerce::Lightstep.interceptors || Bigcommerce::Lightstep::Interceptors::Registry.new
+      end
 
       public
 
@@ -66,7 +68,9 @@ module Bigcommerce
         # run the process
         result = nil
         begin
-          result = yield span
+          @interceptors.intercept(span) do |inner_span|
+            result = yield inner_span
+          end
         rescue StandardError
           span.set_tag('error', true)
           raise

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,9 @@ files:
 - lib/bigcommerce/lightstep.rb
 - lib/bigcommerce/lightstep/configuration.rb
 - lib/bigcommerce/lightstep/errors.rb
+- lib/bigcommerce/lightstep/interceptors/base.rb
+- lib/bigcommerce/lightstep/interceptors/env.rb
+- lib/bigcommerce/lightstep/interceptors/registry.rb
 - lib/bigcommerce/lightstep/middleware/faraday.rb
 - lib/bigcommerce/lightstep/rails_controller_instrumentation.rb
 - lib/bigcommerce/lightstep/redis/tracer.rb
@@ -141,7 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Gem for lightstep distributed tracing