griffin-interceptors 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239fb7f3036b63120fdeb63eeb5504848b95a1e89d34708186fec7fb7b492203
-  data.tar.gz: de98b38b9a0ee827b439948cf0179da9ab2f2bcb08b06da2db05de23403a95fa
+  metadata.gz: ffed86abcb2abcde04f6c18a0eca28277125f9828d83c4366d39b3e906fe226d
+  data.tar.gz: a02c68e604410540cf6637f0500b01966c8cf3338fe1d81138a71b3efbe8d8f4
 SHA512:
-  metadata.gz: 5051fa9479be355ae9a5982dfffd6896149c7261e9bea9f75ab8db3d72752eda04546eeeb12fdcb52b672bc7a60b7420806c1e782482dfa57b426b818bfee014
-  data.tar.gz: f6eec90328bd4aa6e7617a9b2bacdbcf7512565d3b97186ef39ff98a49fb74719c84c94270c8170959c9ea5402993434593ffb88c83cbc3dd0c1e8ab27732ac0
+  metadata.gz: 6d200ccd31a654190d80adf6f5549bc70cf817e5e20859e10c9eca395148a7b85bfbfb2288d2aaf5d485a5865f9a0602c903676d400c32e6009e79dfca7bc31f
+  data.tar.gz: '091fd8f580cea51fe2f8f85c4f18bf913f2c9b85f63fbf17247433223d48b21a82085917b6596dba2347775b8a05b0194fa188ca5fb437a2c514c2a2e00a808a'

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-gem 'sentry-raven'
-
 module Griffin
   module Interceptors
     module Server
@@ -10,13 +8,13 @@ module Griffin
           begin
             yield
           rescue ActiveRecord::RecordNotFound => e
-            Raven.capture_exception(e)
+            capture_exception_if_defined(e)
             raise GRPC::NotFound.new(e.message)
           rescue ActiveRecord::StaleObjectError => e
-            Raven.capture_exception(e)
+            capture_exception_if_defined(e)
             raise GRPC::Aborted.new(e.message)
           rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotSaved => e
-            Raven.capture_exception(e)
+            capture_exception_if_defined(e)
             raise GRPC::FailedPrecondition.new(e.message)
           end
         end
@@ -24,6 +22,16 @@ module Griffin
         alias_method :server_streamer, :request_response
         alias_method :client_streamer, :request_response
         alias_method :bidi_streamer, :request_response
+
+        private
+
+        def capture_exception_if_defined(e)
+          if defined?(Sentry)
+            Sentry.capture_exception(e)
+          elsif defined?(Raven)
+            Raven.capture_exception(e)
+          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

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/server/sentry_interceptor.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+gem "sentry-ruby"
+
+module Griffin
+  module Interceptors
+    module Server
+      class SentryInterceptor < GRPC::ServerInterceptor
+        TRANSACTION_OP = "griffin"
+
+        def request_response(request: nil, call: nil, method: nil)
+          return yield unless Sentry.initialized?
+
+          Sentry.clone_hub_to_current_thread
+
+          Sentry.with_scope do |scope|
+            Sentry.with_session_tracking do
+              scope.clear_breadcrumbs
+
+              service_name = call.service_name
+              method_name = method.name
+              scope.set_transaction_name("#{service_name}/#{method_name}")
+
+              transaction = start_transaction(call.metadata, scope)
+              scope.set_span(transaction) if transaction
+
+              if call.metadata["x-request-id"]
+                scope.set_tags(request_id: call.metadata["x-request-id"])
+              end
+
+              begin
+                response = yield
+              rescue GRPC::BadStatus => e
+                finish_transaction(transaction, e.code)
+                raise e
+              rescue => e
+                GRPC.logger.error("Internal server error: #{e}")
+                finish_transaction(transaction, GrpcKit::StatusCodes::INTERNAL)
+                Sentry.capture_exception(e)
+
+                raise GRPC::Unknown.new("Internal server error")
+              end
+
+              finish_transaction(transaction, GrpcKit::StatusCodes::OK)
+
+              response
+            end
+          end
+        end
+
+        alias_method :server_streamer, :request_response
+        alias_method :client_streamer, :request_response
+        alias_method :bidi_streamer, :request_response
+
+        private
+
+        def start_transaction(metadata, scope)
+          sentry_trace = metadata["grpc-sentry-trace"]
+          options = { name: scope.transaction_name, op: TRANSACTION_OP }
+          transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+          Sentry.start_transaction(transaction: transaction, custom_sampling_context: { metadata: metadata }, **options)
+        end
+
+        def finish_transaction(transaction, status_code)
+          return unless transaction
+
+          transaction.set_http_status(status_code)
+          transaction.finish
+        end
+      end
+    end
+  end
+end

data/lib/griffin/interceptors/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: griffin-interceptors
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -125,6 +125,8 @@ 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/sentry_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
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A collection of interceptors for griffin