bc-lightstep-ruby 1.6.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca2346b27774fd1f2a8429ea57c36d0a0d182d79a1ccad116e1fe4fc6e165ab6
-  data.tar.gz: 98984a6f2c4724c7d2a3501e9bca87c139d8f6bcaed42a6aac7f5e52805ce2a6
+  metadata.gz: f8438758949aeee5ef6d8908fdb428a466d768b9548c50ec11d91ebfe6d4a51d
+  data.tar.gz: 1afbe2aca9eed46303b8a3a40802ead2fad62ed937638213e74f257149a3c3b2
 SHA512:
-  metadata.gz: dda3505bfa75067453146759ee0c855ee1370a6425bb7409715b894bb8545f25995114167bc4c7a667671e964900c7d01a53fe78f39e226f1cc01bf76171c67c
-  data.tar.gz: 7c58372609942e677c2ee6dc97b22a0dd917992f3aec27791950e7df43e7d2bb479a35b9dd63c53a7d42aef4a35e22f88a2d088324c24368895ea1feeb0e53fa
+  metadata.gz: ddfe877c18f72a78694074fa5d71ca8cf405638fcb4dc171417f5371fb8ea3a0d3048933e7ecf1bee1b1b785cd93e965485cf16df31ab224dea8b261797f0496
+  data.tar.gz: 60a2238aa127269ba871c21d0a4a6749ba3bcbc1752bc658fec9f1b055cc77e6b6bc3125eadd997a4b436788a90d0b909a959927b1a83718348cfa33ce7981c0

data/CHANGELOG.md

@@ -1,133 +1,156 @@
 Changelog for the bc-lightstep-ruby gem.
 
-h3. Pending Release
+### Pending Release
 
-h3. 1.6.3
+### 2.2.0
+
+- 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
+
+### 2.0.0
+
+- Drop support for Ruby < 2.6
+- Set default log level to INFO when no logger is provided
+
+### 1.6.4
+
+- Add `nomad.node.id` and `nomad.node.name` span tags via ENV mappings
+
+### 1.6.3
 
 - Add service.version to tags
 
-h3. 1.6.2
+### 1.6.2
 
 - Add span.kind tags to boundary spans
 
-h3. 1.6.1
+### 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
+### 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
+### 1.5.2
 
 - Add rspec helper for testing custom lightstep spans
 
-h3. 1.5.1
+### 1.5.1
 
 - Add `hostname` preset for env var injection into spans
 
-h3. 1.5.0
+### 1.5.0
 
 - Add interceptors that allow for global injection of tags into spans
 
-h3. 1.4.0
+### 1.4.0
 
 - Add `frozen_string_literal: true` to all files
 - Deprecate ruby 2.2 support
 
-h3. 1.3.3
+### 1.3.3
 
 - Updates gemspec to allow for newer Faraday versions
 
-h3. 1.3.2
+### 1.3.2
 
 - Fix compatibility issues with resque-scheduler and redis instrumentation
 
-h3. 1.3.1
+### 1.3.1
 
 - Add various options to suppress redis trace spam
 - Fix issue with pipeline commands in redis instrumentation
 
-h3. 1.3.0
+### 1.3.0
 
 - Adds automatic Redis instrumentation support
 
-h3. 1.2.2
+### 1.2.2
 
 - Allow for usage of blank access tokens, which can be used with disabled token checking + project-specific satellites
 
-h3. 1.2.1
+### 1.2.1
 
 - Fix issue where in Rails controllers before the action occurs that an uninitialized reporter would cause a
   NoMethodError to occur (this most commonly occurs in test suites)
 
-h3. 1.2.0
+### 1.2.0
 
 - Bump lightstep gem to 0.13
 - Add LIGHTSTEP_MAX_BUFFERED_SPANS config ENV + setting for maximum number of spans to buffer
 - Add LIGHTSTEP_MAX_LOG_RECORDS config ENV + setting for maximum number of log records that can be on a span
 - Add LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS config ENV + setting for max reporting flush interval to collector
 
