bc-lightstep-ruby 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8c27ea5cc9408b41c8786c4dbc2c7f637fb7de271ff54f9b51bc95b2efef5a
-  data.tar.gz: 34439ce990947965dfeb07a573e9865bf5e6dc31eb2318d04ae651be85ab8bc3
+  metadata.gz: '08b3dfd38b99345cdd590559e482f4d4d311a64a4538f613ae747ef8b2f19163'
+  data.tar.gz: 6e6d9d623759b64a507b25e99836b73219ed77ac3fa3fe296d76bda44b5d4f9c
 SHA512:
-  metadata.gz: 0dc933fa3929ab32e05eaf12f97c30c7fd48043c8e9e8ea1bf1391138860f93e33d3574b476992e7994e61cee6eb3d0d0bb0b26cf840bee6a6ecf35c12060164
-  data.tar.gz: 1956ad38a1f0cfa14195271eca7977cb7628a09ba832eae94a8a854a5a531e540a2775bce737005668b197c07190a3d32715974d284654623811fd86a92e4f83
+  metadata.gz: 6bfde25f2c8fd028f94b81bb0c96913da02db77d8b59fa2c14b550dcafebc2df83242d3f50983d4b532500c0736a952c5bd504f923aaee4f20a64c2659127b00
+  data.tar.gz: a8a27fb95a8f18c1f9f88bc2aaa6e548b2338d8825ce6fbc0a24515ebe37e91d153046c78ab49f8fdd4976e8152f9ecee5d877291f6b72aabb889b3b62833d0b

data/CHANGELOG.md

@@ -2,6 +2,25 @@ Changelog for the bc-lightstep-ruby gem.
 
 ### Pending Release
 
+### 2.3.0
+
+- Add support for Ruby 3
+
+### 2.2.2
+
+- Fix issue where parent span determination can be nil if lightstep is not initialized
+- Add tests for Ruby 2.7
+
+### 2.2.1
+
+- Only set error tag in exceptions if not already set
+- Update to Rubocop 1.0
+
+### 2.1.1
+
+- Bump lightstep gem to 0.16.0
+- Bump faraday gem to <= 0.17.3
+
 ### 2.1.0
 
 - Add support for automatically-generated mysql spans in tracing

data/README.md

