gruf-lightstep 1.1.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7208452825f60d83446d8bf3bb3f060a499ec7e505cee6b1e0c37e39ed90a0af
-  data.tar.gz: e431b38fa9b30736bf07853ce14a3319fb2ad0a6f874d16b7e38f3c5167edd93
+  metadata.gz: 0f5ebd12fb3f139feb7dd42f1fe60a90fdc336cdde6dde41ce076a0808735384
+  data.tar.gz: 249367d93de69139cf8972be60dfb094c2636d7be040d8e15639812a16bd366e
 SHA512:
-  metadata.gz: b57836ff6f8c1cda1e8fa6fb82ec188e440ae2e8c0f84debcad6915eaf050310b8dc0b45740463945e14503360f774036f24418f954cf1c80d681b4b27003006
-  data.tar.gz: 65b8196733faeabfead68528d3408adda9ac3dcf1baf437637f033a9d67e7c313d61d19ac46507d1b51d4e3e897dd63b766bb34e4a72f79311863b864c1ef49e
+  metadata.gz: 05d6ff8c11f1fa20ae1842dc2bfe955baabff38eb4035ac307cbcde020bae0fee7057542e8b93f9aaed70fb064d648255f8d56a520214ddcfe94d5d996e38616
+  data.tar.gz: d08c23837bd69d3d8f133f8d3ea67d0a4c5a176a8d12a18afecc3daff15ac6c697f69eb50bc1e13e364531f5c5831275b205dc37c0273d021a86c4d9592c7f53

data/CHANGELOG.md

@@ -1,47 +1,72 @@
-Changelog for the gruf-zipkin gem.
+Changelog for the gruf-lightstep gem.
 
-h3. Pending Release
+### Pending Release
 
-h3. 1.1.2
+### 1.4.0
+
+- Ensure `error` span tag is always set when an exception is raised 
+- Move from whitelist -> allowlist in server interceptor
+
+### 1.3.0
+
+- Bump Ruby requirement to 2.6+
+- Bump bc-lightstep-ruby dependency to 2.0+
+- Explicitly declare gruf requirement in gemspec
+- Explicitly declare development deps for gem
+
+###  1.2.1
+
+- Ensure boundary span has `span.kind` set
+
+### 1.2.0
+
+- Add `frozen_string_literal: true` to all files
+- Deprecate ruby 2.2 support
+
+### 1.1.3
+
+- Bump bc-lightstep-ruby to 1.2.0
+
+### 1.1.2
 
 - First OSS release
 - Explicitly require bc-lightstep-ruby dependency
-- Add option to whitelist request params to lightstep as span tags
+- Add option to allowlist request params to lightstep as span tags
 
-h3. 1.1.1
+### 1.1.1
 
 - Bump bc-lightstep-ruby to 1.1.5
 - Bump gruf minimum version to 2.4
 
-h3. 1.1.0
+### 1.1.0
 
 - Exclude client validation errors from being "errors"
 
-h3. 1.0.3
+### 1.0.3
 
 - Ensure gRPC requests are always the root span
 
-h3. 1.0.2
+### 1.0.2
 
 - Add ignore_methods as an option to server interceptor
 - Standardize span tags according to BC spec
 
-h3. 1.0.0
+### 1.0.0
 
 - Support for gruf 2.0.0
 
-h3. 0.10.3
+### 0.10.3
 
 - Update to 0.10.3, add rubocop+bundler-audit
 
-h3. 0.10.2
+### 0.10.2
 
 - Updated license to MIT
 
-h3. 0.10.1
+### 0.10.1
 
 - Handle case when tracer is not yet initialized before trace executes
 
-h3. 0.10.0
+### 0.10.0
 
 - Initial public release

data/README.md

@@ -1,6 +1,6 @@
 # gruf-lightstep - LightStep tracing for gruf
 
