grpc_opencensus_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c84957ff2c9d44336456778af7145cc38d1bbd74e54375d1a5bb3c1d56c323be
+  data.tar.gz: bccd9a4397ce695db700d6b0893d5abd6144bb9d4c288a20d94d1a8daae63aaa
+SHA512:
+  metadata.gz: ba6e5cb703795e1c5f755dba71010b7df80ad3bc4a0c4afc31779a8315099949695ab847382338ac106d1208b15fa81311465e1c81ab514af37b16521f55d85f
+  data.tar.gz: '08e725b44a73ac30b62c5751563bb9ca3c2d58ba3e6f60118e64bfda711bdda3b87e346d8222827c14dc8e242ed64b522611a07486945255c39667dc6b27d302'

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

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 south37777@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in grpc_opencensus_interceptor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    grpc_opencensus_interceptor (0.0.1)
+      grpc
+      opencensus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    google-protobuf (3.11.2)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    grpc (1.26.0)
+      google-protobuf (~> 3.8)
+      googleapis-common-protos-types (~> 1.0)
+    method_source (0.9.2)
+    opencensus (0.5.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  grpc_opencensus_interceptor!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nao Minami
+
+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,53 @@
+# GrpcOpencensusInterceptor
+An interceptor for using [OpenCensus](https://opencensus.io/) with gRPC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc_opencensus_interceptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc_opencensus_interceptor
+
+## Usage
+
+Please set a `GrpcOpencensusInterceptor` as an interceptor of your gRPC application.
+
+```ruby
+require 'grpc'
+require 'grpc_opencensus_interceptor'
+
+server = GRPC::RpcServer.new(
+  interceptors: [
+    GrpcOpencensusInterceptor.new,
+  ]
+)
+server.handle(MyHandler.new)
+server.run_till_terminated_or_interrupted(['SIGINT'])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/south37/grpc_opencensus_interceptor. 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 GrpcOpencensusInterceptor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/south37/grpc_opencensus_interceptor/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/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grpc_opencensus_interceptor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grpc_opencensus_interceptor.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grpc_opencensus_interceptor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grpc_opencensus_interceptor"
+  spec.version       = GrpcOpencensusInterceptor::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{An interceptor for using OpenCensus with gRPC.}
+  spec.description   = %q{An interceptor for using OpenCensus with gRPC.}
+  spec.homepage      = "https://github.com/south37/grpc_opencensus_interceptor"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/south37/grpc_opencensus_interceptor"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_dependency "grpc"
+  spec.add_dependency "opencensus"
+end

data/lib/grpc_opencensus_interceptor.rb

@@ -0,0 +1,10 @@
+require "grpc_opencensus_interceptor/version"
+require "grpc_opencensus_interceptor/server_interceptor"
+
+module GrpcOpencensusInterceptor
+  class << self
+    def new(options = {})
+      ServerInterceptor.new(**options)
+    end
+  end
+end

data/lib/grpc_opencensus_interceptor/server_interceptor.rb

@@ -0,0 +1,171 @@
+require "opencensus"
+require "grpc"
+require "grpc_opencensus_interceptor/server_interceptor/span_modifier"
+
+module GrpcOpencensusInterceptor
+  class ServerInterceptor < GRPC::ServerInterceptor
+    OPENCENSUS_TRACE_BIN_KEY = "grpc-trace-bin".freeze
+
+    # @param [#export] exporter The exported used to export captured spans
+    #     at the end of the request. Optional: If omitted, uses the exporter
+    #     in the current config.
+    # @param [SpanModifier, call] span_modifier Modify span if necessary. It
+    # takes span, request, call, method as its parameters.
+    #
+    def initialize(exporter: nil, span_modifier: nil)
+      @exporter      = exporter || OpenCensus::Trace.config.exporter
+      @span_modifier = span_modifier
+      @deserializer  = OpenCensus::Trace::Formatters::Binary.new
+    end
+
+    ##
+    # Intercept a unary request response call.
+    #
+    # @param [Object] request
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    #
+    def request_response(request:, call:, method:)
+      context_bin = call.metadata[OPENCENSUS_TRACE_BIN_KEY]
+      if context_bin
+        context = deserialize(context_bin)
+      else
+        cojntext = nil
+      end
+
+      OpenCensus::Trace.start_request_trace(
+        trace_context:          context,
+        same_process_as_parent: false) do |span_context|
+        begin
+          OpenCensus::Trace.in_span get_name(method) do |span|
+            modify_span(span, request, call, method)
+
+            start_request(span, call, method)
+            begin
+              grpc_ex = GRPC::Ok.new
+              yield
+            rescue StandardError => e
+              grpc_ex = to_grpc_ex(e)
+              raise e
+            ensure
+              finish_request(span, grpc_ex)
+            end
+          end
+        ensure
+          @exporter.export span_context.build_contained_spans
+        end
+      end
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+  private
+
+    # @param [String] context_bin OpenCensus span context in binary format
+    # @return [OpenCensus::Trace::TraceContextData, nil]
+    def deserialize(context_bin)
+      @deserializer.deserialize(context_bin)
+    end
+
+    # Span name is represented as $package.$service/$method
+    # cf. https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/gRPC.md#spans
+    #
+    # @param [Method] method
+    # @return [String]
+    def get_name(method)
+      "#{method.owner.service_name}/#{camelize(method.name.to_s)}"
+    end
+
+    # @param [Method] method
+    # @return [String]
+    def get_path(method)
+      "/" + get_name(method)
+    end
+
+    # @param [String] term
+    # @return [String]
+    def camelize(term)
+      term.split("_").map(&:capitalize).join
+    end
+
+    # Modify span by custom span modifier
+    #
+    # @param [OpenCensus::Trace::SpanBuilder] span
+    # @param [Object] request
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    def modify_span(span, request, call, method)
+      @span_modifier.call(span, request, call, method) if @span_modifier
+    end
+
+    # @param [OpenCensus::Trace::SpanBuilder] span
+    # @param [GRPC::ActiveCall::SingleReqView] call
+    # @param [Method] method
+    def start_request(span, call, method)
+      span.kind = OpenCensus::Trace::SpanBuilder::SERVER
+      span.put_attribute "http.path", get_path(method)
+      span.put_attribute "http.method", "POST"  # gRPC always uses "POST"
+      if call.metadata['user-agent']
+        span.put_attribute "http.user_agent", call.metadata['user-agent']
+      end
+    end
+
+    # @param [OpenCensus::Trace::SpanBuilder] span
+    # @param [GRPC::BadStatus] exception
+    def finish_request(span, exception)
+      # Set gRPC server status
+      # https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/gRPC.md#spans
+      span.set_status exception.code
+      span.put_attribute "http.status_code", to_http_status(exception)
+    end
+
+    # cf. https://github.com/grpc/grpc/blob/master/doc/http-grpc-status-mapping.md
+    # cf. https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/HTTP.md#mapping-from-http-status-codes-to-trace-status-codes
+    #
+    # @param [GRPC::BadStatus] exception
+    # @return [Integer]
+    def to_http_status(exception)
+      case exception
+      when GRPC::Ok
+        200
+      when GRPC::InvalidArgument
+        400
+      when GRPC::DeadlineExceeded
+        504
+      when GRPC::NotFound
+        404
+      when GRPC::PermissionDenied
+        403
+      when GRPC::Unauthenticated
+        401
+      when GRPC::Aborted
+        # For GRPC::Aborted, grpc-gateway uses 409. We do the same.
+        # cf. https://github.com/grpc-ecosystem/grpc-gateway/blob/e8db07a3923d3f5c77dbcea96656afe43a2757a8/runtime/errors.go#L17-L58
+        409
+      when GRPC::ResourceExhausted
+        429
+      when GRPC::Unimplemented
+        501
+      when GRPC::Unavailable
+        503
+      when GRPC::Unknown
+        # NOTE: This is not same with the correct mapping
+        500
+      else
+        # NOTE: Here, we use 500 temporarily.
+        500
+      end
+    end
+
+    # @param [Exception] e
+    # @return [GRPC::BadStatus] e
+    def to_grpc_ex(e)
+      case e
+      when GRPC::BadStatus
+        e
+      else
+        GRPC::Unknown.new(e.message)
+      end
+    end
+  end
+end

data/lib/grpc_opencensus_interceptor/server_interceptor/span_modifier.rb

@@ -0,0 +1,16 @@
+module GrpcOpencensusInterceptor
+  class ServerInterceptor < GRPC::ServerInterceptor
+    ##
+    # Modify span by request, call, method if necessary
+    #
+    class SpanModifier
+      # @param [OpenCensus::Trace::SpanBuilder] span
+      # @param [Object] request
+      # @param [GRPC::ActiveCall::SingleReqView] call
+      # @param [Method] method
+      def call(span, request, call, method)
+        # Do something necessary
+      end
+    end
+  end
+end

data/lib/grpc_opencensus_interceptor/version.rb

@@ -0,0 +1,3 @@
+module GrpcOpencensusInterceptor
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: grpc_opencensus_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 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: pry-doc
+  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: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opencensus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An interceptor for using OpenCensus with gRPC.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grpc_opencensus_interceptor.gemspec
+- lib/grpc_opencensus_interceptor.rb
+- lib/grpc_opencensus_interceptor/server_interceptor.rb
+- lib/grpc_opencensus_interceptor/server_interceptor/span_modifier.rb
+- lib/grpc_opencensus_interceptor/version.rb
+homepage: https://github.com/south37/grpc_opencensus_interceptor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/south37/grpc_opencensus_interceptor
+  source_code_uri: https://github.com/south37/grpc_opencensus_interceptor
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: An interceptor for using OpenCensus with gRPC.
+test_files: []