@@ -1,6 +1,6 @@
 # bc-lightstep-ruby - LightStep distributed tracing
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/bc-lightstep-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/bc-lightstep-ruby/tree/master) [![Gem Version](https://badge.fury.io/rb/bc-lightstep-ruby.svg)](https://badge.fury.io/rb/bc-lightstep-ruby) [![Inline docs](http://inch-ci.org/github/bigcommerce/bc-lightstep-ruby.svg?branch=master)](http://inch-ci.org/github/bigcommerce/bc-lightstep-ruby)
+[![CircleCI](https://circleci.com/gh/bigcommerce/bc-lightstep-ruby/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/bc-lightstep-ruby/tree/main) [![Gem Version](https://badge.fury.io/rb/bc-lightstep-ruby.svg)](https://badge.fury.io/rb/bc-lightstep-ruby) [![Inline docs](http://inch-ci.org/github/bigcommerce/bc-lightstep-ruby.svg?branch=main)](http://inch-ci.org/github/bigcommerce/bc-lightstep-ruby)
 
 Adds [LightStep](https://lightstep.com) tracing support for Ruby. This is an extension of the 
 [LightStep ruby gem](https://github.com/lightstep/lightstep-tracer-ruby) and adds extra functionality and resiliency.

data/bc-lightstep-ruby.gemspec

@@ -15,7 +15,7 @@
 # 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.
 #
-$:.push File.expand_path('../lib', __FILE__)
+$:.push File.expand_path('lib', __dir__)
 require 'bigcommerce/lightstep/version'
 
 Gem::Specification.new do |spec|
@@ -34,12 +34,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6'
 
   spec.add_development_dependency 'activerecord', '> 4'
-  spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'bundler-audit', '~> 0.6'
   spec.add_development_dependency 'rake', '>= 12.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
-  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'pry', '>= 0.12'
 
@@ -47,6 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'redis', '~> 4'
 
   spec.add_runtime_dependency 'activesupport', '>= 4'
-  spec.add_runtime_dependency 'lightstep', '~> 0.13.0'
-  spec.add_runtime_dependency 'faraday', ['>= 0.8', '<= 0.15.4']
+  spec.add_runtime_dependency 'lightstep', '~> 0.17.0'
+  spec.add_runtime_dependency 'faraday', ['>= 0.8', '<= 0.17.3']
 end

data/lib/bigcommerce/lightstep.rb

@@ -42,6 +42,12 @@ module Bigcommerce
   module Lightstep
     extend Configuration
 
+    ##
+    # Start the global tracer and configure LightStep
+    #
+    # @param [String] component_name
+    # @param [::Bigcommerce::Lightstep::TransportFactory] transport_factory
+    #
     def self.start(component_name: nil, transport_factory: nil)
       component_name ||= ::Bigcommerce::Lightstep.component_name
       transport_factory ||= ::Bigcommerce::Lightstep::TransportFactory.new

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

@@ -32,7 +32,7 @@ module Bigcommerce
           @tracer = tracer || ::Bigcommerce::Lightstep::Tracer.instance
           @span_prefix = span_prefix || ::Bigcommerce::Lightstep.active_record_span_prefix
           @span_name = span_name || 'mysql'
-          @allow_root_spans = !allow_root_spans.nil? ? allow_root_spans : ::Bigcommerce::Lightstep.active_record_allow_root_spans
+          @allow_root_spans = allow_root_spans.nil? ? ::Bigcommerce::Lightstep.active_record_allow_root_spans : allow_root_spans
         end
 
         ##
@@ -68,7 +68,7 @@ module Bigcommerce
         # @return [String]
         #
         def key
-          !@span_prefix.to_s.empty? ? "#{@span_prefix}.mysql" : 'mysql'
+          @span_prefix.to_s.empty? ? 'mysql' : "#{@span_prefix}.mysql"
         end
 
         ##

data/lib/bigcommerce/lightstep/configuration.rb

@@ -98,7 +98,7 @@ module Bigcommerce
           send("#{k}=".to_sym, v)
         end
 
-        default_logger = ::Logger.new(STDOUT)
+        default_logger = ::Logger.new($stdout)
         default_logger.level = ::Logger::INFO
         self.logger = defined?(Rails) ? Rails.logger : default_logger
 

data/lib/bigcommerce/lightstep/errors.rb

@@ -19,6 +19,7 @@ module Bigcommerce
   module Lightstep
     module Errors
       class Error < StandardError; end
+
       class InvalidAccessToken < Error; end
     end
   end

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

@@ -34,7 +34,7 @@ module Bigcommerce
         }.freeze
 
         PRESET_HOSTNAME = {
-          'hostname': 'HOSTNAME'
+          hostname: 'HOSTNAME'
         }.freeze
 
         ##
@@ -43,6 +43,7 @@ module Bigcommerce
         # @param [Array<Symbol>] presets Specify presets that automatically setup keys
         #
         def initialize(keys: nil, env: nil, presets: [])
+          super()
           @keys = keys || {}
           @presets = presets || []
           @env = env || ENV

data/lib/bigcommerce/lightstep/middleware/faraday.rb

@@ -30,7 +30,7 @@ module Bigcommerce
         OT_TAG_SAMPLED = 'ot-tracer-sampled'
 
         def initialize(app, service_name = nil)
-          @app = app
+          super(app)
           @service_name = (service_name || 'external').to_s
         end
 

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

@@ -52,7 +52,7 @@ module Bigcommerce
           return yield unless @tracer
 
           # only take the command, not any arguments
-          command = statement.to_s.split(' ').first
+          command = statement.to_s.split.first
 
           # skip excluded commands
           return yield if excluded?(command.to_s)

data/lib/bigcommerce/lightstep/tracer.rb

@@ -66,7 +66,7 @@ module Bigcommerce
             result = yield inner_span
           end
         rescue StandardError
-          span.set_tag('error', true)
+          span.set_tag('error', true) unless span.tags.key?('error')
           raise
         ensure
           # finish this span if the reporter is initialized
@@ -128,7 +128,7 @@ module Bigcommerce
       def determine_parent(context:)
         # first attempt to find parent from args, if not, use carrier (headers) to lookup parent
         # 1 = FORMAT_TEXT_MAP (this constant is removed in future lightstep versions)
-        current_parent = context.is_a?(::LightStep::SpanContext) ? context : tracer.extract(1, context || {})
+        current_parent = extract_parent_from_context(context)
         # if no passed in parent, use the active thread parent
         current_parent = active_span if current_parent.nil?
         current_parent
@@ -155,6 +155,22 @@ module Bigcommerce
       def mark_root_span(span)
         span.instance_variable_set(:@root_span, true)
       end
+
+      ##
+      # @param [Hash|::LightStep::SpanContext] context
+      # @return [::LightStep::SpanContext]
+      # @return [NilClass]
+      #
+      def extract_parent_from_context(context)
+        return context if context.is_a?(::LightStep::SpanContext)
+
+        tracer.extract(1, context || {})
+      rescue StandardError => _e
+        # sometimes LightStep, when `start` is not run first, will error here. This protects this until the upstream
+        # library can be fixed. We essentially just want to silently no-op here, as this failing simply means there's
+        # no context to extract.
+        nil
+      end
     end
   end
 end

data/lib/bigcommerce/lightstep/transport.rb

@@ -34,6 +34,22 @@ module Bigcommerce
       LIGHTSTEP_PORT = 443
       REPORTS_API_ENDPOINT = '/api/v0/reports'
 
+      DEFAULT_OPEN_TIMEOUT = 20
+      DEFAULT_READ_TIMEOUT = 20
+      DEFAULT_KEEPALIVE_TIMEOUT = 2
+      DEFAULT_SSL_PORT = 443
+
+      ##
+      # Verbosity levels for the transport
+      #
+      class Verbosity
+        FATAL = 0
+        ERROR = 1
+        WARN = 2
+        INFO = 3
+        DEBUG = 4
+      end
+
       # Initialize the transport
       # @param host [String] host of the domain to the endpoind to push data
       # @param port [Numeric] port on which to connect
@@ -44,31 +60,34 @@ module Bigcommerce
       # @return [Transport]
       def initialize(
         access_token:,
-        host: LIGHTSTEP_HOST,
-        port: LIGHTSTEP_PORT,
-        verbose: 0,
-        encryption: ENCRYPTION_TLS,
+        host: nil,
+        port: nil,
+        verbose: nil,
+        encryption: nil,
         ssl_verify_peer: true,
-        open_timeout: 2,
-        read_timeout: 2,
+        ssl_port: nil,
+        open_timeout: nil,
+        read_timeout: nil,
         continue_timeout: nil,
-        keep_alive_timeout: 2,
+        keep_alive_timeout: nil,
         logger: nil
       )
-        @host = host
-        @port = port
-        @verbose = verbose
-        @encryption = encryption
+        @host = host || LIGHTSTEP_HOST
+        @port = port || LIGHTSTEP_PORT
+        @verbose = verbose || Verbosity::FATAL
+        @encryption = encryption || ENCRYPTION_TLS
         @ssl_verify_peer = ssl_verify_peer
-        @open_timeout = open_timeout.to_i
-        @read_timeout = read_timeout.to_i
+        @ssl_port = (ssl_port || DEFAULT_SSL_PORT).to_i
+        @open_timeout = (open_timeout || DEFAULT_OPEN_TIMEOUT).to_i
+        @read_timeout = (read_timeout || DEFAULT_READ_TIMEOUT).to_i
         @continue_timeout = continue_timeout
-        @keep_alive_timeout = keep_alive_timeout.to_i
+        @keep_alive_timeout = (keep_alive_timeout || DEFAULT_KEEPALIVE_TIMEOUT).to_i
         @access_token = access_token.to_s
 
-        default_logger = ::Logger.new(STDOUT)
+        default_logger = ::Logger.new($stdout)
         default_logger.level = ::Logger::INFO
         @logger = logger || default_logger
+        super()
       end
 
       ##
@@ -78,12 +97,12 @@ module Bigcommerce
       # @return [NilClass]
       #
       def report(report)
-        @logger.info report if @verbose >= 3
+        @logger.info report if @verbose >= Verbosity::INFO
 
         req = build_request(report)
         res = connection.request(req)
 
-        @logger.info res.to_s if @verbose >= 3
+        @logger.info res.to_s if @verbose >= Verbosity::INFO
 
         nil
       end
@@ -109,7 +128,7 @@ module Bigcommerce
       def connection
         unless @connection
           @connection = ::Net::HTTP.new(@host, @port)
-          if @port == 443
+          if @port == @ssl_port
             @connection.use_ssl = @encryption == ENCRYPTION_TLS
             @connection.verify_mode = ::OpenSSL::SSL::VERIFY_NONE unless @ssl_verify_peer
           end

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '2.1.0'
+    VERSION = '2.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -201,7 +187,7 @@ dependencies:
         version: '0.8'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,7 +197,7 @@ dependencies:
         version: '0.8'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 0.17.3
 description: Gem for lightstep distributed tracing
 email:
 - shaun.mccormick@bigcommerce.com
@@ -245,7 +231,7 @@ homepage: https://github.com/bigcommerce/bc-lightstep-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +246,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Gem for lightstep distributed tracing
 test_files: []