gruf-lightstep 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcd64d7ee13aee60adfad83aea4f5da16e001645255a4f6d002660269a95793a
-  data.tar.gz: 7065582ddf65d8c60318783f3d28918cba6e1d689ae6d686f6de4568fde19ea7
+  metadata.gz: 0f5ebd12fb3f139feb7dd42f1fe60a90fdc336cdde6dde41ce076a0808735384
+  data.tar.gz: 249367d93de69139cf8972be60dfb094c2636d7be040d8e15639812a16bd366e
 SHA512:
-  metadata.gz: fbf8dee7b06c1154d44f84619122582e6dfebe35d5f34505aa0aab4031e55dd9c8bd9728ca4ab56a3569edd53573f9f93f414d019567104f3b7ecf15cc7ac70a
-  data.tar.gz: 1cca8317ebaab1087de97fb0ec550598927f300c4995ff5a15a6d2b8ba0fb1c296989aba980847c90c114d41c22b26f99c92abef0c3c757598b2e50737077e6b
+  metadata.gz: 05d6ff8c11f1fa20ae1842dc2bfe955baabff38eb4035ac307cbcde020bae0fee7057542e8b93f9aaed70fb064d648255f8d56a520214ddcfe94d5d996e38616
+  data.tar.gz: d08c23837bd69d3d8f133f8d3ea67d0a4c5a176a8d12a18afecc3daff15ac6c697f69eb50bc1e13e364531f5c5831275b205dc37c0273d021a86c4d9592c7f53

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Changelog for the gruf-lightstep gem.
 
 ### Pending Release
 
+### 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+
@@ -26,7 +31,7 @@ Changelog for the gruf-lightstep gem.
 
 - 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
 
 ### 1.1.1
 

data/README.md

@@ -1,6 +1,6 @@
 # gruf-lightstep - LightStep tracing for gruf
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-lightstep/tree/master) [![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

@@ -43,6 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.82'
   spec.add_development_dependency 'simplecov', '~> 0.15'
 
-  spec.add_runtime_dependency 'bc-lightstep-ruby', '~> 2.0'
+  spec.add_runtime_dependency 'bc-lightstep-ruby', '~> 2.2'
   spec.add_runtime_dependency 'gruf', '>= 2.4', '< 3'
 end

data/lib/gruf/lightstep/server_interceptor.rb

@@ -21,17 +21,16 @@ 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|
@@ -40,14 +39,14 @@ module Gruf
           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', code_for(e))
             span.set_tag('grpc.error_class', e.class)
@@ -59,6 +58,19 @@ 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
@@ -94,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

@@ -17,6 +17,6 @@
 #
 module Gruf
   module Lightstep
-    VERSION = '1.3.0'
+    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.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Shaun McCormick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: gruf
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +178,7 @@ homepage: https://github.com/bigcommerce/gruf-lightstep
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Plugin for lightstep tracing for gruf
 test_files: []