griffin-interceptors 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe0fd2e86343914ca2f2f4a6716c415a2ac24936
-  data.tar.gz: 4932bb8474d59d681889c86a607eb1f1c76c1758
+SHA256:
+  metadata.gz: 239fb7f3036b63120fdeb63eeb5504848b95a1e89d34708186fec7fb7b492203
+  data.tar.gz: de98b38b9a0ee827b439948cf0179da9ab2f2bcb08b06da2db05de23403a95fa
 SHA512:
-  metadata.gz: 1f2da5faf64741eaf1455fc209443fb5c2a99310fb39a23d27f949024d74b005692e027262d5b3a69d0b56be57b5f66350113b4810a899881a6697388bb0fb44
-  data.tar.gz: 3a726be452970dffe6a7b0bb9117069352ae4d4a5e3d5a1442669a492518855fd28f04f729b63d4da46a4afa7de4c0796f108be59a1b6f96dca1048f23b49389
+  metadata.gz: 5051fa9479be355ae9a5982dfffd6896149c7261e9bea9f75ab8db3d72752eda04546eeeb12fdcb52b672bc7a60b7420806c1e782482dfa57b426b818bfee014
+  data.tar.gz: f6eec90328bd4aa6e7617a9b2bacdbcf7512565d3b97186ef39ff98a49fb74719c84c94270c8170959c9ea5402993434593ffb88c83cbc3dd0c1e8ab27732ac0

data/griffin-interceptors.gemspec

@@ -20,7 +20,8 @@ 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.5'
+  spec.add_dependency 'get_process_mem', '~> 0.2.3'
+  spec.add_dependency 'griffin', '>= 0.2.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

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

@@ -2,8 +2,8 @@
 
 require 'griffin/interceptors/server/payload_interceptor'
 
-# Check actionpack exists to use ActionDispatch::Http::ParameterFilter
-gem 'actionpack'
+# Check actionpack exists to use ActionDispatch::Http::ParameterFilter if needed
+gem 'actionpack' unless defined?(ActiveSupport::ParameterFilter)
 
 module Griffin
   module Interceptors
@@ -19,7 +19,13 @@ module Griffin
             end
           end
 
-          @parameter_filter = ActionDispatch::Http::ParameterFilter.new(@filters)
+          # ActionDispatch::Http::ParameterFilter is deprecated and will be removed from Rails 6.1.
+          parameter_filter_klass = if defined?(ActiveSupport::ParameterFilter)
+              ActiveSupport::ParameterFilter
+            else
+              ActionDispatch::Http::ParameterFilter
+            end
+          @parameter_filter = parameter_filter_klass.new(@filters)
         end
 
         def server_streamer(call: nil, **)

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

@@ -45,7 +45,7 @@ module Griffin
             'grpc.code' => '0', # OK
           }
 
-          if call.metadata['x-requst-id']
+          if call.metadata['x-request-id']
             log['grpc.x_request_id'] = call.metadata['x-request-id']
           end
 

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

@@ -19,26 +19,14 @@ module Griffin
 
           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
-            resp = yield
-            # gRPC alway returns HTTP status code 200
-            state.current_transaction.http_response_code = '200'
-
-            resp
-          rescue => e
-            NewRelic::Agent::Transaction.notice_error(e)
-            raise e
-          ensure
-            NewRelic::Agent::Transaction.stop(state)
+          request = Request.new("/#{service_name}/#{method.name}", call.metadata['user-agent'], 'POST')
+
+          in_transaction("#{service_name}/#{method.name}", request) do |txn|
+            yield.tap do
+              # gRPC always returns HTTP status code 200.
+              txn.http_response_code = '200'
+            end
           end
         end
 
@@ -46,8 +34,21 @@ module Griffin
 
         private
 
-        def build_transaction_name(service, mthd)
-          "#{service}/#{mthd}"
+        if Gem::Version.new(NewRelic::VERSION::STRING) >= Gem::Version.new('6.0.0')
+          def in_transaction(partial_name, request)
+            NewRelic::Agent::Tracer.in_transaction(partial_name: partial_name, category: :web, options: { request: request }) do
+              yield NewRelic::Agent::Tracer.current_transaction
+            end
+          end
+        else
+          def in_transaction(partial_name, request)
+            state = NewRelic::Agent::TransactionState.tl_get
+            # Specify the controller category so that the transaction gets categorized as a web transaction.
+            # See https://github.com/newrelic/newrelic-ruby-agent/blob/5.7.0.350/lib/new_relic/agent/transaction.rb#L39.
+            NewRelic::Agent::Transaction.wrap(state, "Controller/#{partial_name}", :controller, request: request) do
+              yield state.current_transaction
+            end
+          end
         end
       end
     end

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

@@ -17,6 +17,9 @@ module Griffin
 
             raise GRPC::Unknown.new('Internal server error')
           end
+        ensure
+          Raven::Context.clear!
+          Raven::BreadcrumbBuffer.clear!
         end
 
         alias_method :server_streamer, :request_response

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'get_process_mem'
+
+module Griffin
+  module Interceptors
+    module Server
+      class WorkerKillerInterceptor < GRPC::ServerInterceptor
+        def initialize(memory_limit_min: 1024**3, memory_limit_max: 2 * (1024**3), check_cycle: 16)
+          @worker_memory_limit_max = memory_limit_max
+          @worker_memory_limit_min = memory_limit_min
+          @worker_check_cycle = check_cycle
+          @worker_memory_limit = @worker_memory_limit_min + rand(@worker_memory_limit_max - @worker_memory_limit_min + 1)
+          @worker_check_count = 0
+          @sent_signals = false
+        end
+
+        def request_response(*)
+          yield.tap do
+            break if @sent_signals
+
+            @worker_process_start ||= Time.now
+            @worker_check_count += 1
+
+            if (@worker_check_count % @worker_check_cycle) == 0
+              rss = GetProcessMem.new.bytes
+              if rss > @worker_memory_limit
+                Griffin.logger.warn("Worker (pid: #{Process.pid}) exceeds memory limit (#{rss.to_i} bytes > #{@worker_memory_limit} bytes)")
+                send_restart_signal(@worker_process_start)
+              end
+
+              @worker_check_count = 0
+            end
+          end
+        end
+
+        alias_method :server_streamer, :request_response
+        alias_method :client_streamer, :request_response
+        alias_method :bidi_streamer, :request_response
+
+        private
+
+        def send_restart_signal(start_time)
+          # No need to get a lock, sending signals duplicately is acceptable
+          @sent_signals = true
+          pid = Process.pid
+          alive_sec = (Time.now - start_time).round
+
+          Griffin.logger.info("Send signal(USR1) pid: #{pid}, alive_sec: #{alive_sec}")
+          Process.kill :USR1, pid
+        end
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/version.rb

@@ -1,5 +1,5 @@
 module Griffin
   module Interceptors
-    VERSION = '0.1.4'.freeze
+    VERSION = '0.1.9'.freeze
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: griffin-interceptors
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Yuta Iwama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: griffin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.5
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,13 +126,14 @@ files:
 - 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/worker_killer_interceptor.rb
 - lib/griffin/interceptors/server/x_request_id_interceptor.rb
 - lib/griffin/interceptors/version.rb
 homepage: https://github.com/cookpad/griffin-interceptors
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A collection of interceptors for griffin
 test_files: []