-h3. 1.1.8
+### 1.1.8
 
 - Handle issue that occurs if lightstep is disabled but the start_span method is still called
 - Remove FORMAT_TEXT_MAP reference as this is no longer present in later lightstep gem versions
 
-h3. 1.1.7
+### 1.1.7
 
 - Better handling of exceptions and tagged errors
 - Lower timeouts for collector connections to reduce impact if collector is down/unreachable
 - Always ensure spans are reported even in the case of exceptional failure 
 
-h3. 1.1.6
+### 1.1.6
 
 - First OSS release
 
-h3. 1.1.5
+### 1.1.5
 
 - Pin lightstep gem to 0.11.x due to backwards-incompatible change in 0.12.x
  
-h3. 1.1.4
+### 1.1.4
 
 - Add enabled setting to explicitly disable lightstep at runtime. Can be toggled with LIGHTSTEP_ENABLED ENV var.
 
-h3. 1.1.3
+### 1.1.3
 
 - Have http1 errors only flag as error if they are 500+ status codes
 
-h3. 1.1.2
+### 1.1.2
 
 - Prevent span from starting if the reporter is not yet configured, as LightStep gem does not guard this case 
 
-h3. 1.1.1
+### 1.1.1
 
 - Fix issues where Rack/Rails is prepending HTTP_ to headers, ensure right key format into carrier
 
-h3. 1.1.0
+### 1.1.0
 
 - Add Faraday middleware for automatic tracing of outbound service calls
  
-h3. 1.0.5
+### 1.0.5
 
 - Do not send GET params in rails controller instrumentation for http.url tag
 
-h3. 1.0.4
+### 1.0.4
 
 - Rename span tags to fit the BigCommerce standardized tags
 - Handle 500 errors in H1 requests properly
 
-h3. 1.0.3
+### 1.0.3
 
 - Fix bug where active parent span was persisting between requests in rails controller requests
  
-h3. 1.0.2
+### 1.0.2
 
 - Add Bigcommerce::Lightstep::Rails::ControllerInstrumentation module for tracing H1 controllers in Rails
 
-h3. 1.0.0
+### 1.0.0
 
 - Initial public release

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.
@@ -45,10 +45,18 @@ bc-lightstep-ruby can be automatically configured from these ENV vars, if you'd
 | LIGHTSTEP_ACCESS_TOKEN | The access token to use to connect to the collector. Optional. | '' | 
 | LIGHTSTEP_HOST | Host of the collector. | `lightstep-collector.linkerd` |
 | LIGHTSTEP_PORT | Port of the collector. | `4140` |
+| LIGHTSTEP_HTTP1_ERROR_CODE | The HTTP error code to report in spans for internal errors | 500 |
+| LIGHTSTEP_HTTP1_ERROR_CODE_MINIMUM | The minimum HTTP error code value to be considered an error for span tag purposes. | 500 |
+| LIGHTSTEP_CONTROLLER_PREFIX | The prefix for Rails controllers to use | `controllers.` |
 | LIGHTSTEP_SSL_VERIFY_PEER | If using 443 as the port, toggle SSL verification. | true |
 | LIGHTSTEP_MAX_BUFFERED_SPANS | The maximum number of spans to buffer before dropping. | `1_000` |
 | LIGHTSTEP_MAX_LOG_RECORDS | Maximum number of log records on a span to accept. | `1_000` |
 | LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS | The maximum number of seconds to wait before flushing the report to the collector. | 3.0 |
+| LIGHTSTEP_ACTIVE_RECORD_ENABLED | Whether or not to add ActiveRecord mysql spans. Only works with mysql2 gem. | 1 |
+| LIGHTSTEP_ACTIVE_RECORD_ALLOW_AS_ROOT_SPAN | Allow ActiveRecord mysql spans to be the root span? | 0 |
+| LIGHTSTEP_ACTIVE_RECORD_SPAN_PREFIX | What to prefix the ActiveRecord mysql span with | '' |
+| LIGHTSTEP_REDIS_ALLOW_AS_ROOT_SPAN | Allow redis to be the root span? | 0 |
+| LIGHTSTEP_REDIS_EXCLUDED_COMMANDS | Redis commands to exclude from spans. Comma-separated list. | ping |
 | LIGHTSTEP_VERBOSITY | The verbosity level of lightstep logs. | 1 |
 
 Most systems will only need to customize the component name.
