bc-lightstep-ruby 1.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae2b58de5cad4cb1d3f95f0392e8e5a2f26bc92d7166f0786973d1db2365c34c
+  data.tar.gz: fb76f4e5520ae29ba6c9cf51765ea4ef29b953478edece1d0d613bd38969b7a1
+SHA512:
+  metadata.gz: ce9814bbece997fe409cf3bf369a7c4ee086b14c486e9d16eeae7bd10ffe9a9a69b2d60c591dd111587dbfa5d485da82091211b72d829b27fb2ee22e2c21ff41
+  data.tar.gz: 6112a5d04acc35a38109cc5541fd88d2571e7ba699ec64a1bde19007bf442ed2c482619de4b65b8ae035a94eb4d5c9554c5dc10c9065891833b6744543074932

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+Changelog for the bc-lightstep-ruby gem.
+
+h3. Pending Release
+
+h3. 1.1.6
+
+- First OSS release
+
+h3. 1.1.5
+
+- Pin lightstep gem to 0.11.x due to backwards-incompatible change in 0.12.x
+ 
+h3. 1.1.4
+
+- Add enabled setting to explicitly disable lightstep at runtime. Can be toggled with LIGHTSTEP_ENABLED ENV var.
+
+h3. 1.1.3
+
+- Have http1 errors only flag as error if they are 500+ status codes
+
+h3. 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
+
+- Fix issues where Rack/Rails is prepending HTTP_ to headers, ensure right key format into carrier
+
+h3. 1.1.0
+
+- Add Faraday middleware for automatic tracing of outbound service calls
+ 
+h3. 1.0.5
+
+- Do not send GET params in rails controller instrumentation for http.url tag
+
+h3. 1.0.4
+
+- Rename span tags to fit the BigCommerce standardized tags
+- Handle 500 errors in H1 requests properly
+
+h3. 1.0.3
+
+- Fix bug where active parent span was persisting between requests in rails controller requests
+ 
+h3. 1.0.2
+
+- Add Bigcommerce::Lightstep::Rails::ControllerInstrumentation module for tracing H1 controllers in Rails
+
+h3. 1.0.0
+
+- Initial public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at splittingred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,90 @@
+# bc-lightstep-ruby - LightStep distributed tracing
+
+[![Build Status](https://travis-ci.com/bigcommerce/bc-lightstep-ruby.svg?token=D3Cc4LCF9BgpUx4dpPpv&branch=master)](https://travis-ci.com/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.
+
+## Installation
+
+```ruby
+gem 'bc-lightstep-ruby', git: 'git@github.com/bigcommerce/bc-lightstep-ruby'
+```
+
+Then in an initializer or before use:
+
+```ruby
+require 'bigcommerce/lightstep'
+Bigcommerce::Lightstep.configure do |c|
+  c.component_name = 'myapp'
+  c.access_token = 'abcdefg'
+  c.host = 'my.lightstep.service.io'
+  c.port = 8080
+  c.verbosity = 1
+end
+```
+
+Then in your script:
+
+```ruby
+tracer = Bigcommerce::Lightstep::Tracer.instance
+tracer.start_span('my-span', context: request.headers) do |span|
+  span.set_tag('my-tag', 'value')
+  # do thing to measure
+end
+```
+
+### Environment Config
+
+bc-lightstep-ruby can be automatically configured from these ENV vars, if you'd rather use that instead:
+
+| Name | Description |
+| ---- | ----------- |
+| LIGHTSTEP_ENABLED | Flag to determine whether to broadcast spans. Defaults to 1 (enabled) and 0 will disable.|
+| LIGHTSTEP_COMPONENT_NAME | The component name to use |
+| LIGHTSTEP_ACCESS_TOKEN | The access token to use to connect to the collector |
+| LIGHTSTEP_HOST | Host of the collector. Defaults to `lightstep-collector.linkerd` |
+| LIGHTSTEP_PORT | Port of the collector. Defaults to `4140` |
+| LIGHTSTEP_SSL_VERIFY_PEER | If using 443 as the port, toggle SSL verification. Defaults to true. |
+| LIGHTSTEP_VERBOSITY | The verbosity level of lightstep logs. Defaults to 1. |
+
+Most BC systems will only need to customize the component name.
+
+### Instrumenting Rails Controllers
+
+Just drop this include into ApplicationController:
+
+```ruby
+include Bigcommerce::Lightstep::RailsControllerInstrumentation
+```
+
+### Faraday Middleware
+
+To use the supplied faraday middleware, simply:
+
+```ruby
+Faraday.new do |faraday|
+  faraday.use Bigcommerce::Lightstep::Middleware::Faraday, 'name-of-external-service'
+end
+```
+
+Spans will be built with the external service name. It's generally _not_ a good idea to use the Faraday adapter
+with internal services that are also instrumented with LightStep - use the Faraday adapter on external services
+or systems outside of our instrumenting control. 
+
+## License
+
+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.

data/bc-lightstep-ruby.gemspec

@@ -0,0 +1,40 @@
+# 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.
+#
+$:.push File.expand_path('../lib', __FILE__)
+require 'bigcommerce/lightstep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bc-lightstep-ruby'
+  spec.version       = Bigcommerce::Lightstep::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = %q{Gem for lightstep distributed tracing}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/bc-lightstep-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'bc-lightstep-ruby.gemspec']
+  spec.require_paths = ['lib']
+
+  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_runtime_dependency 'lightstep', '~> 0.11.2'
+  spec.add_runtime_dependency 'faraday', '~> 0.8'
+end

data/lib/bigcommerce/lightstep.rb

@@ -0,0 +1,93 @@
+# 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.
+#
+require 'lightstep'
+require 'faraday'
+require_relative 'lightstep/version'
+require_relative 'lightstep/errors'
+require_relative 'lightstep/configuration'
+require_relative 'lightstep/tracer'
+require_relative 'lightstep/transport_factory'
+require_relative 'lightstep/transport'
+require_relative 'lightstep/rails_controller_instrumentation'
+require_relative 'lightstep/middleware/faraday'
+
+##
+# Main base module
+module Bigcommerce
+  ##
+  # Lightstep module
+  #
+  module Lightstep
+    extend Configuration
+
+    def self.start(component_name: nil, transport_factory: nil)
+      component_name ||= ::Bigcommerce::Lightstep.component_name
+      transport_factory ||= ::Bigcommerce::Lightstep::TransportFactory.new
+      ::LightStep.logger = logger
+      ::LightStep.configure(
+        component_name: component_name,
+        transport: transport_factory.build
+      )
+    end
+  end
+end
+
+# :nocov:
+module LightStep
+  ##
+  # Monkey patch of the LightStep library to make it not swallow reporting errors
+  #
+  class Reporter
+    def flush
+      reset_on_fork
+
+      return if @span_records.empty?
+
+      now = ::LightStep.micros(Time.now)
+
+      span_records = @span_records.slice!(0, @span_records.length)
+      dropped_spans = 0
+      @dropped_spans.update do |old|
+        dropped_spans = old
+        0
+      end
+
+      report_request = {
+        runtime: @runtime,
+        oldest_micros: @report_start_time,
+        youngest_micros: now,
+        span_records: span_records,
+        internal_metrics: {
+          counts: [
+            { name: 'spans.dropped', int64_value: dropped_spans }
+          ]
+        }
+      }
+
+      @report_start_time = now
+
+      begin
+        @transport.report(report_request)
+      rescue StandardError => e
+        Bigcommerce::Lightstep.logger.error "Failed to send request to collector: #{e.message}"
+        # an error occurs, add the previous dropped_spans and count of spans
+        # that would have been recorded
+        @dropped_spans.increment(dropped_spans + span_records.length)
+      end
+    end
+  end
+end
+# :nocov:

data/lib/bigcommerce/lightstep/configuration.rb

@@ -0,0 +1,111 @@
+# 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
+    ##
+    # General configuration for lightstep integration
+    #
+    module Configuration
+      VALID_CONFIG_KEYS = {
+        component_name: '',
+        controller_trace_prefix: 'controllers.',
+        access_token: '',
+        host: 'lightstep-collector.linkerd',
+        port: 4140,
+        ssl_verify_peer: true,
+        open_timeout: 20,
+        read_timeout: 20,
+        continue_timeout: nil,
+        keep_alive_timeout: 2,
+        logger: nil,
+        verbosity: 1,
+        http1_error_code: 500,
+        http1_error_code_minimum: 500,
+        enabled: true
+      }.freeze
+
+      attr_accessor *VALID_CONFIG_KEYS.keys
+
+      ##
+      # Whenever this is extended into a class, setup the defaults
+      #
+      def self.extended(base)
+        base.reset
+      end
+
+      ##
+      # Yield self for ruby-style initialization
+      #
+      # @yields [Bigcommerce::Instrumentation::Configuration]
+      # @return [Bigcommerce::Instrumentation::Configuration]
+      #
+      def configure
+        reset unless @configured
+        yield self
+        @configured = true
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def configured?
+        @configured
+      end
+
+      ##
+      # Return the current configuration options as a Hash
+      #
+      # @return [Hash]
+      #
+      def options
+        opts = {}
+        VALID_CONFIG_KEYS.each_key do |k|
+          opts.merge!(k => send(k))
+        end
+        opts
+      end
+
+      ##
+      # Set the default configuration onto the extended class
+      #
+      def reset
+        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.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 > 0
+      end
+
+      ##
+      # Automatically determine environment
+      #
+      def environment
+        if defined?(Rails)
+          Rails.env
+        else
+          ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/errors.rb

@@ -0,0 +1,23 @@
+# 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 Errors
+      class Error < StandardError; end
+      class InvalidAccessToken < Error; end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# 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 Middleware
+      # Faraday middleware. It will add appropriate OT tags and trace IDs to outgoing connections done by Faraday
+      class Faraday < ::Faraday::Middleware
+        HTTP_ERROR_STATUS_THRESHOLD = 400
+        HTTP_STATUS_REQUEST_TIMEOUT = 408
+        HTTP_STATUS_INTERNAL_ERROR = 500
+        HTTP_STATUS_SERVICE_UNAVAIL = 503
+
+        OT_TAG_TRACE_ID = 'ot-tracer-traceid'.freeze
+        OT_TAG_SPAN_ID = 'ot-tracer-spanid'.freeze
+        OT_TAG_SAMPLED = 'ot-tracer-sampled'.freeze
+
+        def initialize(app, service_name = nil)
+          @app = app
+          @service_name = (service_name || 'external').to_s
+        end
+
+        def call(request_env)
+          uri = uri_from_env(request_env)
+          tracer = ::Bigcommerce::Lightstep::Tracer.instance
+
+          tracer.start_span(service_key, context: request_env[:request_headers]) do |span|
+            span.set_tag('http.url', uri.to_s.split('?').first)
+            span.set_tag('http.method', request_env[:method].to_s.downcase)
+            span.set_tag('http.external-service', true)
+
+            inject_ot_tags!(request_env, span)
+
+            begin
+              response = @app.call(request_env).on_complete do |response_env|
+                span.set_tag('http.status_code', response_env[:status].to_s)
+                span.set_tag('error', true) if response_env[:status].to_i >= HTTP_ERROR_STATUS_THRESHOLD
+                response_env
+              end
+            rescue ::Net::ReadTimeout
+              span.set_tag('error', true)
+              span.set_tag('http.status_code', HTTP_STATUS_REQUEST_TIMEOUT)
+              raise
+            rescue ::Faraday::ConnectionFailed
+              span.set_tag('error', true)
+              span.set_tag('http.status_code', HTTP_STATUS_SERVICE_UNAVAIL)
+              raise
+            rescue ::Faraday::ClientError
+              span.set_tag('error', true)
+              span.set_tag('http.status_code', HTTP_STATUS_INTERNAL_ERROR)
+              raise
+            end
+
+            response
+          end
+        end
+
+        private
+
+        ##
+        # @param [Hash] request_env
+        # @param [::LightStep::Span] span
+        #
+        def inject_ot_tags!(request_env, span)
+          request_env[:request_headers].merge!(
+            OT_TAG_TRACE_ID => span.span_context.trace_id.to_s,
+            OT_TAG_SPAN_ID  => span.span_context.id.to_s,
+            OT_TAG_SAMPLED  => 'true'
+          )
+        end
+
+        ##
+        # Handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
+        #
+        # @param [Hash] env
+        # @return [URI::HTTP]
+        #
+        def uri_from_env(env)
+          env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
+        end
+
+        ##
+        # @param [URI::HTTP] uri
+        # @return [String]
+        #
+        def path_key_for_uri(uri)
+          uri.path.tr('/', '_').reverse.chomp('_').reverse.chomp
+        end
+
+        ##
+        # @return [String]
+        #
+        def service_key
+          @service_name.to_s.downcase.tr('-', '_').tr('.', '_')
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/rails_controller_instrumentation.rb

@@ -0,0 +1,65 @@
+module Bigcommerce
+  module Lightstep
+    ##
+    # Helper module that can be included into Rails controllers to automatically instrument them with LightStep
+    #
+    module RailsControllerInstrumentation
+      OPEN_TRACING_HEADER_KEYS = %w[ot-tracer-traceid ot-tracer-spanid ot-tracer-sampled].freeze
+
+      def self.included(base)
+        base.send(:around_action, :lightstep_trace)
+      end
+
+      protected
+
+      ##
+      # Trace the controller method
+      #
+      def lightstep_trace
+        prefix = ::Bigcommerce::Lightstep.controller_trace_prefix
+        key = "#{prefix}#{controller_name}.#{action_name}"
+        headers = lightstep_filtered_headers
+        tracer = ::Bigcommerce::Lightstep::Tracer.instance
+        result = tracer.start_span(key, context: headers) do |span|
+          span.set_tag('controller.name', controller_name)
+          span.set_tag('action.name', action_name)
+          span.set_tag('http.url', request.original_url.split('?').first)
+          span.set_tag('http.method', request.method)
+          span.set_tag('http.content_type', request.format)
+          span.set_tag('http.host', request.host)
+          begin
+            resp = yield
+          rescue StandardError => _
+            span.set_tag('error', true)
+            span.set_tag('http.status_code', Bigcommerce::Lightstep.http1_error_code)
+            tracer.clear_active_span!
+            span.finish
+            raise # re-raise the error
+          end
+          span.set_tag('http.status_code', response.status)
+          # 400+ HTTP status codes are errors: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+          span.set_tag('error', true) if response.status >= Bigcommerce::Lightstep.http1_error_code_minimum
+          resp
+        end
+        tracer.clear_active_span!
+        result
+      end
+
+      ##
+      # Get only the open tracing headers
+      #
+      # @return [Hash]
+      #
+      def lightstep_filtered_headers
+        filtered_ot_headers = {}
+        headers = request.headers.to_h
+        headers.each do |k, v|
+          fk = k.to_s.downcase.gsub('http_', '').tr('_', '-')
+          next unless OPEN_TRACING_HEADER_KEYS.include?(fk)
+          filtered_ot_headers[fk] = v
+        end
+        filtered_ot_headers
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/tracer.rb

@@ -0,0 +1,127 @@
+# 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
+    ##
+    # Global tracer
+    #
+    class Tracer
+      private
+
+      def initialize; end
+
+      public
+
+      include Singleton
+
+      ##
+      # Start a new span
+      #
+      # @param [String] name The operation name for the Span
+      # @param [Hash|::LightStep::SpanContext] context (Optional)
+      # @param [Time] start_time (Optional)
+      # @param [Hash] tags (Optional)
+      #
+      def start_span(name, context: nil, start_time: nil, tags: nil)
+        if Bigcommerce::Lightstep.enabled
+          # enable the tracer (for fork support)
+          tracer.enable
+        elsif tracer.enabled?
+          # We are not enabled and the tracer is currently on
+          # https://github.com/lightstep/lightstep-tracer-ruby/blob/master/lib/lightstep/tracer.rb#L129-L130
+          tracer.disable(discard: true)
+        end
+
+        # find the currently active span
+        last_active_span = active_span
+
+        # determine who is the actual parent span
+        current_parent = determine_parent(context: context)
+
+        # create new span
+        span = ::LightStep.start_span(name, child_of: current_parent, start_time: start_time, tags: tags)
+
+        # set it as the active span
+        self.active_span = span
+
+        # run the process
+        result = yield span
+
+        # finish this span if the reporter is initialized
+        span.finish if reporter_initialized?
+
+        # now set back the parent as the active span
+        self.active_span = last_active_span
+
+        # return result
+        result
+      end
+
+      ##
+      # Return the active span
+      #
+      # @return [::LightStep::Span|NilClass]
+      #
+      def active_span
+        Thread.current[:lightstep_active_span]
+      end
+
+      ##
+      # Clear the active span
+      #
+      def clear_active_span!
+        Thread.current[:lightstep_active_span] = nil
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def reporter_initialized?
+        tracer.instance_variable_defined?(:@reporter) && !tracer.instance_variable_get(:@reporter).nil?
+      end
+
+      private
+
+      ##
+      # Determine the active parent
+      #
+      # @param [Hash|::LightStep::SpanContext] context
+      # @return [::LightStep::SpanContext]
+      #
+      def determine_parent(context:)
+        # first attempt to find parent from args, if not, use carrier (headers) to lookup parent
+        current_parent = context.is_a?(::LightStep::SpanContext) ? context : tracer.extract(::LightStep::Tracer::FORMAT_TEXT_MAP, context || {})
+        # if no passed in parent, use the active thread parent
+        current_parent = active_span if current_parent.nil?
+        current_parent
+      end
+
+      ##
+      # @param [::LightStep::Span] span
+      #
+      def active_span=(span)
+        Thread.current[:lightstep_active_span] = span
+      end
+
+      ##
+      # @return [::LightStep::Tracer]
+      #
+      def tracer
+        LightStep.instance
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/transport.rb

@@ -0,0 +1,123 @@
+# 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.
+#
+require 'net/http'
+require 'lightstep/transport/base'
+require 'logger'
+
+module Bigcommerce
+  module Lightstep
+    # This is a transport that sends reports via HTTP in JSON format.
+    # It is thread-safe, however it is *not* fork-safe. When forking, all items
+    # in the queue will be copied and sent in duplicate.
+    class Transport < ::LightStep::Transport::Base
+      class InvalidAccessTokenError < StandardError; end
+
+      ENCRYPTION_TLS = 'tls'.freeze
+      ENCRYPTION_NONE = 'none'.freeze
+      HEADER_ACCESS_TOKEN = 'LightStep-Access-Token'.freeze
+      LIGHTSTEP_HOST = 'collector.lightstep.com'.freeze
+      LIGHTSTEP_PORT = 443
+      REPORTS_API_ENDPOINT = '/api/v0/reports'.freeze
+
+      # Initialize the transport
+      # @param host [String] host of the domain to the endpoind to push data
+      # @param port [Numeric] port on which to connect
+      # @param verbose [Numeric] verbosity level. Right now 0-3 are supported
+      # @param encryption [ENCRYPTION_TLS, ENCRYPTION_NONE] kind of encryption to use
+      # @param ssl_verify_peer [Boolean]
+      # @param access_token [String] access token for LightStep server
+      # @return [Transport]
+      def initialize(
+        access_token:,
+        host: LIGHTSTEP_HOST,
+        port: LIGHTSTEP_PORT,
+        verbose: 0,
+        encryption: ENCRYPTION_TLS,
+        ssl_verify_peer: true,
+        open_timeout: 20,
+        read_timeout: 20,
+        continue_timeout: nil,
+        keep_alive_timeout: 2,
+        logger: nil
+      )
+        @host = host
+        @port = port
+        @verbose = verbose
+        @encryption = encryption
+        @ssl_verify_peer = ssl_verify_peer
+        @open_timeout = open_timeout.to_i
+        @read_timeout = read_timeout.to_i
+        @continue_timeout = continue_timeout
+        @keep_alive_timeout = keep_alive_timeout.to_i
+
+        raise ::Bigcommerce::Lightstep::Errors::InvalidAccessToken, 'access_token must be a string' unless access_token.is_a?(String)
+        raise ::Bigcommerce::Lightstep::Errors::InvalidAccessToken, 'access_token cannot be blank'  if access_token.empty?
+        @access_token = access_token.to_s
+        @logger = logger || ::Logger.new(STDOUT)
+      end
+
+      ##
+      # Queue a report for sending
+      #
+      # @param [Hash] report
+      # @return [NilClass]
+      #
+      def report(report)
+        @logger.info report if @verbose >= 3
+
+        req = build_request(report)
+        res = connection.request(req)
+
+        @logger.info res.to_s if @verbose >= 3
+
+        nil
+      end
+
+      private
+
+      ##
+      # @param [Hash] report
+      # @return [Net::HTTP::Post]
+      #
+      def build_request(report)
+        req = Net::HTTP::Post.new(REPORTS_API_ENDPOINT)
+        req[HEADER_ACCESS_TOKEN] = @access_token
+        req['Content-Type'] = 'application/json'
+        req['Connection'] = 'keep-alive'
+        req.body = report.to_json
+        req
+      end
+
+      ##
+      # @return [Net::HTTP]
+      #
+      def connection
+        unless @connection
+          @connection = ::Net::HTTP.new(@host, @port)
+          if @port == 443
+            @connection.use_ssl = @encryption == ENCRYPTION_TLS
+            @connection.verify_mode = ::OpenSSL::SSL::VERIFY_NONE unless @ssl_verify_peer
+          end
+          @connection.open_timeout = @open_timeout
+          @connection.read_timeout = @read_timeout
+          @connection.continue_timeout = @continue_timeout
+          @connection.keep_alive_timeout = @keep_alive_timeout
+        end
+        @connection
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/transport_factory.rb

@@ -0,0 +1,38 @@
+# 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
+    ##
+    # Build transports for the lightstep connection
+    #
+    class TransportFactory
+      ##
+      # @return [::Bigcommerce::Lightstep::Transport]
+      #
+      def build
+        ::Bigcommerce::Lightstep::Transport.new(
+          host: ::Bigcommerce::Lightstep.host,
+          port: ::Bigcommerce::Lightstep.port.to_i,
+          verbose: ::Bigcommerce::Lightstep.verbosity.to_i,
+          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,
+          logger: ::Bigcommerce::Lightstep.logger
+        )
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/version.rb

@@ -0,0 +1,20 @@
+# 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
+    VERSION = '1.1.6'.freeze
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: bc-lightstep-ruby
+version: !ruby/object:Gem::Version
+  version: 1.1.6
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lightstep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Gem for lightstep distributed tracing
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- bc-lightstep-ruby.gemspec
+- lib/bigcommerce/lightstep.rb
+- lib/bigcommerce/lightstep/configuration.rb
+- lib/bigcommerce/lightstep/errors.rb
+- lib/bigcommerce/lightstep/middleware/faraday.rb
+- lib/bigcommerce/lightstep/rails_controller_instrumentation.rb
+- lib/bigcommerce/lightstep/tracer.rb
+- lib/bigcommerce/lightstep/transport.rb
+- lib/bigcommerce/lightstep/transport_factory.rb
+- lib/bigcommerce/lightstep/version.rb
+homepage: https://github.com/bigcommerce/bc-lightstep-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Gem for lightstep distributed tracing
+test_files: []