bc-lightstep-ruby 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87d43b480527e30211d2c1062b5bdf20286c83b9a98b35180ca6e6754cd1beed
-  data.tar.gz: b5282d3fcafc35e2aa025786fea8860b9a0a9f721f82d640205e3f7e6259cbe2
+  metadata.gz: c51308f745da6f5f2054977944d4d833c1be333d084cf9b929c6160cc9bdd9e8
+  data.tar.gz: 7dacfc839a37d78d7088ef9d6a4eb24e412fc8742a40ccdfac67eb64aa54629a
 SHA512:
-  metadata.gz: b3811b4e1015fbb8aed23d914656c507f71fa249ac0f81b3312ec01212ea36b4b4964c28485be9009c96ae51f71fb08f0e2b4ae90de20013e485229537075809
-  data.tar.gz: f933a7ddf453e9260bff991ba0e214baae3c5d889bfe5b4c7597479f92d71693b4007d2b20997fbad179b7925837b344e7dc6f3dde66258df0fa0983313c5423
+  metadata.gz: 0b7451b70f574837c7758c32d2cef0c8a1d076931618524aa2e330c69a6bd4d520242a843432415bcba3987026c7c3ea65f0a3234075797864b6979b6512f777
+  data.tar.gz: 985b16c6abbe8513a829bd74d3928d42c252ea14719aadb964115aaa351e3c7d3c2e0457902c4f53cee1f4d634027ca3951fc3616b469a16a5beb6ea227f969c

data/CHANGELOG.md

@@ -2,6 +2,15 @@ Changelog for the bc-lightstep-ruby gem.
 
 ### Pending Release
 
+### 2.4.0
+
+* Add `::Bigcommerce::Lightstep::Traceable` module for tracing individual methods
+* Use zeitwerk for autoloading
+* Add CODEOWNERS and GitHub PR Template
+* Add Ruby 3.1 support
+* Drop Ruby 2.6 support
+* Add CodeClimate coverage
+
 ### 2.3.1
 
 - Loosen faraday dependency
@@ -117,7 +126,7 @@ Changelog for the bc-lightstep-ruby gem.
 
 - 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 
+- Always ensure spans are reported even in the case of exceptional failure
 
 ### 1.1.6
 
@@ -126,7 +135,7 @@ Changelog for the bc-lightstep-ruby gem.
 ### 1.1.5
 
 - Pin lightstep gem to 0.11.x due to backwards-incompatible change in 0.12.x
- 
+
 ### 1.1.4
 
 - Add enabled setting to explicitly disable lightstep at runtime. Can be toggled with LIGHTSTEP_ENABLED ENV var.
@@ -137,7 +146,7 @@ Changelog for the bc-lightstep-ruby gem.
 
 ### 1.1.2
 
-- Prevent span from starting if the reporter is not yet configured, as LightStep gem does not guard this case 
+- Prevent span from starting if the reporter is not yet configured, as LightStep gem does not guard this case
 
 ### 1.1.1
 
@@ -146,7 +155,7 @@ Changelog for the bc-lightstep-ruby gem.
 ### 1.1.0
 
 - Add Faraday middleware for automatic tracing of outbound service calls
- 
+
 ### 1.0.5
 
 - Do not send GET params in rails controller instrumentation for http.url tag
@@ -159,7 +168,7 @@ Changelog for the bc-lightstep-ruby gem.
 ### 1.0.3
 
 - Fix bug where active parent span was persisting between requests in rails controller requests
- 
+
 ### 1.0.2
 
 - Add Bigcommerce::Lightstep::Rails::ControllerInstrumentation module for tracing H1 controllers in Rails

data/README.md

@@ -1,8 +1,8 @@
 # bc-lightstep-ruby - LightStep distributed tracing
 