@@ -77,7 +85,7 @@ or systems outside of your instrumenting control.
 
 ### Redis
 
-This gem will automatically detect and instrumnent Redis calls when they are made using the `Redis::Client` class.
+This gem will automatically detect and instrument 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 
@@ -86,6 +94,17 @@ re-enable this by setting the `redis_allow_root_spans` configuration option to `
 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.
 
+### ActiveRecord and MySQL
+
+This gem will automatically instrument MySQL queries with spans when made with the `mysql2` gem and ActiveRecord.
+It will set as tags on the span the host, database type, database name, and a sanitized version of the SQL query made.
+The query will have no values - replaced with `?` - to ensure secure logging and no leaking of PII data.
+
+Note that this will not record mysql timings if they are a root span. This is to prevent trace spamming. You can
+configure this gem to allow it via ENV, but it is not recommended.
+
+By default, it will also exclude `COMMIT`, `SCHEMA`, and `SHOW FULL FIELDS` queries. 
+
 ## RSpec
 
 This library comes with a built-in matcher for testing span blocks. In your rspec config:

data/bc-lightstep-ruby.gemspec

@@ -31,12 +31,22 @@ Gem::Specification.new do |spec|
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'bc-lightstep-ruby.gemspec']
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6'
 
+  spec.add_development_dependency 'activerecord', '> 4'
   spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry'
+  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', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'pry', '>= 0.12'
 
-  spec.add_runtime_dependency 'lightstep', '~> 0.13.0'
-  spec.add_runtime_dependency 'faraday', ['>= 0.8', '<= 0.15.4']
+  spec.add_development_dependency 'null-logger', '~> 0.1'
+  spec.add_development_dependency 'redis', '~> 4'
+
+  spec.add_runtime_dependency 'activesupport', '>= 4'
+  spec.add_runtime_dependency 'lightstep', '~> 0.16.0'
+  spec.add_runtime_dependency 'faraday', ['>= 0.8', '<= 0.17.3']
 end

data/lib/bigcommerce/lightstep.rb

@@ -17,6 +17,7 @@
 #
 require 'lightstep'
 require 'faraday'
+require 'active_support/concern'
 require_relative 'lightstep/version'
 require_relative 'lightstep/errors'
 require_relative 'lightstep/interceptors/registry'
@@ -27,6 +28,8 @@ require_relative 'lightstep/transport_factory'
 require_relative 'lightstep/transport'
 require_relative 'lightstep/rails_controller_instrumentation'
 require_relative 'lightstep/middleware/faraday'
+require_relative 'lightstep/active_record/tracer'
+require_relative 'lightstep/active_record/adapter'
 require_relative 'lightstep/redis/tracer'
 
 ##
@@ -39,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
@@ -54,7 +63,10 @@ module Bigcommerce
       ::LightStep.instance.max_log_records = ::Bigcommerce::Lightstep.max_log_records
       ::LightStep.instance.report_period_seconds = ::Bigcommerce::Lightstep.max_reporting_interval_seconds
 
-      ::Bigcommerce::Lightstep::Redis::Wrapper.patch if ::Bigcommerce::Lightstep.enabled
+      return unless ::Bigcommerce::Lightstep.enabled
+
+      ::Bigcommerce::Lightstep::Redis::Wrapper.patch
+      ::Bigcommerce::Lightstep::ActiveRecord::Adapter.patch
     end
   end
 end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-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 ActiveRecord
+      ##
+      # Patches mysql and ActiveRecord to allow for mysql span tracing
+      #
+      module Adapter
+        extend ::ActiveSupport::Concern
+
+        ##
+        # Patch ActiveRecord to enable mysql span traces
+        #
+        def self.patch
+          return unless enabled?
+
+          # rubocop:disable Lint/SendWithMixinArgument
+          ::ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, ::Bigcommerce::Lightstep::ActiveRecord::Adapter)
+          # rubocop:enable Lint/SendWithMixinArgument
+        end
+
+        ##
+        # Note: we only support patching mysql2 gem at this point
+        #
+        # @return [Boolean]
+        #
+        def self.enabled?
+          defined?(::ActiveRecord) && ::Bigcommerce::Lightstep.active_record && ::ActiveRecord::Base.connection_config[:adapter].to_s.downcase == 'mysql2'
+        rescue StandardError => e
+          ::Bigcommerce::Lightstep.logger&.warn "Failed to determine ActiveRecord database adapter in bc-lightstep-ruby initializer: #{e.message}"
+          false
+        end
+
+        ##
+        # @param [String] sql The raw sql query
+        # @param [String] name The type of sql query
+        #
+        def execute_with_inst(sql, name = 'SQL')
+          # bail out early if not enabled. This should not get here, but is provided as a failsafe.
+          return execute_without_inst(sql, name) unless ::Bigcommerce::Lightstep.active_record
+
+          sanitized_sql = lightstep_sanitize_sql(sql)
+          name = name.to_s.strip.empty? ? 'QUERY' : name
+
+          # we dont need to track all sql
+          return execute_without_inst(sql, name) if lightstep_skip_tracing?(name, sanitized_sql)
+
+          lightstep_tracer.db_trace(
+            statement: sanitized_sql,
+            host: @config[:host],
+            adapter: @config[:adapter],
+            database: @config[:database]
+          ) do
+            execute_without_inst(sql, name)
+          end
+        end
+
+        ##
+        # Sanitize the sql for safe logging
+        #
+        # @param [String]
+        # @return [String]
+        #
+        def lightstep_sanitize_sql(sql)
+          sql.to_s.gsub(lightstep_sanitization_regexp, '?').tr("\n", ' ').to_s
+        end
+
+        ##
+        # @return [Regexp]
+        #
+        def lightstep_sanitization_regexp
+          @lightstep_sanitization_regexp ||= ::Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', ::Regexp::IGNORECASE)
+        end
+
+        ##
+        # Filter out sql queries from tracing we don't care about
+        #
+        # @param [String] name
+        # @param [String] sql
+        # @return [Boolean]
+        def lightstep_skip_tracing?(name, sql)
+          name.empty? || sql.empty? || sql.include?('COMMIT') || sql.include?('SCHEMA') || sql.include?('SHOW FULL FIELDS')
+        end
+
+        ##
+        # @return [::Bigcommerce::Lightstep::ActiveRecord::Tracer]
+        #
+        def lightstep_tracer
+          @lightstep_tracer ||= ::Bigcommerce::Lightstep::ActiveRecord::Tracer.new
+        end
+
+        included do
+          if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR > 3
+            alias_method :execute_without_inst, :execute
+            alias_method :execute, :execute_with_inst
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-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 ActiveRecord
+      ##
+      # Tracer adapter for ActiveRecord
+      #
+      class Tracer
+        ##
+        # @param [Bigcommerce::Lightstep::Tracer] tracer
+        # @param [String] span_prefix
+        # @param [Boolean] allow_root_spans
+        # @param [String] span_name
+        #
+        def initialize(tracer: nil, span_prefix: nil, span_name: nil, allow_root_spans: nil)
+          @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
+        end
+
+        ##
+        # Trace a DB call
+        #
+        # @param [String] statement
+        # @param [String] host
+        # @param [String] adapter
+        # @param [String] database
+        #
+        def db_trace(statement:, host:, adapter:, database:)
+          return yield unless @tracer
+
+          # skip if not allowing root spans and there is no active span
+          return yield if !@allow_root_spans && !active_span?
+
+          @tracer.start_span(key) do |span|
+            span.set_tag('db.host', host.to_s)
+            span.set_tag('db.type', adapter.to_s)
+            span.set_tag('db.name', database.to_s)
+            span.set_tag('db.statement', statement.to_s)
+            span.set_tag('span.kind', 'client')
+            begin
+              yield
+            rescue StandardError => _e
+              span.set_tag('error', true)
+              raise # re-raise the error
+            end
+          end
+        end
+
+        ##
+        # @return [String]
+        #
+        def key
+          !@span_prefix.to_s.empty? ? "#{@span_prefix}.mysql" : 'mysql'
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def active_span?
+          @tracer.respond_to?(:active_span) && @tracer.active_span
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/configuration.rb

@@ -23,27 +23,30 @@ module Bigcommerce
     #
     module Configuration
       VALID_CONFIG_KEYS = {
-        component_name: '',
-        controller_trace_prefix: 'controllers.',
-        access_token: '',
-        host: 'lightstep-collector.linkerd',
+        component_name: ENV.fetch('LIGHTSTEP_COMPONENT_NAME', ''),
+        controller_trace_prefix: ENV.fetch('LIGHTSTEP_CONTROLLER_PREFIX', 'controllers.'),
+        access_token: ENV.fetch('LIGHTSTEP_ACCESS_TOKEN', ''),
+        host: ENV.fetch('LIGHTSTEP_HOST', 'lightstep-collector.linkerd'),
         interceptors: nil,
-        port: 4140,
-        ssl_verify_peer: true,
-        open_timeout: 20,
-        read_timeout: 20,
+        port: ENV.fetch('LIGHTSTEP_PORT', 4_140).to_i,
+        ssl_verify_peer: ENV.fetch('LIGHTSTEP_SSL_VERIFY_PEER', 1).to_i.positive?,
+        open_timeout: ENV.fetch('LIGHTSTEP_OPEN_TIMEOUT', 2).to_i,
+        read_timeout: ENV.fetch('LIGHTSTEP_READ_TIMEOUT', 2).to_i,
         continue_timeout: nil,
-        keep_alive_timeout: 2,
+        keep_alive_timeout: ENV.fetch('LIGHTSTEP_KEEP_ALIVE_TIMEOUT', 2).to_i,
         logger: nil,
-        verbosity: 1,
-        http1_error_code: 500,
-        http1_error_code_minimum: 500,
-        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
+        verbosity: ENV.fetch('LIGHTSTEP_VERBOSITY', 1).to_i,
+        http1_error_code: ENV.fetch('LIGHTSTEP_HTTP1_ERROR_CODE', 500).to_i,
+        http1_error_code_minimum: ENV.fetch('LIGHTSTEP_HTTP1_ERROR_CODE_MINIMUM', 500).to_i,
+        max_buffered_spans: ENV.fetch('LIGHTSTEP_MAX_BUFFERED_SPANS', 1_000).to_i,
+        max_log_records: ENV.fetch('LIGHTSTEP_MAX_LOG_RECORDS', 1_000).to_i,
+        max_reporting_interval_seconds: ENV.fetch('LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS', 3.0).to_f,
+        redis_excluded_commands: ENV.fetch('LIGHTSTEP_REDIS_EXCLUDED_COMMANDS', 'ping').to_s.split(','),
+        redis_allow_root_spans: ENV.fetch('LIGHTSTEP_REDIS_ALLOW_AS_ROOT_SPAN', 0).to_i.positive?,
+        active_record: ENV.fetch('LIGHTSTEP_ACTIVE_RECORD_ENABLED', 1).to_i.positive?,
+        active_record_allow_root_spans: ENV.fetch('LIGHTSTEP_ACTIVE_RECORD_ALLOW_AS_ROOT_SPAN', 0).to_i.positive?,
+        active_record_span_prefix: ENV.fetch('LIGHTSTEP_ACTIVE_RECORD_SPAN_PREFIX', ''),
+        enabled: ENV.fetch('LIGHTSTEP_ENABLED', 1).to_i.positive?
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys
@@ -94,19 +97,11 @@ module Bigcommerce
         VALID_CONFIG_KEYS.each do |k, v|
           send("#{k}=".to_sym, v)
         end
-        self.component_name = ENV.fetch('LIGHTSTEP_COMPONENT_NAME', '')
-        self.access_token = ENV.fetch('LIGHTSTEP_ACCESS_TOKEN', '')
-        self.host = ENV.fetch('LIGHTSTEP_HOST', 'lightstep-collector.linkerd')
-        self.port = ENV.fetch('LIGHTSTEP_PORT', 4140).to_i
-        self.ssl_verify_peer = ENV.fetch('LIGHTSTEP_SSL_VERIFY_PEER', true)
 
-        self.max_buffered_spans = ENV.fetch('LIGHTSTEP_MAX_BUFFERED_SPANS', 1_000).to_i
-        self.max_log_records = ENV.fetch('LIGHTSTEP_MAX_LOG_RECORDS', 1_000).to_i
-        self.max_reporting_interval_seconds = ENV.fetch('LIGHTSTEP_MAX_REPORTING_INTERVAL_SECONDS', 3.0).to_f
+        default_logger = ::Logger.new($stdout)
+        default_logger.level = ::Logger::INFO
+        self.logger = defined?(Rails) ? Rails.logger : default_logger
 
-        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/env.rb

@@ -26,6 +26,8 @@ module Bigcommerce
           'container.cpu': 'NOMAD_CPU_LIMIT',
           'container.mem': 'NOMAD_MEMORY_LIMIT',
           'git.sha': 'NOMAD_META_SHA',
+          'nomad.node.id': 'NOMAD_NODE_ID',
+          'nomad.node.name': 'NOMAD_NODE_NAME',
           'nomad.task_name': 'NOMAD_TASK_NAME',
           'provider.region': 'NOMAD_REGION',
           'provider.datacenter': 'NOMAD_DC'
@@ -41,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/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,28 +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
-        @logger = logger || ::Logger.new(STDOUT)
+
+        default_logger = ::Logger.new($stdout)
+        default_logger.level = ::Logger::INFO
+        @logger = logger || default_logger
+        super()
       end
 
       ##
@@ -75,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
@@ -106,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/transport_factory.rb

@@ -32,6 +32,10 @@ module Bigcommerce
           encryption: ::Bigcommerce::Lightstep.port.to_i == 443 ? ::Bigcommerce::Lightstep::Transport::ENCRYPTION_TLS : ::Bigcommerce::Lightstep::Transport::ENCRYPTION_NONE,
           ssl_verify_peer: ::Bigcommerce::Lightstep.ssl_verify_peer,
           access_token: ::Bigcommerce::Lightstep.access_token,
+          open_timeout: ::Bigcommerce::Lightstep.open_timeout,
+          read_timeout: ::Bigcommerce::Lightstep.read_timeout,
+          continue_timeout: ::Bigcommerce::Lightstep.continue_timeout,
+          keep_alive_timeout: ::Bigcommerce::Lightstep.keep_alive_timeout,
           logger: ::Bigcommerce::Lightstep.logger
         )
       end

data/lib/bigcommerce/lightstep/version.rb

@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '1.6.3'
+    VERSION = '2.2.0'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,61 +39,159 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: null-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: lightstep
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +201,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
@@ -99,7 +211,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
@@ -112,6 +224,8 @@ files:
 - README.md
 - bc-lightstep-ruby.gemspec
 - lib/bigcommerce/lightstep.rb
+- lib/bigcommerce/lightstep/active_record/adapter.rb
+- lib/bigcommerce/lightstep/active_record/tracer.rb
 - lib/bigcommerce/lightstep/configuration.rb
 - lib/bigcommerce/lightstep/errors.rb
 - lib/bigcommerce/lightstep/interceptors/base.rb
@@ -131,7 +245,7 @@ homepage: https://github.com/bigcommerce/bc-lightstep-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -147,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem for lightstep distributed tracing
 test_files: []