grpc_interceptors 0.2.0 → 0.2.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51b232898a2b8b008b4de2d02600c7fe1e49498d9928788ff7f8a57c91cdee2
-  data.tar.gz: 302ffaeb0c448bd5e1c660bb614239bcd94dccf8df387228c739f5093b041290
+  metadata.gz: 7d3e0f698d59a4a8427356e2581d63cc0d1caa54581e58ee48d3614f0a3c1b21
+  data.tar.gz: 457f47fb4eb8a2c2918dac9cade910849b1de2a1a77ab398ee293ac91c4c03f8
 SHA512:
-  metadata.gz: 9c0fa8bb0b5abc00291d101ddc4f8e77a2652d955c9c838151d0ae6ab94d8458af00100f64fc54da5247b75c037f07b54e59477fae2c5bae4782dc872dc353ed
-  data.tar.gz: 9934985ab2c5e87607b4f2caa32683e0e4f143a9d8666a37a3f0367e99383e03c6c66869f0a2e7998093689bc45f65c722173fc6d87ff124a41845ef38dc71ee
+  metadata.gz: f04eb0f20362428f5b20b52fffd2b384520667096f891963b11c11154dad8a6c2e9516bc2014586187ddfdb205b7a97a92132f6f0cea62e4b37a09e758cc97c0
+  data.tar.gz: e9ee7ed6d174803126f2bd7c10c4aa98e4e3a55d9d055f821158a424e6006a71706c49d53abe8cb83919af8b9938bf005e28498e9d51a6ee7bcb7fedf85c85be

data/README.md

@@ -33,8 +33,6 @@ 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
 
 ```ruby
@@ -47,11 +45,12 @@ GRPC::RpcServer.new(
 
 The server emits a histogram metric called `grpc_latency_seconds` with the following tags:
 
- - `grpc_method` representing the called method
- - `grpc_service` representing the service
- - `grpc_type` representing the gRPC kind of method
+- `grpc_method` representing the called method
+- `grpc_service` representing the service
+- `grpc_type` representing the gRPC kind of method
 
 #### [Experimental] A gauge metric of the server jobs queue
+
 ```
 # https://github.com/grpc/grpc/blob/v1.62.0/src/ruby/lib/grpc/generic/rpc_server.rb#L43C9-L43C21
 server.instance_variable_get(:@pool).jobs_waiting
@@ -62,7 +61,7 @@ server.instance_variable_get(:@pool).jobs_waiting
 ```ruby
 GRPC::RpcServer.new(
   interceptors: [
-    GrpcInterceptors::Server::OpenTelemetryTracingInstrument.new
+    GrpcInterceptors::Server::OpenTelemetryTracingInterceptor.new
   ]
 )
 ```
@@ -76,7 +75,7 @@ GRPC::RpcServer.new(
 ```ruby
 GRPC::RpcServer.new(
   interceptors: [
-    GrpcInterceptors::Client::OpenTelemetryTracingInstrument.new
+    GrpcInterceptors::Client::OpenTelemetryTracingInterceptor.new
   ]
 )
 ```

data/lib/grpc_interceptors/client/logging_interceptor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../client'
+require_relative '../kind'
 require_relative '../common/grpc_helper'
 require_relative '../common/logging'
 
@@ -18,7 +18,7 @@ module GrpcInterceptors
       )
         Common::Logging.yield_and_log(
           logger: @logger, request: request, method: method,
-          method_type: 'unary', kind: GrpcInterceptors::Client::KIND, &block
+          method_type: 'unary', kind: GrpcInterceptors::Kind::CLIENT, &block
         )
       end
 
@@ -37,7 +37,7 @@ module GrpcInterceptors
       )
         Common::Logging.yield_and_log(
           logger: @logger, request: request, method: method,
-          method_type: 'server_stream', kind: GrpcInterceptors::Client::KIND, &block
+          method_type: 'server_stream', kind: GrpcInterceptors::Kind::CLIENT, &block
         )
       end
 

data/lib/grpc_interceptors/client/opentelemetry_tracing_interceptor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../client'
+require_relative '../kind'
 require_relative '../common/grpc_helper'
 require_relative '../common/opentelemetry_helper'
 
@@ -11,7 +11,7 @@ module GrpcInterceptors
         attributes = Common::OpenTelemetryHelper.tracing_attributes(method)
 
         Common::OpenTelemetryHelper.tracer.in_span(
-          method, kind: GrpcInterceptors::Client::KIND, attributes: attributes
+          method, kind: GrpcInterceptors::Kind::CLIENT, attributes: attributes
         ) do
           OpenTelemetry.propagation.inject(metadata)
           yield
@@ -26,7 +26,7 @@ module GrpcInterceptors
         attributes = Common::OpenTelemetryHelper.tracing_attributes(method)
 
         Common::OpenTelemetryHelper.tracer.in_span(
-          method, kind: GrpcInterceptors::Client::KIND, attributes: attributes
+          method, kind: GrpcInterceptors::Kind::CLIENT, attributes: attributes
         ) do
           OpenTelemetry.propagation.inject(metadata)
           yield

