grpc_opencensus_interceptor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c84957ff2c9d44336456778af7145cc38d1bbd74e54375d1a5bb3c1d56c323be
-  data.tar.gz: bccd9a4397ce695db700d6b0893d5abd6144bb9d4c288a20d94d1a8daae63aaa
+  metadata.gz: 858e38644b3a323462339607aed2c45ae1cdb317de12d345094911a5a6a733ef
+  data.tar.gz: d43818860944836bdc399e7a54c642a572c4da4df416a8c710bddd1d0c4b172b
 SHA512:
-  metadata.gz: ba6e5cb703795e1c5f755dba71010b7df80ad3bc4a0c4afc31779a8315099949695ab847382338ac106d1208b15fa81311465e1c81ab514af37b16521f55d85f
-  data.tar.gz: '08e725b44a73ac30b62c5751563bb9ca3c2d58ba3e6f60118e64bfda711bdda3b87e346d8222827c14dc8e242ed64b522611a07486945255c39667dc6b27d302'
+  metadata.gz: 9b73ac05b6a2b37dba65cfda255b93d01d30a050bb2c76a2c1e50ee3a44c8431909361e11b14a0f2e93894524bf60a484d1d50d4136539cb757a9ea9a39ad27c
+  data.tar.gz: 511f290f14c2d0ad8ae92fe31a40e694b10483b96431a86315315bd4f5da40991eb6c599aa004bab78c033950d7b9ba969b9c6ed601e8aa347fde9f4c183f52d

data/.travis.yml

@@ -4,4 +4,7 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.3
-before_install: gem install bundler -v 2.0.2
+before_install:
+  - gem install bundler -v 2.0.2
+script:
+  - bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc_opencensus_interceptor (0.0.1)
+    grpc_opencensus_interceptor (0.0.2)
       grpc
       opencensus
 
@@ -10,11 +10,11 @@ GEM
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
-    google-protobuf (3.11.2)
+    google-protobuf (3.11.4)
     googleapis-common-protos-types (1.0.4)
       google-protobuf (~> 3.0)
-    grpc (1.26.0)
-      google-protobuf (~> 3.8)
+    grpc (1.27.0)
+      google-protobuf (~> 3.11)
       googleapis-common-protos-types (~> 1.0)
     method_source (0.9.2)
     opencensus (0.5.0)
