gruf-stackdriver-trace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca00c8725668e0974387526b28f3247e9fdfe540cb074dbe44ef456c6c0a5ac0
+  data.tar.gz: 417d37540f9e577ed0af5c7553480e8dec5203dbeeaa6536ff84685fd0fd5794
+SHA512:
+  metadata.gz: 4b20fece431eeca45b5903157ecaa96c3aa1aa5817284e90cf4bbe46892319a564b49696a42fe6811326c1feb4a75a333e885d7b7deba3f5239ed347dd0ba73f
+  data.tar.gz: 7f82e02e2b304aa18e9499012e387574ad7d556b34f9de66e3a64ffc4cf74bc75f0d71781fc07e5e12c6b24d53682923bd0b2de680be7d5728ce87ad6d82ee0e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dameleon@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gruf-stackdriver-trace.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    gruf-stackdriver-trace (0.1.0)
+      activesupport (> 4)
+      google-cloud-env (~> 1.3)
+      google-cloud-trace (~> 0.35)
+      grpc (~> 1.21)
+      gruf (~> 2.5)
+      stackdriver-core (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faraday (0.17.1)
+      multipart-post (>= 1.2, < 3)
+    google-cloud-core (1.4.1)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.3.0)
+      faraday (~> 0.11)
+    google-cloud-trace (0.36.1)
+      concurrent-ruby (~> 1.1)
+      google-cloud-core (~> 1.2)
+      google-gax (~> 1.8)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleapis-common-protos-types (>= 1.0.4, < 2.0)
+      stackdriver-core (~> 1.3)
+    google-gax (1.8.1)
+      google-protobuf (~> 3.9)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleauth (~> 0.9)
+      grpc (~> 1.24)
+      rly (~> 0.2.3)
+    google-protobuf (3.11.0)
+    googleapis-common-protos (1.3.9)
+      google-protobuf (~> 3.0)
+      googleapis-common-protos-types (~> 1.0)
+      grpc (~> 1.0)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    googleauth (0.10.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.12)
+    grpc (1.25.0)
+      google-protobuf (~> 3.8)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.25.0)
+    gruf (2.7.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      slop (~> 4.6)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.1)
+    memoist (0.16.1)
+    minitest (5.13.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    os (1.0.1)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rly (0.2.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    signet (0.12.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    slop (4.7.0)
+    stackdriver-core (1.4.0)
+      google-cloud-core (~> 1.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  gruf-stackdriver-trace!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Atman Inc.
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kei Takahashi
+
+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/README.md

@@ -0,0 +1,110 @@
+# Gruf::StackdriverTrace
+
+Add Stackdriver trace support for [gruf](https://github.com/bigcommerce/gruf).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gruf-stackdriver-trace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gruf-stackdriver-trace
+
+## Usage
+
+### ServerInterceptor
+
+Configure and use interceptor in gruf's initializer.
+
+```
+require 'gruf/stackdriver_trace'
+
+Gruf.configure do |c|
+  # optional
+  Gruf::StackdriverTrace.configure do |config|
+  end
+  
+  c.interceptors.use(Gruf::StackdriverTrace::ServerInterceptor)
+end
+```
+
+### ClientInterceptor
+
+Specify `Gruf::StackdriverTrace::ClientInterceptor` instance to `client_options[:interceptors]`.
+
+```
+client = Gruf::Client.new(
+    service: Rpc::Products,
+    client_options: {
+        interceptors: [
+            Gruf::StackdriverTrace::ClientInterceptor.new
+        ]
+    }
+)
+resp = client.call(:GetProduct)
+```
+
+NOTE: `Gruf::StackdriverTrace::ClientInterceptor` will not be enabled if the tracing context of `Gruf::StackdriverTrace::ServerInterceptor` or Stackdriver Trace(ex. use with Rails middleware) cannot be obtained.
+
+
+### Configuration
+
+You can configure with `Gruf::StackdriverTrace.configure { |config| ... }`.
+
+REF: https://github.com/googleapis/google-cloud-ruby/blob/master/stackdriver/INSTRUMENTATION_CONFIGURATION.md#trace
+
+- `config[:service]` (default: `nil`)
+    - A reporter Class that provides to send traced data 
+    - SEE: https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-trace/lib/google/cloud/trace/async_reporter.rb
+- `config[:sampled]` (default: `true`)
+    - Whether to capture tracing 
+    - `true`: enable tracing
+    - `false`: disable tracing
+    - ex. `config[:sampled] = Rails.env.production?` to be enable tracing in only production env.
+- `config[:capture_stack]` (default: `true`)
+    - Whether to capture stack traces for each span
+    - `true`: enable to recording of stack trace
+    - `false`: disable to recording of stack trace
+- `config[:sampler]` (default: `nil`)
+    - A sampler Class makes the decision whether to record a trace for each request
+    - SEE: https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-trace/lib/google/cloud/trace/time_sampler.rb
+- `config[:span_id_generator]` (default: `nil`)
+    - A generator Proc that generates the name String for new TraceRecord
+    - SEE: https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-trace/lib/google/cloud/trace/trace_record.rb#L59-L60
+
+#### Without GCP environment
+
+If you are running the application locally, in self-hosted VMs, or a third party hosting service, you will need to provide the project ID and credentials (keyfile) to the Google Cloud client library. See [this section](https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-trace#running-locally-and-elsewhere) for details.
+
+ex.
+
+```
+Google::Cloud.configure do |config|
+  config.project_id = "your-project-id"
+  config.keyfile = "path/to/service-account.json"
+end
+```
+
+## Development
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/atman-inc/gruf-stackdriver-trace. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gruf::StackdriverTrace project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gruf-stackdriver-trace/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gruf-stackdriver-trace.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gruf/stackdriver_trace/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gruf-stackdriver-trace"
+  spec.version       = Gruf::StackdriverTrace::VERSION
+  spec.authors       = ["Kei Takahashi"]
+  spec.email         = ["dameleon@gmail.com"]
+
+  spec.summary       = %q{Stackdriver trace for gruf}
+  spec.description   = %q{Plugin for Stackdirver trace for bigcommerce/gruf}
+  spec.homepage      = "https://github.com/atman-inc/gruf-stackdriver-trace"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "gruf", "~> 2.5"
+  spec.add_dependency "grpc", "~> 1.21"
+  spec.add_dependency "stackdriver-core", "~> 1.3"
+  spec.add_dependency "google-cloud-env", "~> 1.3"
+  spec.add_dependency "google-cloud-trace", "~> 0.35"
+  spec.add_dependency "activesupport", "> 4"
+end

data/lib/gruf/stackdriver_trace.rb

@@ -0,0 +1,57 @@
+require 'grpc'
+require 'gruf'
+require "google/cloud/env"
+require "google/cloud/trace"
+require "google/cloud/trace/async_reporter"
+require "stackdriver/core/trace_context"
+require_relative "stackdriver_trace/client_interceptor"
+require_relative "stackdriver_trace/server_interceptor"
+require_relative "stackdriver_trace/version"
+
+module Gruf
+  module StackdriverTrace
+    AGENT_NAME = "gruf-stackdriver-trace #{Gruf::StackdriverTrace::VERSION}".freeze
+    HEADER_KEY = 'x-trace-context'.freeze
+
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= {
+          service: nil,
+          sampled: true,
+          capture_stack: true,
+          sampler: nil,
+          span_id_generator: nil
+      }
+    end
+
+    def self.service
+      @service ||= begin
+        init_default_config
+
+        return config[:service] if config[:service]
+        return nil unless configuration.project_id
+
+        tracer = Google::Cloud::Trace.new(
+            project_id: configuration.project_id,
+            credentials: configuration.credentials
+        )
+        Google::Cloud::Trace::AsyncReporter.new(tracer.service)
+      end
+    end
+
+    def self.init_default_config
+      configuration.project_id ||= Google::Cloud::Trace.default_project_id
+      configuration.credentials ||= Google::Cloud.configure.credentials
+      configuration.capture_stack = config.fetch(:capture_stack, true)
+      configuration.sampler = config.fetch(:sampler, nil)
+      configuration.span_id_generator = config.fetch(:span_id_generator, nil)
+    end
+
+    def self.configuration
+      Google::Cloud::Trace.configure
+    end
+  end
+end

data/lib/gruf/stackdriver_trace/client_interceptor.rb

@@ -0,0 +1,43 @@
+require_relative 'label'
+
+module Gruf
+  module StackdriverTrace
+    class ClientInterceptor < Gruf::Interceptors::ClientInterceptor
+      include Gruf::StackdriverTrace::Label
+
+      def call(request_context:)
+        Google::Cloud::Trace.in_span("grpc-request") do |span|
+          return yield request_context unless span
+          set_request_metadata(request_context.metadata, span)
+          configure_span(span, request_context)
+          result = Gruf::Interceptors::Timer.time do
+            yield request_context
+          end
+          add_response_labels(span.labels, result)
+          raise result.message unless result.successful?
+          result.message
+        end
+      end
+
+      private
+
+      def set_request_metadata(metadata, span)
+        metadata[Gruf::StackdriverTrace::HEADER_KEY] = span.trace.trace_context.to_s
+      end
+
+      def configure_span(span, request_context)
+        method_name = request_context.method.to_s.gsub(/^\//, '')
+        span.name = "Sent: #{method_name}"
+        set_stack_trace(span, 4)
+        set_basic_labels(span.labels, request_context, method_name)
+        set_label(span.labels, label_key::RPC_REQUEST_TYPE, request_context.type.to_s)
+        span
+      end
+
+      def add_response_labels(labels, result)
+        code = result.successful? ? ::GRPC::Core::StatusCodes::OK : result.message.code
+        set_grpc_status_code(labels, code)
+      end
+    end
+  end
+end

data/lib/gruf/stackdriver_trace/label.rb

@@ -0,0 +1,58 @@
+module Gruf
+  module StackdriverTrace
+    module Label
+      def status_code_to_label(code)
+        @lookup ||= Hash[GRPC::Core::StatusCodes.constants.map do |c|
+          [GRPC::Core::StatusCodes.const_get(c), c.to_s]
+        end]
+        @lookup[code]
+      end
+
+      def label_key
+        Google::Cloud::Trace::LabelKey
+      end
+
+      def set_label(labels, key, value)
+        labels[key] = value.to_s
+      end
+
+      def set_basic_labels(labels, request, method_name)
+        set_label(labels, label_key::AGENT, Gruf::StackdriverTrace::AGENT_NAME)
+        set_label(labels, label_key::HTTP_HOST, get_host(request))
+        set_label(labels, label_key::HTTP_CLIENT_PROTOCOL, 'http2')
+        set_label(labels, label_key::HTTP_USER_AGENT, get_ua(request))
+        set_label(labels, label_key::HTTP_URL, method_name)
+        set_label(labels, label_key::PID, ::Process.pid)
+        set_label(labels, label_key::TID, ::Thread.current.object_id)
+      end
+
+      def set_stack_trace(span, skip_frames)
+        tc = span.trace.trace_context
+        return unless tc.capture_stack?
+        label_key.set_stack_trace(span.labels, skip_frames: skip_frames)
+      end
+
+      def set_grpc_status_code(labels, status_code)
+        set_label(labels, label_key::RPC_STATUS_CODE, status_code_to_label(status_code))
+      end
+
+      def get_ua(request)
+        metadata = request_context?(request) ? request.metadata : request.active_call.metadata
+        metadata['user-agent'] || nil
+      end
+
+      def get_host(request)
+        if request_context?(request)
+          # get request host from GRPC::ActiveCall::InterceptableView
+          request.call.instance_variable_get(:@wrapped).try(:peer)
+        else
+          request.active_call.peer
+        end
+      end
+
+      def request_context?(request)
+        request.is_a?(Gruf::Outbound::RequestContext)
+      end
+    end
+  end
+end

data/lib/gruf/stackdriver_trace/server_interceptor.rb

@@ -0,0 +1,149 @@
+require_relative 'label'
+
+module Gruf
+  module StackdriverTrace
+    class ServerInterceptor < Gruf::Interceptors::ServerInterceptor
+      include Gruf::StackdriverTrace::Label
+
+      def call
+        return yield if service.nil?
+
+        trace = create_trace(request)
+        begin
+          Google::Cloud::Trace.set(trace)
+          Google::Cloud::Trace.in_span("grpc-request-received") do |span|
+            configure_span(span, request)
+            result = Gruf::Interceptors::Timer.time do
+              yield
+            end
+            set_grpc_status_code(
+                span.labels,
+                result.successful? ? ::GRPC::Core::StatusCodes::OK : result.message.code
+            )
+            raise result.message unless result.successful?
+            result.message
+          end
+        ensure
+          Google::Cloud::Trace.set(nil)
+          send_trace(trace)
+        end
+      end
+
+      private
+
+      def create_trace(request)
+        trace_context = get_trace_context(request)
+        Google::Cloud::Trace::TraceRecord.new(
+          service.project,
+          trace_context,
+          span_id_generator: configuration.span_id_generator
+        )
+      end
+
+      def get_trace_context(request)
+        rack_env = simulated_rack_env(request)
+        sampler = configuration.sampler || Google::Cloud::Trace::TimeSampler.default
+        header = request.active_call.metadata[Gruf::StackdriverTrace::HEADER_KEY]
+        return Stackdriver::Core::TraceContext.new(
+            sampled: Gruf::StackdriverTrace.config[:sampled] && sampler.call(rack_env),
+            capture_stack: Gruf::StackdriverTrace.config[:capture_stack]
+        ) unless header
+        tc = Stackdriver::Core::TraceContext.parse_string(header)
+        if tc.sampled?.nil?
+          sampled = sampler.call(rack_env)
+          tc = Stackdriver::Core::TraceContext.new(
+            trace_id: tc.trace_id,
+            span_id: tc.span_id,
+            sampled: sampled,
+            capture_stack: sampled && configuration.capture_stack
+          )
+        end
+        tc
+      end
+
+      def configure_span(span, request)
+        method_name = [
+            request.service.service_name,
+            request.method_key.to_s.camelize
+        ].join('/')
+        span.name = "Recv: #{method_name}"
+        set_stack_trace(span, 4)
+        set_basic_labels(span.labels, request, method_name)
+        set_extended_labels(span.labels)
+        span
+      end
+
+      def set_extended_labels(labels)
+        if Google::Cloud.env.app_engine?
+          set_label(
+            labels,
+            label_key::GAE_APP_MODULE,
+            Google::Cloud.env.app_engine_service_id
+          )
+          set_label(
+            labels,
+            label_key::GAE_APP_MODULE_VERSION,
+            Google::Cloud.env.app_engine_service_version
+          )
+        end
+        # TODO: set GKE env options
+      end
+
+      def send_trace(trace)
+        if trace.trace_context.sampled?
+          begin
+            service.patch_traces(trace)
+          rescue StandardError => e
+            handle_error(e, logger: Gruf.logger)
+          end
+        end
+      end
+
+      def handle_error(error, logger: nil)
+        if error_callback
+          error_callback.call(error)
+        else
+          msg = "Transmit to Stackdriver Trace failed: #{error.inspect}"
+          if logger
+            logger.error(msg)
+          else
+            warn(msg)
+          end
+        end
+      end
+
+      def error_callback
+        if @error_callback.nil?
+          @error_callback = :unset
+          configuration_callback = configuration.on_error
+          configuration_callback ||= Google::Cloud.configure.on_error
+          @error_callback = configuration_callback if configuration_callback
+        end
+
+        return nil if @error_callback == :unset
+        @error_callback
+      end
+
+      def simulated_rack_env(request)
+        # REF: https://github.com/googleapis/google-cloud-ruby/blob/2ad4e22280dc8a2e61613251461e8049129deb4b/google-cloud-trace/lib/google/cloud/trace/time_sampler.rb#L98-L102
+        # simulate rack env with Gruf's request for dependencies compatibility(ex. TimeSampler#call)
+        # for example
+        #   SCRIPT_NAME => 'grpc.health.v1',
+        #   PATH_INFO => '/Check'
+        # be passed 'grpc.health.v1/Check' to blacklist checking
+        {
+          'SCRIPT_NAME' => request.service.service_name,
+          'PATH_INFO' => "/#{request.method_key.to_s.camelize}"
+        }
+      end
+
+      def service
+        @service ||= Gruf::StackdriverTrace.service
+      end
+
+      def configuration
+        @configuration ||= Gruf::StackdriverTrace.configuration
+      end
+    end
+  end
+end

data/lib/gruf/stackdriver_trace/version.rb

@@ -0,0 +1,5 @@
+module Gruf
+  module StackdriverTrace
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: gruf-stackdriver-trace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kei Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: stackdriver-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-trace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Plugin for Stackdirver trace for bigcommerce/gruf
+email:
+- dameleon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- gruf-stackdriver-trace.gemspec
+- lib/gruf/stackdriver_trace.rb
+- lib/gruf/stackdriver_trace/client_interceptor.rb
+- lib/gruf/stackdriver_trace/label.rb
+- lib/gruf/stackdriver_trace/server_interceptor.rb
+- lib/gruf/stackdriver_trace/version.rb
+homepage: https://github.com/atman-inc/gruf-stackdriver-trace
+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.6
+signing_key: 
+specification_version: 4
+summary: Stackdriver trace for gruf
+test_files: []