data/lib/grpc_interceptors/common/logging.rb

@@ -1,8 +1,33 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module GrpcInterceptors
   module Common
     module Logging
+      SYMBOL_TO_SEVERITY = {
+        trace: ::Logger::Severity::DEBUG,
+        debug: ::Logger::Severity::DEBUG,
+        info: ::Logger::Severity::INFO,
+        warn: ::Logger::Severity::WARN,
+        error: ::Logger::Severity::ERROR,
+        fatal: ::Logger::Severity::FATAL
+      }.freeze
+
+      # Some logger implementations (e.g. SemanticLogger-backed CasinoLogger)
+      # expose #level as a Symbol rather than the ::Logger::Severity Integer
+      # constants this module compares against. Normalize here so any logger
+      # duck-typed with #level/#info/#debug works without a per-service wrapper.
+      def self.normalized_level(logger)
+        raw = logger.respond_to?(:level) ? logger.level : ::Logger::Severity::INFO
+
+        case raw
+        when Integer then raw
+        when Symbol then SYMBOL_TO_SEVERITY.fetch(raw, ::Logger::Severity::INFO)
+        else ::Logger::Severity::INFO
+        end
+      end
+
       def self.yield_and_log(
         logger: nil, request: nil, method: nil, method_type: nil, kind: nil
       )
@@ -21,7 +46,7 @@ module GrpcInterceptors
         extra_fields ||= {}
         extra_fields['grpc.code'] = grpc_code
 
-        if logger.level == ::Logger::Severity::DEBUG && !response.nil? && !response.is_a?(Enumerator)
+        if normalized_level(logger) == ::Logger::Severity::DEBUG && !response.nil? && !response.is_a?(Enumerator)
           extra_fields['response'] = Common::GrpcHelper.proto_to_h(response)
         end
 
@@ -49,9 +74,10 @@ module GrpcInterceptors
         payload = build_payload(method, method_type, kind)
         payload.merge!(extra_fields)
 
-        if logger.level == ::Logger::Severity::INFO
+        level = normalized_level(logger)
+        if level == ::Logger::Severity::INFO
           logger.info(payload)
-        elsif logger.level == ::Logger::Severity::DEBUG
+        elsif level == ::Logger::Severity::DEBUG
           payload['request'] = Common::GrpcHelper.proto_to_h(request) unless request.nil?
           logger.debug(payload)
         end

data/lib/grpc_interceptors/{client.rb → kind.rb}

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module GrpcInterceptors
-  module Client
-    KIND = :client
+  module Kind
+    CLIENT = :client
+    SERVER = :server
   end
 end

data/lib/grpc_interceptors/server/logging_interceptor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../client'
+require_relative '../kind'
 require_relative '../common/grpc_helper'
 require_relative '../common/logging'
 
@@ -16,7 +16,7 @@ module GrpcInterceptors
       def request_response(request: nil, call: nil, method: nil, &block)
         Common::Logging.yield_and_log(
           logger: @logger, request: request, method: method,
-          method_type: 'unary', kind: GrpcInterceptors::Server::KIND, &block
+          method_type: 'unary', kind: GrpcInterceptors::Kind::SERVER, &block
         )
       end
 

data/lib/grpc_interceptors/server/opentelemetry_tracing_interceptor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../client'
+require_relative '../kind'
 require_relative '../common/grpc_helper'
 require_relative '../common/opentelemetry_helper'
 
@@ -17,7 +17,7 @@ module GrpcInterceptors
           Common::OpenTelemetryHelper.tracer.in_span(
             route_name,
             attributes: attributes,
-            kind: GrpcInterceptors::Server::KIND,
+            kind: GrpcInterceptors::Kind::SERVER,
             &block
           )
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grpc_interceptors
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2.rc1
 platform: ruby
 authors:
 - michal-kazmierczak
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -257,14 +271,13 @@ files:
 - LICENSE
 - README.md
 - lib/grpc_interceptors.rb
-- lib/grpc_interceptors/client.rb
 - lib/grpc_interceptors/client/logging_interceptor.rb
 - lib/grpc_interceptors/client/opentelemetry_tracing_interceptor.rb
 - lib/grpc_interceptors/common/grpc_helper.rb
 - lib/grpc_interceptors/common/log_payload.rb
 - lib/grpc_interceptors/common/logging.rb
 - lib/grpc_interceptors/common/opentelemetry_helper.rb
-- lib/grpc_interceptors/server.rb
+- lib/grpc_interceptors/kind.rb
 - lib/grpc_interceptors/server/logging_interceptor.rb
 - lib/grpc_interceptors/server/opentelemetry_tracing_interceptor.rb
 - lib/grpc_interceptors/server/statsd_metrics.rb
@@ -288,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A collection of Ruby interceptors (middlewares) for gRPC servers and clients.
 test_files: []

data/lib/grpc_interceptors/server.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module GrpcInterceptors
-  module Server
-    KIND = :server
-  end
-end