@@ -24,7 +24,7 @@ GEM
     pry-doc (1.0.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -48,7 +48,7 @@ DEPENDENCIES
   grpc_opencensus_interceptor!
   pry
   pry-doc
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -19,6 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
+### Server
 Please set a `GrpcOpencensusInterceptor` as an interceptor of your gRPC application.
 
 ```ruby
@@ -27,13 +28,25 @@ require 'grpc_opencensus_interceptor'
 
 server = GRPC::RpcServer.new(
   interceptors: [
-    GrpcOpencensusInterceptor.new,
+    GrpcOpencensusInterceptor::ServerInterceptor.new,
   ]
 )
 server.handle(MyHandler.new)
 server.run_till_terminated_or_interrupted(['SIGINT'])
 ```
 
+### Client
+
+```ruby
+require 'grpc'
+require 'grpc_opencensus_interceptor'
+url = "dns:test-service:80"
+stub = TestService::Stub.new(url, :this_channel_is_insecure, interceptors: [
+  GrpcOpencensusInterceptor::ClientInterceptor.new,
+])
+stub.hello_rpc
+```
+
 ## 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.

data/grpc_opencensus_interceptor.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-doc"

data/lib/grpc_opencensus_interceptor.rb

@@ -1,5 +1,10 @@
-require "grpc_opencensus_interceptor/version"
+require "opencensus"
+require "grpc"
+
+require "grpc_opencensus_interceptor/client_interceptor"
 require "grpc_opencensus_interceptor/server_interceptor"
+require "grpc_opencensus_interceptor/util"
+require "grpc_opencensus_interceptor/version"
 
 module GrpcOpencensusInterceptor
   class << self

data/lib/grpc_opencensus_interceptor/client_interceptor.rb

@@ -0,0 +1,83 @@
+module GrpcOpencensusInterceptor
+  class ClientInterceptor < GRPC::ClientInterceptor
+    # @param [SpanContext] span_context The span context within which
+    #     to create spans. Optional: If omitted, spans are created in the
+    #     current thread-local span context.
+    # @param [#call] sampler The sampler to use when creating spans.
+    #     Optional: If omitted, uses the sampler in the current config.
+    def initialize(span_context: nil, sampler: nil)
+      @span_context = span_context || OpenCensus::Trace
+      @sampler      = sampler
+      @serializer   = OpenCensus::Trace::Formatters::Binary.new
+    end
+
+    ##
+    # Intercept a unary request response call
+    #
+    # @param [Object] request
+    # @param [GRPC::ActiveCall] call
+    # @param [String] method
+    # @param [Hash] metadata
+    #
+    def request_response(request:, call:, method:, metadata:)
+      span_context = @span_context
+      if span_context == OpenCensus::Trace && !span_context.span_context
+        return yield
+      end
+
+      # NOTE: Use method as span name
+      span_name = method
+
+      span = span_context.start_span span_name, sampler: @sampler
+      start_request span, method, metadata
+      begin
+        grpc_ex = GRPC::Ok.new
+        yield
+      rescue StandardError => e
+        grpc_ex = Util.to_grpc_ex(e)
+        raise e
+      ensure
+        finish_request span, grpc_ex
+        span_context.end_span span
+      end
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+  private
+
+    ##
+    # @private Set span attributes
+    #
+    # @param [OpenCensus::Trace::SpanBuilder] span
+    # @param [String] method
+    # @param [Hash] metadata
+    #
+    def start_request span, method, metadata
+      span.kind = OpenCensus::Trace::SpanBuilder::CLIENT
+      span.put_attribute "http.method", "POST" # NOTE: Always use POST
+
+      span.put_attribute "http.path", method
+
+      # TODO(south37) Set attributes
+      # span.put_message_event SpanBuilder::SENT, 1, body_size
+
+      trace_context = @serializer.serialize span.context.trace_context
+      metadata[Util::OPENCENSUS_TRACE_BIN_KEY] = trace_context
+    end
+
+    ##
+    # @private Set span attributes from response
+    #
+    # @param [OpenCensus::Trace::SpanBuilder] span
+    # @param [GRPC::BadStatus] exception
+    #
+    def finish_request span, exception
+      span.set_status exception.code
+      span.put_attribute "http.status_code", Util.to_http_status(exception)
+
+      # TODO(south37) Set attributes
+      # span.put_message_event SpanBuilder::RECEIVED, 1, body_size
+    end
+  end
+end

data/lib/grpc_opencensus_interceptor/server_interceptor.rb

@@ -1,10 +1,7 @@
-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
@@ -26,11 +23,11 @@ module GrpcOpencensusInterceptor
     # @param [Method] method
     #
     def request_response(request:, call:, method:)
-      context_bin = call.metadata[OPENCENSUS_TRACE_BIN_KEY]
+      context_bin = call.metadata[Util::OPENCENSUS_TRACE_BIN_KEY]
       if context_bin
         context = deserialize(context_bin)
       else
-        cojntext = nil
+        context = nil
       end
 
       OpenCensus::Trace.start_request_trace(
@@ -45,7 +42,7 @@ module GrpcOpencensusInterceptor
               grpc_ex = GRPC::Ok.new
               yield
             rescue StandardError => e
-              grpc_ex = to_grpc_ex(e)
+              grpc_ex = Util.to_grpc_ex(e)
               raise e
             ensure
               finish_request(span, grpc_ex)
@@ -67,6 +64,7 @@ module GrpcOpencensusInterceptor
       @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
     #
@@ -88,6 +86,7 @@ module GrpcOpencensusInterceptor
       term.split("_").map(&:capitalize).join
     end
 
+    ##
     # Modify span by custom span modifier
     #
     # @param [OpenCensus::Trace::SpanBuilder] span
@@ -116,56 +115,7 @@ module GrpcOpencensusInterceptor
       # 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
+      span.put_attribute "http.status_code", Util.to_http_status(exception)
     end
   end
 end

data/lib/grpc_opencensus_interceptor/util.rb

@@ -0,0 +1,56 @@
+module GrpcOpencensusInterceptor
+  module Util
+    OPENCENSUS_TRACE_BIN_KEY = "grpc-trace-bin".freeze
+
+    class << self
+      # 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
+end

data/lib/grpc_opencensus_interceptor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_opencensus_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nao Minami
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,8 +128,10 @@ files:
 - bin/setup
 - grpc_opencensus_interceptor.gemspec
 - lib/grpc_opencensus_interceptor.rb
+- lib/grpc_opencensus_interceptor/client_interceptor.rb
 - lib/grpc_opencensus_interceptor/server_interceptor.rb
 - lib/grpc_opencensus_interceptor/server_interceptor/span_modifier.rb
+- lib/grpc_opencensus_interceptor/util.rb
 - lib/grpc_opencensus_interceptor/version.rb
 homepage: https://github.com/south37/grpc_opencensus_interceptor
 licenses: