grpc_interceptors 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5788b629b92902268c009af0d015ce195ea82ef6841f2adc75be44a80841acf
-  data.tar.gz: 175875a825b39b6bbf21256c0a97310ffa83feff87a9c9e9ff6ad4a6ebbc83f5
+  metadata.gz: 3d25e64c56db11d1b34fd966a59da4ad97ca2883fdbb68f2e046731a0f46f538
+  data.tar.gz: 282ee4ba2bf4dafe62c5896697106c48e26e8d739ff62dc3f603bddbeba37049
 SHA512:
-  metadata.gz: b1b68eeb8f1d1bd06e99153c160caea6353043fc14e2c3c61268246f7fe32bd87755ff0d509d4748c85128f04349e1ca61550fcef3f640b645672afe81c7bd84
-  data.tar.gz: ca9653d07430adaecbe7ca6ed07e629703275435a0d0f067240ff93a13c3b5a61e80b704305f60365db70b3977f5d7b8f37bafd2529f8942d43c9899ae3e9a65
+  metadata.gz: c28c9eb7f8e08408a243ed15c400203165466c1c128f7552c97c12b87c996790c6a9c99751d011cb2cb317bdc9a62153f81fd86abbfba7601745a0ba8ab95878
+  data.tar.gz: 33279a6a49e2414e50e70a621fd5a1584ce87c06de408395e05f9442c5b4d4100a45e86aa589feee9083afffb1415b1d4979a94b218b45318f50c0be7ae2749f

data/README.md

@@ -29,7 +29,11 @@ _WIP_
 
 ### Logging
 
