griffin-interceptors 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58f96feed784d22af88a27a642d4da316988f244
-  data.tar.gz: ae39cc0f1be3aace6ed5bd701535064abb5f16ee
+SHA256:
+  metadata.gz: b785b3cafb37b0e0591d0711e53b26234f42e5fa030e97b1abcd0aeea1cdb7ea
+  data.tar.gz: 1088309028a6cc0b5ef0c9eda8d90959877104f7363bec69bc1edc74c99edee4
 SHA512:
-  metadata.gz: df533bab1821031978249296e6b5468860fcd9475235a7332e234dab7b686589daa446abd15274069b010173852a1f725f2b4cc116077bf7fa5baf7d843675c2
-  data.tar.gz: 6ca9a228c84ef463d4540f5d1e86e36f2b0d8c1c8df7c1a22b494500dfd12155f9e5da9d56d24087ad66a4b93596b1c0aad9a8339f652812686527f2eebd2308
+  metadata.gz: 185036907e1423ecbfb463ada4759865c59012e3c3fb927821f148a7cec6f5610a0398c8807e8bb44f2777ff9663a7ecdfe6bb87eef5e116c9986df9dca9e4f7
+  data.tar.gz: a5924cd5e8b47d68fb2ca35c0ec9274b983a7e872699921092d0e6f5546048fc583ca149f61c79bbdbfe4a8f080947baac5dbf4f5ddd9e6af8d37432fb2ed5ba

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/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

@@ -6,7 +6,11 @@ module Griffin
   module Interceptors
     module Server
       class RavenInterceptor < GRPC::ServerInterceptor
-        def request_response(*)
+        def request_response(call: nil, **)
+          if call.metadata['x-request-id']
+            Raven.tags_context(request_id: call.metadata['x-request-id'])
+          end
+
           begin
             yield
           rescue => e
@@ -17,6 +21,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/scout_apm_interceptor.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+gem 'scout_apm'
+
+require 'scout_apm/layer'
+require 'scout_apm/request_manager'
+
+module Griffin
+  module Interceptors
+    module Server
+      class ScoutApmInterceptor < GRPC::ServerInterceptor
+        # Specify the controller layer so that the transaction gets categorized as a web transaction.
+        LAYER_TYPE = 'Controller'
+
+        def initialize(ignored_services: [], sampling_rate: 1.0)
+          @ignored_services = ignored_services.map(&:service_name)
+          @sampling_rate = sampling_rate.to_f
+        end
+
+        def request_response(request: nil, call: nil, method: nil)
+          service_name = call.service_name
+          method_name = method.name
+
+          return yield if rand > @sampling_rate || @ignored_services.include?(service_name)
+
+          layer = ScoutApm::Layer.new(LAYER_TYPE, "#{service_name}/#{method_name}")
+
+          req = ScoutApm::RequestManager.lookup
+          req.start_layer(layer)
+          req.annotate_request(uri: "/#{service_name}/#{method_name}")
+
+          ScoutApm::Context.add(
+            request_id: call.metadata['x-request-id'],
+            user_agent: call.metadata['user-agent'],
+          )
+
+          begin
+            yield
+          rescue => e
+            req.error!
+            raise e
+          ensure
+            req.stop_layer
+          end
+        end
+
+        # For now, we don't support server_streamer, client_streamer and bidi_streamer
+        # alias_method :server_streamer, :request_response
+        # alias_method :client_streamer, :request_response
+        # alias_method :bidi_streamer, :request_response
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/version.rb

@@ -1,5 +1,5 @@
 module Griffin
   module Interceptors
-    VERSION = '0.1.6'.freeze
+    VERSION = '0.1.11'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: griffin-interceptors
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.11
 platform: ruby
 authors:
 - Yuta Iwama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -125,6 +125,7 @@ files:
 - 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/scout_apm_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
@@ -133,7 +134,7 @@ homepage: https://github.com/cookpad/griffin-interceptors
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +149,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.0.3
+signing_key:
 specification_version: 4
 summary: A collection of interceptors for griffin
 test_files: []