-[![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)
+[![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) [![Maintainability](https://api.codeclimate.com/v1/badges/72191c29a56368431942/maintainability)](https://codeclimate.com/github/bigcommerce/bc-lightstep-ruby/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/72191c29a56368431942/test_coverage)](https://codeclimate.com/github/bigcommerce/bc-lightstep-ruby/test_coverage)
 
-Adds [LightStep](https://lightstep.com) tracing support for Ruby. This is an extension of the 
+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
@@ -41,8 +41,8 @@ bc-lightstep-ruby can be automatically configured from these ENV vars, if you'd
 | Name | Description |
 | ---- | ----------- |
 | LIGHTSTEP_ENABLED | Flag to determine whether to broadcast spans. Defaults to (1) enabled, 0 will disable.| 1 |
-| LIGHTSTEP_COMPONENT_NAME | The component name to use | '' | 
-| LIGHTSTEP_ACCESS_TOKEN | The access token to use to connect to the collector. Optional. | '' | 
+| LIGHTSTEP_COMPONENT_NAME | The component name to use | '' |
+| 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 |
@@ -86,12 +86,12 @@ or systems outside of your instrumenting control.
 ### Redis
 
 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). 
+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 
+Note that this will not record redis timings if they are a root span. This is to prevent trace spamming. You can
 re-enable this by setting the `redis_allow_root_spans` configuration option to `true`.
 
-It also excludes `ping` commands, and you can provide a custom list by setting the `redis_excluded_commands` 
+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
@@ -103,7 +103,27 @@ The query will have no values - replaced with `?` - to ensure secure logging and
 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. 
+By default, it will also exclude `COMMIT`, `SCHEMA`, and `SHOW FULL FIELDS` queries.
+
+### Individual methods
+
+You can easily instrument individual methods with the Traceable module and `trace` method:
+
+```ruby
+class MyService
+  include ::Bigcommerce::Lightstep::Traceable
+
+  trace :call, 'operation.do-my-thing' do |span:, product:, options:|
+    span.set_tag('store_id', request.store_id)
+  end
+  # or, with no block:
+  trace :call, 'operation.do-my-thing'
+
+  def call(product:, options:)
+    # ...
+  end
+end
+```
 
 ## RSpec
 
@@ -130,7 +150,7 @@ dynamically inject tags or alter spans as they are collected. You can configure
 Bigcommerce::Lightstep.configure do |c|
   c.interceptors.use(MyInterceptor, an_option: 123)
   # or, alternatively:
-  c.interceptors.use(MyInterceptor.new(an_option: 123)) 
+  c.interceptors.use(MyInterceptor.new(an_option: 123))
 end
 ```
 
@@ -142,7 +162,6 @@ so don't build interceptors that require lots of processing power or that would
 Provided out of the box is an interceptor to automatically inject ENV vars into span tags. You can configure like so:
 
 ```ruby
-
 Bigcommerce::Lightstep.configure do |c|
   c.interceptors.use(::Bigcommerce::Lightstep::Interceptors::Env.new(
     keys: {
@@ -157,21 +176,21 @@ The `keys` argument allows you to pass a `span tag => ENV key` mapping that will
 `presets` argument comes with a bunch of preset mappings you can use rather than manually mapping them yourself.
 
 Note that this interceptor _must_ be instantiated in configuration, rather than passing the class and options,
-as it needs to pre-materialize the ENV values to reduce CPU usage. 
+as it needs to pre-materialize the ENV values to reduce CPU usage.
 
 ## License
 
-Copyright (c) 2018-present, BigCommerce Pty. Ltd. All rights reserved 
+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 
+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 
+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 
+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

@@ -31,7 +31,8 @@ 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.required_ruby_version = '>= 2.7'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.add_development_dependency 'activerecord', '> 4'
   spec.add_development_dependency 'bundler-audit', '~> 0.6'
@@ -39,6 +40,7 @@ Gem::Specification.new do |spec|
   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 'rubocop-performance', '>= 1.5'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'pry', '>= 0.12'
 
@@ -48,4 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '>= 4'
   spec.add_runtime_dependency 'lightstep', '~> 0.17.0'
   spec.add_runtime_dependency 'faraday', ['>= 0.8', '< 2']
+  spec.add_runtime_dependency 'zeitwerk', '>= 2'
 end

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

@@ -41,7 +41,7 @@ module Bigcommerce
         # @return [Boolean]
         #
         def self.enabled?
-          defined?(::ActiveRecord) && ::Bigcommerce::Lightstep.active_record && ::ActiveRecord::Base.connection_config[:adapter].to_s.downcase == 'mysql2'
+          defined?(::ActiveRecord) && ::Bigcommerce::Lightstep.active_record && ::ActiveRecord::Base.connection_config[:adapter].to_s.casecmp('mysql2').zero?
         rescue StandardError => e
           ::Bigcommerce::Lightstep.logger&.warn "Failed to determine ActiveRecord database adapter in bc-lightstep-ruby initializer: #{e.message}"
           false
@@ -56,7 +56,7 @@ module Bigcommerce
           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
+          name = 'QUERY' if name.to_s.strip.empty?
 
           # we dont need to track all sql
           return execute_without_inst(sql, name) if lightstep_skip_tracing?(name, sanitized_sql)

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

@@ -80,7 +80,8 @@ module Bigcommerce
             @values = {}
             @keys.each do |span_key, env_key|
               value = @env.fetch(env_key.to_s, nil)
-              value = value.nil? ? '' : value
+              value = '' if value.nil?
+
               @values[span_key.to_s.downcase.tr('-', '_').strip] = value
             end
             @values

data/lib/bigcommerce/lightstep/traceable.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Bigcommerce
+  module Lightstep
+    ##
+    # Module for adding drop-in tracing to any method. Example usage:
+    #
+    # ```ruby
+    # class MyService
+    #   include ::Bigcommerce::Lightstep::Traceable
+    #
+    #   trace :call, 'operation.do-my-thing' do |span, product, options|
+    #     span.set_tag('store_id', request.store_id)
+    #   end
+    #   # or, with no block:
+    #   trace :call, 'operation.do-my-thing'
+    #
+    #   def call(product:, options:)
+    #     # ...
+    #   end
+    # end
+    # ```
+    #
+    module Traceable
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      ##
+      # Extend the class with the tracing methods.
+      #
+      module ClassMethods
+        ##
+        # Trace the perform method for the command with the given operation name as the span name
+        #
+        # @param [Symbol] method_name The method to trace
+        # @param [String] operation_name The name to give the span
+        # @param [Hash] tags A key/value hash of tags to set on the created span
+        # @param [Proc] span_block A block to yield before calling perform; useful for setting tags on the outer span
+        #
+        def trace(method_name, operation_name, tags: nil, &span_block)
+          method_name = method_name.to_sym
+          mod = Module.new
+          mod.define_method(method_name) do |args, &block|
+            tracer = ::Bigcommerce::Lightstep::Tracer.instance
+            tracer.start_span(operation_name) do |span|
+              tags&.each { |k, v| span.set_tag(k.to_s, v) }
+              span_block&.send(:call, **args.merge(span: span))
+              begin
+                super(**args, &block)
+              rescue StandardError => e
+                span.set_tag('error', true)
+                span.set_tag('error.message', e.message)
+                span.set_tag('error.class', e.class.to_s)
+                raise
+              end
+            end
+          end
+          prepend(mod)
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/lightstep/version.rb

@@ -8,7 +8,7 @@
 # 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.
+# Software.have a
 #
 # 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
@@ -17,6 +17,6 @@
 #
 module Bigcommerce
   module Lightstep
-    VERSION = '2.3.1'
+    VERSION = '2.4.0'
   end
 end

data/lib/bigcommerce/lightstep.rb

@@ -18,19 +18,16 @@
 require 'lightstep'
 require 'faraday'
 require 'active_support/concern'
-require_relative 'lightstep/version'
-require_relative 'lightstep/errors'
-require_relative 'lightstep/interceptors/registry'
-require_relative 'lightstep/interceptors/context'
-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'
-require_relative 'lightstep/active_record/tracer'
-require_relative 'lightstep/active_record/adapter'
-require_relative 'lightstep/redis/tracer'
+
+# use Zeitwerk to lazily autoload all the files in the lib directory
+require 'zeitwerk'
+loader = ::Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, '.rb')
+loader.inflector = ::Zeitwerk::GemInflector.new(__FILE__)
+loader.ignore("#{__dir__}/lightstep/rspec.rb")
+loader.ignore("#{File.dirname(__dir__)}/bc-lightstep-ruby.rb")
+loader.push_dir(File.dirname(__dir__))
+loader.setup
 
 ##
 # Main base module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bc-lightstep-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +212,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 description: Gem for lightstep distributed tracing
 email:
 - shaun.mccormick@bigcommerce.com
@@ -223,6 +251,7 @@ files:
 - lib/bigcommerce/lightstep/redis/tracer.rb
 - lib/bigcommerce/lightstep/redis/wrapper.rb
 - lib/bigcommerce/lightstep/rspec.rb
+- lib/bigcommerce/lightstep/traceable.rb
 - lib/bigcommerce/lightstep/tracer.rb
 - lib/bigcommerce/lightstep/transport.rb
 - lib/bigcommerce/lightstep/transport_factory.rb
@@ -230,7 +259,8 @@ files:
 homepage: https://github.com/bigcommerce/bc-lightstep-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -239,14 +269,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Gem for lightstep distributed tracing