gruf-lightstep 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7208452825f60d83446d8bf3bb3f060a499ec7e505cee6b1e0c37e39ed90a0af
+  data.tar.gz: e431b38fa9b30736bf07853ce14a3319fb2ad0a6f874d16b7e38f3c5167edd93
+SHA512:
+  metadata.gz: b57836ff6f8c1cda1e8fa6fb82ec188e440ae2e8c0f84debcad6915eaf050310b8dc0b45740463945e14503360f774036f24418f954cf1c80d681b4b27003006
+  data.tar.gz: 65b8196733faeabfead68528d3408adda9ac3dcf1baf437637f033a9d67e7c313d61d19ac46507d1b51d4e3e897dd63b766bb34e4a72f79311863b864c1ef49e

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+Changelog for the gruf-zipkin gem.
+
+h3. Pending Release
+
+h3. 1.1.2
+
+- First OSS release
+- Explicitly require bc-lightstep-ruby dependency
+- Add option to whitelist request params to lightstep as span tags
+
+h3. 1.1.1
+
+- Bump bc-lightstep-ruby to 1.1.5
+- Bump gruf minimum version to 2.4
+
+h3. 1.1.0
+
+- Exclude client validation errors from being "errors"
+
+h3. 1.0.3
+
+- Ensure gRPC requests are always the root span
+
+h3. 1.0.2
+
+- Add ignore_methods as an option to server interceptor
+- Standardize span tags according to BC spec
+
+h3. 1.0.0
+
+- Support for gruf 2.0.0
+
+h3. 0.10.3
+
+- Update to 0.10.3, add rubocop+bundler-audit
+
+h3. 0.10.2
+
+- Updated license to MIT
+
+h3. 0.10.1
+
+- Handle case when tracer is not yet initialized before trace executes
+
+h3. 0.10.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,76 @@
+# 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)
+
+Adds LightStep tracing support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.
+
+## Installation
+
+```ruby
+gem 'gruf-lightstep'
+```
+
+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:
+
+```ruby
+Gruf.configure do |c|
+  c.interceptors.use(Gruf::Lightstep::ServerInterceptor)
+end
+```
+
+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]` | `[]` |
+| 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
+very large values (such as binary or json data).
+
+### Client Interceptors
+
+To automatically propagate the trace context outbound, in your Gruf clients, pass the client interceptor
+to your `Gruf::Client` initializer:
+
+```ruby
+Gruf::Client.new(
+  service: MyService,
+  client_options: {
+    interceptors: [Gruf::Lightstep::ClientInterceptor.new]
+  }
+)
+```
+
+## License
+
+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 
+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/gruf-lightstep.gemspec

@@ -0,0 +1,39 @@
+# 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
+# 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 'gruf/lightstep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-lightstep'
+  spec.version       = Gruf::Lightstep::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = %q{Plugin for lightstep tracing for gruf}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/gruf-lightstep'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-lightstep.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.7'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'bc-lightstep-ruby', '~> 1.1'
+end

data/lib/gruf/lightstep.rb

@@ -0,0 +1,33 @@
+# 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
+# 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 'bigcommerce/lightstep'
+require_relative 'lightstep/version'
+require_relative 'lightstep/configuration'
+require_relative 'lightstep/client_interceptor'
+require_relative 'lightstep/server_interceptor'
+require_relative 'lightstep/headers'
+require_relative 'lightstep/method'
+
+##
+# Gruf main base module
+module Gruf
+  ##
+  # Lightstep gruf module
+  #
+  module Lightstep
+    extend Configuration
+  end
+end

data/lib/gruf/lightstep/client_interceptor.rb

@@ -0,0 +1,51 @@
+# 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
+# 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 Gruf
+  module Lightstep
+    ##
+    # Intercepts outbound calls to provide LightStep tracing
+    #
+    class ClientInterceptor < Gruf::Interceptors::ClientInterceptor
+      def call(request_context:)
+        span = active_span
+        if span
+          span_data = span.to_h
+          logger.debug "[gruf-lightstep] Injecting current active span #{span_data[:span_guid]} into outbound request context for #{request_context.method_name}"
+          request_context.metadata['ot-tracer-spanid'] = span_data[:span_guid].to_s
+          request_context.metadata['ot-tracer-traceid'] = span_data[:trace_guid].to_s
+          request_context.metadata['ot-tracer-sampled'] = '1'
+        end
+
+        yield
+      end
+
+      private
+
+      ##
+      # @return [::LightStep::Span|NilClass]
+      #
+      def active_span
+        tracer = ::Bigcommerce::Lightstep::Tracer.instance
+        return unless tracer
+
+        span = tracer.active_span
+        return unless span && span.is_a?(::LightStep::Span)
+
+        span
+      end
+    end
+  end
+end

data/lib/gruf/lightstep/configuration.rb

@@ -0,0 +1,81 @@
+# 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
+# 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 Gruf
+  module Lightstep
+    ##
+    # General configuration for lightstep integration
+    #
+    module Configuration
+      VALID_CONFIG_KEYS = {
+      }.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 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
+      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/gruf/lightstep/headers.rb

@@ -0,0 +1,73 @@
+# 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
+# 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 Gruf
+  module Lightstep
+    ##
+    # Abstraction accessor class for B3 propagation headers across GRPC ActiveCall objects
+    #
+    class Headers
+      attr_reader :active_call
+
+      ##
+      # @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)
+      }.freeze
+
+      delegate :has_key?, :key?, to: :metadata
+
+      ##
+      # @param [GRPC::ActiveCall] active_call
+      #
+      def initialize(active_call)
+        @active_call = active_call
+      end
+
+      ##
+      # Return a B3 propagation header if present
+      #
+      # @param [Symbol] key
+      # @return [String|NilClass]
+      #
+      def value(key)
+        return nil unless OT_KEYS.key?(key)
+        OT_KEYS[key].each do |k|
+          return metadata[k] if metadata.key?(k)
+        end
+        nil
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def metadata
+        @active_call.metadata
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def to_h
+        @active_call.metadata
+      end
+    end
+  end
+end

data/lib/gruf/lightstep/method.rb

@@ -0,0 +1,50 @@
+# 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
+# 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 Gruf
+  module Lightstep
+    ##
+    # Represents a Gruf gRPC method call
+    #
+    class Method
+      attr_reader :active_call, :signature, :request
+
+      ##
+      # @param [GRPC::ActiveCall] active_call The gRPC ActiveCall object for this method
+      # @param [String|Symbol] signature The method signature being called
+      # @param [Object] request The gRPC request object being used
+      #
+      def initialize(active_call, signature, request)
+        @active_call = active_call
+        @signature = signature.to_s
+        @request = request
+      end
+
+      ##
+      # @return [Gruf::Zipkin::Headers]
+      #
+      def headers
+        @headers ||= Gruf::Lightstep::Headers.new(@active_call)
+      end
+
+      ##
+      # @return [String]
+      #
+      def request_class
+        @request.class.to_s
+      end
+    end
+  end
+end

data/lib/gruf/lightstep/server_interceptor.rb

@@ -0,0 +1,89 @@
+# 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
+# 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 Gruf
+  module Lightstep
+    ##
+    # Intercepts inbound calls to provide LightStep tracing
+    #
+    class ServerInterceptor < Gruf::Interceptors::ServerInterceptor
+      ##
+      # Handle the gruf around hook and trace sampled requests
+      #
+      def call(&_block)
+        return yield if options.fetch(: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)
+
+          whitelist.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('grpc.error', true)
+            span.set_tag('grpc.error_code', e.code)
+            span.set_tag('grpc.error_class', e.class)
+            raise # passthrough, we just want the annotations
+          end
+        end
+        result
+      end
+
+      private
+
+      ##
+      # @return [Gruf::Lightstep::Method]
+      #
+      def request_method
+        Gruf::Lightstep::Method.new(request.active_call, request.method_key, request.message)
+      end
+
+      ##
+      # @return [Hash]
+      #
+      def request_message_params
+        return {} if request.client_streamer? || !request.message.respond_to?(:to_h)
+        request.message.to_h
+      end
+
+      ##
+      # @return [Boolean]
+      #
+      def error?(exception)
+        error_classes.include?(exception.class.to_s)
+      end
+
+      ##
+      # @return [Array]
+      #
+      def error_classes
+        options.fetch(:error_classes, %w(GRPC::Unknown GRPC::Internal GRPC::DataLoss GRPC::FailedPrecondition GRPC::Unavailable GRPC::DeadlineExceeded GRPC::Cancelled))
+      end
+    end
+  end
+end

data/lib/gruf/lightstep/version.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: gruf-lightstep
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !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: bc-lightstep-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Plugin for lightstep tracing for gruf
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-lightstep.gemspec
+- lib/gruf/lightstep.rb
+- lib/gruf/lightstep/client_interceptor.rb
+- lib/gruf/lightstep/configuration.rb
+- lib/gruf/lightstep/headers.rb
+- lib/gruf/lightstep/method.rb
+- lib/gruf/lightstep/server_interceptor.rb
+- lib/gruf/lightstep/version.rb
+homepage: https://github.com/bigcommerce/gruf-lightstep
+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: Plugin for lightstep tracing for gruf
+test_files: []