bc-lightstep-ruby 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ca22705b74ee7e761a63732cc416f45ca6a9db01a4a8c28615db57342301b1
-  data.tar.gz: e9856c08fc1bfacec3f57d8f9481d278c1133db5bbc199b14428782b4ad7b805
+  metadata.gz: 7589e9edaad478590eb9d013c737a3ea8a49f20ee84edfcb4ee8e6af9900a068
+  data.tar.gz: fb544f39b1f223111ab96c47839fd4706d0e1c0772b737add936b21a83f82cd6
 SHA512:
-  metadata.gz: 35096ce470d7bb32b059752e14612ebed5815e88b885c851e9e20c62e6bee0c41e512244b4ef462ccb2b5f7c07ef27d5509ed1c01697a1742ff46b1035c30770
-  data.tar.gz: 595f9ff72ee56b899b959cfbc5f7fb5e0b370db4fa40da7eaa7a673e48ca89068f04904685cff78c548d4d7aaee3590ea41cd8be2f82d605c1d0ce59a751826c
+  metadata.gz: 4bd6e24028f387fe63d59a23d4adee468a60fa2493a4614975159f3498ea9331d71fb55cc9db8727f06cfdfaaa5890a70e50d199247997abba5f2db1f8c034df
+  data.tar.gz: 534f92acb60ee987cbc852d845a6b8b1cd65e96e9876818f848bfae5d90220f5b0faf8d8465f1f25087528fee615c91dea557a90f19a8e96e0694a37b3e9f4ac

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Changelog for the bc-lightstep-ruby gem.
 
 h3. Pending Release
 
+h3. 1.6.0
+
+- Allow for instantiation of interceptors at initialization time
+- Pre-build tag values for ENV interceptor at initialization to reduce CPU usage per-span
+
 h3. 1.5.2
 
 - Add rspec helper for testing custom lightstep spans

data/README.md

@@ -102,6 +102,44 @@ it 'should create a lightstep span' do
 end
 ```
 
+## Global Interceptors
+
+This library has global interceptor support that will allow access to each span as it is built. This allows you to
+dynamically inject tags or alter spans as they are collected. You can configure interceptors via an initializer:
+
+```ruby
+Bigcommerce::Lightstep.configure do |c|
+  c.interceptors.use(MyInterceptor, an_option: 123)
+  # or, alternatively:
+  c.interceptors.use(MyInterceptor.new(an_option: 123)) 
+end
+```
+
+It's important to note that this is a CPU-intensive operation as interceptors will be run for every `start_span` tag,
+so don't build interceptors that require lots of processing power or that would impact latencies.
+
+### ENV Interceptor
+
+Provided out of the box is an interceptor to automatically inject ENV vars into span tags. You can configure like so:
+
+```ruby
+
+Bigcommerce::Lightstep.configure do |c|
+  c.interceptors.use(::Bigcommerce::Lightstep::Interceptors::Env.new(
+    keys: {
+      version: 'VERSION'
+    },
+    presets: [:nomad, :hostname]
+  ))
+end
+```
+
+The `keys` argument allows you to pass a `span tag => ENV key` mapping that will assign those ENV vars to spans. The
+`presets` argument comes with a bunch of preset mappings you can use rather than manually mapping them yourself.
+
+Note that this interceptor _must_ be instantiated in configuration, rather than passing the class and options,
+as it needs to pre-materialize the ENV values to reduce CPU usage. 
+
 ## License
 
 Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 

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

@@ -45,15 +45,17 @@ module Bigcommerce
           @presets = presets || []
           @env = env || ENV
           augment_keys_with_presets!
+          collect_values!
         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)
+          value_mutex do
+            @values.each do |span_key, value|
+              span.set_tag(span_key, value)
+            end
           end
 
           yield span
@@ -61,6 +63,21 @@ module Bigcommerce
 
         private
 
+        ##
+        # Pre-collect values at start
+        #
+        def collect_values!
+          value_mutex do
+            @values = {}
+            @keys.each do |span_key, env_key|
+              value = @env.fetch(env_key.to_s, nil)
+              value = value.nil? ? '' : value
+              @values[span_key.to_s.downcase.tr('-', '_').strip] = value
+            end
+            @values
+          end
+        end
+
         ##
         # Augment keys based on presets
         #
@@ -74,6 +91,17 @@ module Bigcommerce
             end
           end
         end
+
+        ##
+        # Handle access to values in a thread-safe manner
+        #
+        def value_mutex(&block)
+          @value_mutex ||= begin
+            require 'monitor'
+            Monitor.new
+          end
+          @value_mutex.synchronize(&block)
+        end
       end
     end
   end

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

@@ -29,8 +29,8 @@ module Bigcommerce
         ##
         # 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
+        # @param [Class|Object] klass The class to add or object to register.
+        # @param [Hash] options (Optional) A hash of options to pass into the class during initialization
         #
         def use(klass, options = {})
           registry_mutex do
@@ -85,7 +85,9 @@ module Bigcommerce
         #
         def list
           registry_mutex do
-            @registry.map { |h| h[:klass] }
+            @registry.map do |h|
+              h[:klass].instance_of?(Class) ? h[:klass] : h[:klass].class
+            end
           end
         end
 
@@ -95,13 +97,11 @@ module Bigcommerce
         # @return [Array<Object>]
         #
         def all
-          is = []
           registry_mutex do
-            @registry.each do |o|
-              is << o[:klass].new(o[:options])
+            @registry.map do |o|
+              o[:klass].is_a?(Class) ? o[:klass].new(o[:options]) : o[:klass]
             end
           end
-          is
         end
 
         private

data/lib/bigcommerce/lightstep/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler