griffin-interceptors 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 772bd86a69a96858bd66e4f81551ddcf0b9a6549
-  data.tar.gz: 951bacb34052702b3f89249fd29acf68dc1e5596
+  metadata.gz: d687a238cf3ecde03021fd40766e81c2a863246b
+  data.tar.gz: 3c8421032378fd6c396c5752d1433550932b76f2
 SHA512:
-  metadata.gz: 2e04ae6298bc7a9a7034de52381afc47a219de1fa48bc394a742b65d0fe33f147efd7e2868e1d995c958ca710ce5f74452afc8bc90c2a772f6fd6ac757a06f4e
-  data.tar.gz: 1af485be413670f6a7b3b77c1e68fcba6d9b8f139fa934f778057e222d03f255fcb3b9bc74140b0a613d50d866d37742540d5bfa19da5a04c7d6ea3108cc6284
+  metadata.gz: 410427b0ef506f0e6c04f9ab7ef5adde9fe1c788acb55582359c052839837054b4bf14700bc755bb2561031ff7ea393bf73f544dc29a111ebdf4727bdb8dedb7
+  data.tar.gz: 9d0a90d658c1fb7a51ac28392875d57c7eaa9b9d3d540489c9cb06f0fa8bba9ee7015cbc5c60ef6de283b3bd4e048d261f9896f010e673359f849ae39cfe83f3

data/griffin-interceptors.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'griffin', '~> 0.1.3'
+  spec.add_dependency 'griffin', '>= 0.1.5'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/griffin/interceptors/call_stream.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'grpc_kit'
+require 'forwardable'
+
+module Griffin
+  module Interceptors
+    class CallStream < GrpcKit::Call
+      include Enumerable
+      extend Forwardable
+      delegate %i[send_msg recv] => :@inner
+
+      # @params call [GrpcKit::Call]
+      def initialize(inner)
+        @inner = inner
+      end
+
+      def each
+        loop { yield(recv) }
+      end
+
+      def method_missing(name, *args, &block)
+        @inner.public_send(name, *args, &block)
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/client/payload_streamer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'griffin/interceptors/call_stream'
+
 module Griffin
   module Interceptors
     module Client
@@ -8,31 +10,23 @@ module Griffin
         # @param logger [Logger]
         # @param base_log [Hash<String,String>]
         def initialize(inner, logger, base_log = {}, filter = nil)
-          @inner = inner
+          super(inner)
           @logger = logger
           @filter = filter
           @base_log = base_log
         end
 
-        def send_msg(msg, **opts)
+        def send_msg(msg)
           @logger.info(@base_log.merge('grpc.request.content' => extract_content(msg)))
-          @inner.send_msg(msg, **opts)
+          super
         end
 
-        def recv(**opt)
-          @inner.recv(**opt).tap do |resp|
+        def recv
+          super.tap do |resp|
             @logger.info(@base_log.merge('grpc.response.content' => extract_content(resp)))
           end
         end
 
-        def close_and_recv
-          @inner.close_and_recv
-        end
-
-        def close_and_send
-          @inner.close_and_send
-        end
-
         private
 
         def extract_content(request)