-When the `LOG_LEVEL` env variable is set to `INFO` then the server logs out
+When the `LOG_LEVEL` env variable is set to `INFO` then the server logs out.
+
+When the `LOG_LEVEL` env variable is set to `DEBUG` then the server additionally adds the request to the log message. (Note, adding the response is currently blocked by [this gRPC issue](https://github.com/grpc/grpc/pull/26547).)
+
+
 
 ### StatsD metrics
 

data/lib/grpc_interceptors/client/logging.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative '../common/grpc_helper'
+require_relative '../common/log_payload'
+
+module GrpcInterceptors
+  module Client
+    class Logging < ::GRPC::ServerInterceptor
+      def initialize(logger)
+        @logger = logger
+
+        super()
+      end
+
+      def request_response(
+        request: nil, call: nil, method: nil, metadata: nil, &block
+      )
+        log(request, method, 'unary', &block)
+      end
+
+      # def client_streamer(_requests: nil, call: nil, method: nil, metadata: nil)
+      #  yield
+      # end
+
+      # def server_streamer(_request: nil, call: nil, method: nil, metadata: nil)
+      #  yield
+      # end
+
+      # def bidi_streamer(_requests: nil, call: nil, method: nil, metadata: nil)
+      #  yield
+      # end
+
+      private
+
+      # if the server responds with error, then the error is attached to the log
+      # if the current level is INFO, then it logs out basic facts
+      # if the current level is DEBUG, then it additionally includes the request
+      def log(request, method, method_type)
+        grpc_code = ::GRPC::Core::StatusCodes::OK
+
+        response = yield
+      rescue StandardError => e
+        grpc_code = e.is_a?(::GRPC::BadStatus) ? e.code : ::GRPC::Core::StatusCodes::UNKNOWN
+
+        raise
+      ensure
+        payload = Common::LogPayload.build(
+          method, method_type, grpc_code, 'client'
+        )
+
+        if e
+          payload['error'] = e.class.to_s
+          payload['error_message'] = e.message
+          payload['backtrace'] = e.backtrace
+        end
+
+        if @logger.level == Logger::Severity::INFO
+          @logger.info(payload)
+        elsif @logger.level == Logger::Severity::DEBUG
+          payload['request'] = request.to_h
+          payload['response'] = response.to_h
+          @logger.debug(payload)
+        end
+      end
+    end
+  end
+end

data/lib/grpc_interceptors/client/{open_telemetry_tracing_instrument.rb → opentelemetry_tracing_instrument.rb}

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 require_relative '../common/grpc_helper'
+require_relative '../common/opentelemetry_helper'
 
 module GrpcInterceptors
   module Client
     class OpenTelemetryTracingInstrument < ::GRPC::ClientInterceptor
       def request_response(request: nil, call: nil, method: nil, metadata: nil)
         kind = OpenTelemetry::Trace::SpanKind::CLIENT
-        attributes = tracing_attributes(method)
+        attributes = Common::OpenTelemetryHelper.tracing_attributes(method)
 
-        GrpcHelper.tracer.in_span(method, kind: kind, attributes: attributes) do
+        Common::OpenTelemetryHelper.tracer.in_span(
+          method, kind: kind, attributes: attributes
+        ) do
           OpenTelemetry.propagation.inject(metadata)
           yield
         end
@@ -26,20 +29,6 @@ module GrpcInterceptors
       # def bidi_streamer(_requests: nil, call: nil, method: nil, metadata: nil)
       # yield
       # end
-
-      private
-
-      def tracing_attributes(method)
-        method_parts = method.to_s.sub(%r{^/}, '').split('/')
-        service_name = method_parts.shift
-        method_name = method_parts.join('/')
-
-        {
-          OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'grpc',
-          OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service_name,
-          OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => method_name,
-        }
-      end
     end
   end
 end

data/lib/grpc_interceptors/common/grpc_helper.rb

@@ -1,13 +1,47 @@
 # frozen_string_literal: true
 
 module GrpcInterceptors
-  module GrpcHelper
-    def self.route_name(method)
-      "/#{method.owner.service_name}/#{method.original_name}"
-    end
+  module Common
+    module GrpcHelper
+      def self.route_name(method)
+        return method unless method.is_a?(Method) # client case
+
+        # server case
+        service_name = service_name_from_server(method)
+        method_name = method_name_from_server(method)
+
+        "/#{service_name}/#{method_name}"
+      end
+
+      def self.service_name(method)
+        return service_name_from_server(method) if method.is_a?(Method) # server case
+
+        service_name_from_client(method) # client case
+      end
+
+      def self.method_name(method)
+        return method_name_from_server(method) if method.is_a?(Method) # server case
+
+        method_name_from_client(method) # client case
+      end
+
+      def self.service_name_from_server(method)
+        method.owner.service_name.to_s
+      end
+
+      def self.method_name_from_server(method)
+        method.original_name.to_s
+      end
+
+      def self.service_name_from_client(method)
+        method_parts = method.to_s.sub(%r{^/}, '').split('/')
+        method_parts.first
+      end
 
-    def self.tracer
-      OpenTelemetry.tracer_provider.tracer('grpc')
+      def self.method_name_from_client(method)
+        method_parts = method.to_s.sub(%r{^/}, '').split('/')
+        method_parts[1..].join('/')
+      end
     end
   end
 end

data/lib/grpc_interceptors/common/log_payload.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GrpcInterceptors
+  module Common
+    module LogPayload
+      def self.build(method, method_type, grpc_code, kind)
+        service = GrpcHelper.service_name(method)
+        method = GrpcHelper.method_name(method)
+
+        payload = {
+          'pid' => Process.pid,
+          'grpc.component' => kind, # the caller, server or client
+          'grpc.service' => service,
+          'grpc.method' => method,
+          'grpc.method_type' => method_type,
+          'grpc.code' => grpc_code
+        }
+
+        if defined?(OpenTelemetry) && OpenTelemetry::Trace.current_span.recording?
+          tracing_context = OpenTelemetry::Trace.current_span.context
+          payload['span_id'] = tracing_context.hex_span_id
+          payload['trace_id'] = tracing_context.hex_trace_id
+        end
+
+        payload
+      end
+    end
+  end
+end

data/lib/grpc_interceptors/common/opentelemetry_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GrpcInterceptors
+  module Common
+    module OpenTelemetryHelper
+      def self.tracer
+        OpenTelemetry.tracer_provider.tracer('grpc')
+      end
+
+      def self.tracing_attributes(method)
+        service_name = Common::GrpcHelper.service_name(method)
+        method_name = Common::GrpcHelper.method_name(method)
+
+        {
+          OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'grpc',
+          OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service_name,
+          OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => method_name
+        }
+      end
+    end
+  end
+end

data/lib/grpc_interceptors/server/logging.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../common/grpc_helper'
+require_relative '../common/log_payload'
+
+module GrpcInterceptors
+  module Server
+    class Logging < ::GRPC::ServerInterceptor
+      def initialize(logger)
+        @logger = logger
+
+        super()
+      end
+
+      def request_response(request: nil, call: nil, method: nil, &block)
+        log(request, method, 'unary', &block)
+      end
+
+      # def client_streamer(call: nil, method: nil)
+      #  yield
+      # end
+
+      # def server_streamer(_request: nil, call: nil, method: nil)
+      #  yield
+      # end
+
+      # def bidi_streamer(_requests: nil, call: nil, method: nil)
+      #  yield
+      # end
+
+      private
+
+      # in case of an exception, it logs out on the ERROR level including error details
+      # if the current level is INFO, then it logs out basic facts
+      # if the current level is DEBUG, then it additionally includes the request
+      def log(request, method, method_type)
+        grpc_code = ::GRPC::Core::StatusCodes::OK
+
+        yield
+      rescue StandardError => e
+        grpc_code = e.is_a?(::GRPC::BadStatus) ? e.code : ::GRPC::Core::StatusCodes::UNKNOWN
+
+        raise
+      ensure
+        payload = Common::LogPayload.build(
+          method, method_type, grpc_code, 'server'
+        )
+
+        if e
+          payload['error'] = e.class.to_s
+          payload['error_message'] = e.message
+          payload['backtrace'] = e.backtrace
+          @logger.error(payload)
+        elsif @logger.level == Logger::Severity::INFO
+          @logger.info(payload)
+        elsif @logger.level == Logger::Severity::DEBUG
+          payload['request'] = request.to_h
+          @logger.debug(payload)
+        end
+      end
+    end
+  end
+end

data/lib/grpc_interceptors/server/opentelemetry_tracing_instrument.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../common/grpc_helper'
+require_relative '../common/opentelemetry_helper'
+
+module GrpcInterceptors
+  module Server
+    # https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/generic/interceptors.rb
+    class OpenTelemetryTracingInstrument < ::GRPC::ServerInterceptor
+      def request_response(request: nil, call: nil, method: nil, &block)
+        context = OpenTelemetry.propagation.extract(call.metadata)
+        route_name = Common::GrpcHelper.route_name(method)
+        attributes = Common::OpenTelemetryHelper.tracing_attributes(method)
+        kind = OpenTelemetry::Trace::SpanKind::SERVER
+
+        OpenTelemetry::Context.with_current(context) do
+          Common::OpenTelemetryHelper.tracer.in_span(
+            route_name,
+            attributes: attributes,
+            kind: kind,
+            &block
+          )
+        end
+      end
+
+      # def client_streamer(call: nil, method: nil)
+      #  yield
+      # end
+
+      # def server_streamer(_request: nil, call: nil, method: nil)
+      #  yield
+      # end
+
+      # def bidi_streamer(_requests: nil, call: nil, method: nil)
+      #  yield
+      # end
+    end
+  end
+end

data/lib/grpc_interceptors/server/statsd_metrics.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../common/grpc_helper'
+
 module GrpcInterceptors
   module Server
     class StatsDMetrics < ::GRPC::ServerInterceptor
@@ -32,8 +34,8 @@ module GrpcInterceptors
 
       def common_labels(method)
         {
-          grpc_method: method.original_name.to_s,
-          grpc_service: method.owner.service_name
+          grpc_method: Common::GrpcHelper.method_name(method),
+          grpc_service: Common::GrpcHelper.service_name(method)
         }
       end
     end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grpc_interceptors
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - michal-kazmierczak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-instrumentation-base
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.3
-- !ruby/object:Gem::Dependency
-  name: statsd-instrument
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: A collection of Ruby interceptors (middlewares) for gRPC servers and
   clients.
 email:
@@ -272,10 +244,13 @@ files:
 - LICENSE
 - README.md
 - lib/grpc_interceptors.rb
-- lib/grpc_interceptors/client/open_telemetry_tracing_instrument.rb
+- lib/grpc_interceptors/client/logging.rb
+- lib/grpc_interceptors/client/opentelemetry_tracing_instrument.rb
 - lib/grpc_interceptors/common/grpc_helper.rb
-- lib/grpc_interceptors/common/logger.rb
-- lib/grpc_interceptors/server/open_telemetry_tracing_instrument.rb
+- lib/grpc_interceptors/common/log_payload.rb
+- lib/grpc_interceptors/common/opentelemetry_helper.rb
+- lib/grpc_interceptors/server/logging.rb
+- lib/grpc_interceptors/server/opentelemetry_tracing_instrument.rb
 - lib/grpc_interceptors/server/statsd_metrics.rb
 homepage: https://github.com/michal-kazmierczak/ruby-grpc-interceptors
 licenses:

data/lib/grpc_interceptors/common/logger.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module GrpcInterceptors
-  module Common
-    class Logger
-      # extend self
-
-      def log; end
-    end
-  end
-end

data/lib/grpc_interceptors/server/open_telemetry_tracing_instrument.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../common/grpc_helper'
-
-module GrpcInterceptors
-  module Server
-    # https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/generic/interceptors.rb
-    class OpenTelemetryTracingInstrument < ::GRPC::ServerInterceptor
-      def request_response(request: nil, call: nil, method: nil)
-        parent_context = OpenTelemetry.propagation.extract(call.metadata)
-        route_name = GrpcHelper.route_name(method)
-        attributes = tracing_attributes(method)
-        kind = OpenTelemetry::Trace::SpanKind::SERVER
-        span = GrpcHelper.tracer.start_span(
-          route_name,
-          with_parent: parent_context,
-          attributes: attributes,
-          kind: kind
-        )
-
-        yield
-
-        span.finish
-      rescue StandardError => e
-        OpenTelemetry.handle_error(exception: e)
-
-        raise e
-      ensure
-        span.finish if span.recording?
-      end
-
-      # def client_streamer(call: nil, method: nil)
-      #  yield
-      # end
-
-      # def server_streamer(_request: nil, call: nil, method: nil)
-      #  yield
-      # end
-
-      # def bidi_streamer(_requests: nil, call: nil, method: nil)
-      #  yield
-      # end
-
-      private
-
-      def tracing_attributes(method)
-        {
-          OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'grpc',
-          OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => method.owner.service_name,
-          OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => method.original_name.to_s,
-        }
-      end
-    end
-  end
-end