-[![Build Status](https://travis-ci.com/bigcommerce/gruf-lightstep.svg?branch=master)](https://travis-ci.com/bigcommerce/gruf-lightstep) [![Gem Version](https://badge.fury.io/rb/gruf-lightstep.svg)](https://badge.fury.io/rb/gruf-lightstep) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-lightstep.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-lightstep)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/main.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/main) [![Gem Version](https://badge.fury.io/rb/gruf-lightstep.svg)](https://badge.fury.io/rb/gruf-lightstep) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-lightstep.svg?branch=main)](http://inch-ci.org/github/bigcommerce/gruf-lightstep)
 
 Adds LightStep tracing support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.
 
@@ -14,18 +14,24 @@ Then in an initializer or before use, after loading gruf:
 
 ```ruby
 require 'gruf/lightstep'
-
-Gruf::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
-Gruf::Lightstep.start
 ```
 
-Then after, in your gruf initializer:
+### Configuration
+
+You can use the following ENV vars to configure lightstep:
+
+| Name | Description |
+| ---- | ---- |
+|LIGHTSTEP_ACCESS_TOKEN|LightStep access token, if used in your satellites|
+|LIGHTSTEP_COMPONENT_NAME|The name of your service| 
+|LIGHTSTEP_HOST|The host of your lightstep satellites|
+|LIGHTSTEP_PORT|The port of your lightstep satellites|
+
+See more configuration here: https://github.com/bigcommerce/bc-lightstep-ruby#environment-config
+
+### Server Interceptors
+
+In your gruf initializer:
 
 ```ruby
 Gruf.configure do |c|
@@ -37,11 +43,11 @@ It comes with a few more options as well:
 
 | Option | Description | Default |
 | ------ | ----------- | ------- |
-| whitelist | An array of parameter key names to log to lightstep. E.g. `[uuid kind]` | `[]` |
+| allowlist | An array of parameter key names to log to lightstep. E.g. `[uuid kind]` | `[]` |
 | ignore_methods | An array of method names to ignore from logging. E.g. `['namespace.health.check']` | `[]` |
 
-It's important to maintain a safe whitelist should you decide to log parameters; gruf does no
-parameter sanitization on its own. We also recommend do not whitelist parameters that may contain
+It's important to maintain a safe allowlist should you decide to log parameters; gruf does no
+parameter sanitization on its own. We also recommend do not allowlist parameters that may contain
 very large values (such as binary or json data).
 
 ### Client Interceptors

data/gruf-lightstep.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -13,7 +15,7 @@
 # COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'gruf/lightstep/version'
 
 Gem::Specification.new do |spec|
@@ -22,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Shaun McCormick']
   spec.email         = ['shaun.mccormick@bigcommerce.com']
 
-  spec.summary       = %q{Plugin for lightstep tracing for gruf}
+  spec.summary       = 'Plugin for lightstep tracing for gruf'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/bigcommerce/gruf-lightstep'
   spec.license       = 'MIT'
@@ -30,10 +32,17 @@ Gem::Specification.new do |spec|
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-lightstep.gemspec']
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.6'
+
   spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
+  spec.add_development_dependency 'pry', '>= 0.13'
+  spec.add_development_dependency 'rake', '>= 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  spec.add_development_dependency 'rubocop', '~> 0.82'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
 
-  spec.add_runtime_dependency 'bc-lightstep-ruby', '~> 1.1'
+  spec.add_runtime_dependency 'bc-lightstep-ruby', '~> 2.2'
+  spec.add_runtime_dependency 'gruf', '>= 2.4', '< 3'
 end

data/lib/gruf/lightstep.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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

data/lib/gruf/lightstep/client_interceptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -42,7 +44,7 @@ module Gruf
         return unless tracer
 
         span = tracer.active_span
-        return unless span && span.is_a?(::LightStep::Span)
+        return unless span&.is_a?(::LightStep::Span)
 
         span
       end

data/lib/gruf/lightstep/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -21,6 +23,7 @@ module Gruf
     #
     module Configuration
       VALID_CONFIG_KEYS = {
+        default_error_code: GRPC::Core::StatusCodes::INTERNAL
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys

data/lib/gruf/lightstep/headers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -25,11 +27,11 @@ module Gruf
       # @property [Hash<Symbol|Array<String>>] Hash mapping of metadata keys
       #
       OT_KEYS = {
-        parent_span_id: %w(ot-tracer-parentspanid OT-Tracer-ParentSpanId HTTP_X_OT_TRACER_PARENTSPANID),
-        span_id: %w(ot-tracer-spanid OT-Tracer-SpanId HTTP_X_OT_TRACER_SPANID),
-        trace_id: %w(ot-tracer-traceid OT-Tracer-TraceId HTTP_X_OT_TRACER_TRACEID),
-        sampled: %w(ot-tracer-sampled OT-Tracer-Sampled HTTP_X_OT_TRACER_SAMPLED),
-        flags: %w(ot-tracer-flags OT-Tracer-Flags HTTP_X_OT_TRACER_FLAGS)
+        parent_span_id: %w[ot-tracer-parentspanid OT-Tracer-ParentSpanId HTTP_X_OT_TRACER_PARENTSPANID],
+        span_id: %w[ot-tracer-spanid OT-Tracer-SpanId HTTP_X_OT_TRACER_SPANID],
+        trace_id: %w[ot-tracer-traceid OT-Tracer-TraceId HTTP_X_OT_TRACER_TRACEID],
+        sampled: %w[ot-tracer-sampled OT-Tracer-Sampled HTTP_X_OT_TRACER_SAMPLED],
+        flags: %w[ot-tracer-flags OT-Tracer-Flags HTTP_X_OT_TRACER_FLAGS]
       }.freeze
 
       delegate :has_key?, :key?, to: :metadata
@@ -49,6 +51,7 @@ module Gruf
       #
       def value(key)
         return nil unless OT_KEYS.key?(key)
+
         OT_KEYS[key].each do |k|
           return metadata[k] if metadata.key?(k)
         end

data/lib/gruf/lightstep/method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -33,7 +35,7 @@ module Gruf
       end
 
       ##
-      # @return [Gruf::Zipkin::Headers]
+      # @return [Gruf::Lightstep::Headers]
       #
       def headers
         @headers ||= Gruf::Lightstep::Headers.new(@active_call)

data/lib/gruf/lightstep/server_interceptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -19,34 +21,34 @@ module Gruf
     # Intercepts inbound calls to provide LightStep tracing
     #
     class ServerInterceptor < Gruf::Interceptors::ServerInterceptor
+      DEFAULT_ERROR_CLASSES = %w[GRPC::Unknown GRPC::Internal GRPC::DataLoss GRPC::FailedPrecondition GRPC::Unavailable GRPC::DeadlineExceeded GRPC::Cancelled].freeze
+
       ##
       # Handle the gruf around hook and trace sampled requests
       #
       def call(&_block)
-        return yield if options.fetch(:ignore_methods, []).include?(request.method_name)
+        return yield if ignore_methods.include?(request.method_name)
 
         result = nil
-
-        whitelist = options.fetch(:whitelist, []).map(&:to_s).map(&:to_sym)
         params = request_message_params
-
         tracer = ::Bigcommerce::Lightstep::Tracer.instance
         tracer.clear_active_span! # because we're always starting from the top on a gRPC boundary
         tracer.start_span(request.method_name, context: request_method.headers.to_h) do |span|
           span.set_tag('grpc.method', request.method_key)
           span.set_tag('grpc.request_class', request.request_class)
           span.set_tag('grpc.service', request.service_key)
+          span.set_tag('span.kind', 'server')
 
-          whitelist.each do |param|
+          allowlist.each do |param|
             span.set_tag(param.to_s, params[param]) if params.key?(param)
           end
 
           begin
             result = yield
           rescue StandardError => e
-            span.set_tag('error', true) if error?(e)
+            span.set_tag('error', error?(e))
             span.set_tag('grpc.error', true)
-            span.set_tag('grpc.error_code', e.code)
+            span.set_tag('grpc.error_code', code_for(e))
             span.set_tag('grpc.error_class', e.class)
             raise # passthrough, we just want the annotations
           end
@@ -56,6 +58,27 @@ module Gruf
 
       private
 
+      ##
+      # @return [Array<String>]
+      def ignore_methods
+        @ignore_methods ||= options.fetch(:ignore_methods, nil) || []
+      end
+
+      ##
+      # @return [Array<Symbol>]
+      #
+      def allowlist
+        @allowlist ||= (options.fetch(:allowlist, nil) || []).map(&:to_s).map(&:to_sym)
+      end
+
+      ##
+      # @param [StandardError]
+      # @return [Number] that maps to one of the GRCP::Core::StatusCodes or Gruf::Lightstep.default_error_code
+      #
+      def code_for(error)
+        error.respond_to?(:code) ? error.code : Gruf::Lightstep.default_error_code
+      end
+
       ##
       # @return [Gruf::Lightstep::Method]
       #
@@ -68,6 +91,7 @@ module Gruf
       #
       def request_message_params
         return {} if request.client_streamer? || !request.message.respond_to?(:to_h)
+
         request.message.to_h
       end
 
@@ -82,7 +106,7 @@ module Gruf
       # @return [Array]
       #
       def error_classes
-        options.fetch(:error_classes, %w(GRPC::Unknown GRPC::Internal GRPC::DataLoss GRPC::FailedPrecondition GRPC::Unavailable GRPC::DeadlineExceeded GRPC::Cancelled))
+        @error_classes ||= (options.fetch(:error_classes, nil) || DEFAULT_ERROR_CLASSES)
       end
     end
   end

data/lib/gruf/lightstep/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2017-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
@@ -15,6 +17,6 @@
 #
 module Gruf
   module Lightstep
-    VERSION = '1.1.2'.freeze
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-lightstep
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,61 +25,137 @@ 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !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.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !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: bc-lightstep-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Plugin for lightstep tracing for gruf
 email:
 - shaun.mccormick@bigcommerce.com
@@ -102,24 +178,23 @@ homepage: https://github.com/bigcommerce/gruf-lightstep
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Plugin for lightstep tracing for gruf
 test_files: []