data/lib/griffin/interceptors/server/newrelic_interceptor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+gem 'newrelic_rpm'
+
+module Griffin
+  module Interceptors
+    module Server
+      class NewRelicInterceptor < GRPC::ServerInterceptor
+        def initialize(ignored_services: [])
+          @ignored_services = ignored_services.map(&:service_name)
+        end
+
+        Request = Struct.new(:path, :user_agent, :request_method)
+
+        def request_response(method: nil, call: nil, **)
+          return yield if NewRelic::Agent.instance.started?
+
+          service_name = call.service_name
+
+          return yield if @ignored_services.include?(service_name)
+
+          transaction_name = build_transaction_name(service_name, method.name)
+          state = NewRelic::Agent::TransactionState.tl_get
+
+          # gRPC's HTTP method is fixed. https://github.com/grpc/grpc/blob/af89e8c00e796f3398b09b7daed693df2b14da56/doc/PROTOCOL-HTTP2.md
+          req = Request.new("/#{transaction_name}", call.metadata['user-agent'], 'POST')
+          # ":controller" is not correct category name for gRPC, But since we want to categorized this transaction as web transactions.
+          # https://docs.newrelic.com/docs/apm/transactions/key-transactions/introduction-key-transactions
+          NewRelic::Agent::Transaction.start(state, :controller, transaction_name: "Controller/#{transaction_name}", request: req)
+
+          begin
+            yield
+            # gRPC alway returns HTTP status code 200
+            state.current_transaction.http_response_code = '200'
+          rescue => e
+            NewRelic::Agent::Transaction.notice_error(e)
+            raise e
+          ensure
+            NewRelic::Agent::Transaction.stop(state)
+          end
+        end
+
+        # For now, we don't support server_streamer, client_streamer and bidi_streamer
+
+        private
+
+        def build_transaction_name(service, mthd)
+          "#{service}/#{mthd}"
+        end
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/server/payload_streamer.rb

@@ -1,26 +1,28 @@
 # frozen_string_literal: true
 
+require 'griffin/interceptors/call_stream'
+
 module Griffin
   module Interceptors
     module Server
-      class PayloadStreamer
+      class PayloadStreamer < Griffin::Interceptors::CallStream
         # @param inner [GrpcKit::Calls::Call]
         # @param logger [Logger]
         # @param base_log [Hash<String,String>]
         def initialize(inner, logger, base_log = {}, filter = nil)
-          @inner = inner
+          super(inner)
           @logger = logger
           @filter = filter
           @base_log = base_log
         end
 
-        def send_msg(msg, **opts)
+        def send_msg(msg)
           @logger.info(@base_log.merge('grpc.response.content' => extract_content(msg)))
-          @inner.send_msg(msg, **opts)
+          super
         end
 
-        def recv(**opt)
-          @inner.recv(**opt).tap do |req|
+        def recv
+          super.tap do |req|
             @logger.info(@base_log.merge('grpc.request.content' => extract_content(req)))
           end
         end

data/lib/griffin/interceptors/server/timeout_interceptor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module Griffin
+  module Interceptors
+    module Server
+      class TimeoutInterceptor < GRPC::ServerInterceptor
+        DEFAULT_TIMEOUT = 5
+
+        def initialize(timeout = DEFAULT_TIMEOUT)
+          @timeout = timeout
+        end
+
+        def request_response(*)
+          Timeout.timeout(@timeout) do
+            yield
+          end
+        end
+
+        # For now, we don't support server_streamer, client_streamer and bidi_streamer
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/version.rb

@@ -1,5 +1,5 @@
 module Griffin
   module Interceptors
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: griffin-interceptors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: griffin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +97,7 @@ files:
 - bin/console
 - bin/setup
 - griffin-interceptors.gemspec
+- lib/griffin/interceptors/call_stream.rb
 - lib/griffin/interceptors/client/filtered_payload_interceptor.rb
 - lib/griffin/interceptors/client/logging_interceptor.rb
 - lib/griffin/interceptors/client/payload_interceptor.rb
@@ -105,10 +106,12 @@ files:
 - lib/griffin/interceptors/server/clear_connection_interceptor.rb
 - lib/griffin/interceptors/server/filtered_payload_interceptor.rb
 - lib/griffin/interceptors/server/logging_interceptor.rb
+- lib/griffin/interceptors/server/newrelic_interceptor.rb
 - lib/griffin/interceptors/server/payload_interceptor.rb
 - lib/griffin/interceptors/server/payload_streamer.rb
 - lib/griffin/interceptors/server/rails_exception_interceptor.rb
 - lib/griffin/interceptors/server/raven_interceptor.rb
+- lib/griffin/interceptors/server/timeout_interceptor.rb
 - lib/griffin/interceptors/server/x_request_id_interceptor.rb
 - lib/griffin/interceptors/version.rb
 homepage: https://github.com/cookpad/griffin-interceptors