jcw 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47920cfcec226ff9785a16c1297f9a7aafc571db02c0d2a2b27f66440d6d874f
-  data.tar.gz: c90c9a5636ae6c7827074cd1b64329999f21a098d3c04b92fe3a5da085aaaad5
+  metadata.gz: bc773311ab088e7276e7fb32a3f4482fe573b1395504aa2a3f65976c2554ee5d
+  data.tar.gz: e55467a99786575009b8bb0bd87204c0349517913db982e3367235ef11b5d6ca
 SHA512:
-  metadata.gz: 91dea8b748dbc92f865113b8066a57cf84fbf6ccea64ede2dedf9dcc02f2b33f6fe315182efcd209746c00f0889d863239ef86991adba8f946e9f27b8d536b0a
-  data.tar.gz: 6d8ed800f4b0a113f73546943d0f87bb2ca8ce9b71fc6e6c740c5411c266c94e94dab113e9944ef27db047b067d4dbe194ab782c329d9ac47fd5b99c3239bf58
+  metadata.gz: 1dfba6de347759d9dbd0073f7f258b7305a2257a340d26dc2248df54cdaaba7319583b18a281b688356f1fbce4ccd0144cffa7656919803418127d036af829f0
+  data.tar.gz: a60b7db65670d6c171acda171c77cc4de936959417d484fd04678d82ed94ed638c59dafca5bc0336d27007d894af7a6ec8cc2057d28f865472520629f7d71782

data/.github/workflows/test.yml

@@ -41,11 +41,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, 2.7.4, 3.0.0, 3.0.1, 3.0.2]
+        ruby: [2.6, 2.7, 2.7.4, 3.0.0, 3.0.1, 3.0.2]
         experimental: [false]
-        include:
-          - ruby: head
-            experimental: true
 
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.6
 
 RSpec/EmptyLineAfterHook:
   Enabled: false

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    jcw (0.1.0)
+    jcw (0.2.1)
       activesupport (>= 5.0)
+      gruf (~> 2.10)
       httprb-opentracing (~> 0.4.0)
       jaeger-client (~> 1.1.0)
       rack-tracer (~> 0.9.0)
@@ -43,11 +44,28 @@ GEM
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    e2mmap (0.1.0)
     erubi (1.10.0)
     ffi (1.15.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    google-protobuf (3.19.1)
+    googleapis-common-protos-types (1.3.0)
+      google-protobuf (~> 3.14)
+    grpc (1.41.1)
+      google-protobuf (~> 3.17)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.41.1)
+    gruf (2.10.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      e2mmap (~> 0.1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      json (>= 2.3)
+      slop (~> 4.6)
+      thwait (~> 0.1)
     http (5.0.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -65,6 +83,7 @@ GEM
     jaeger-client (1.1.0)
       opentracing (~> 0.3)
       thrift
+    json (2.6.1)
     llhttp-ffi (0.3.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
@@ -74,12 +93,12 @@ GEM
     method_source (1.0.0)
     mini_portile2 (2.6.1)
     minitest (5.14.4)
-    nokogiri (1.12.3)
+    nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-darwin)
+    nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.3-x86_64-linux)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     opentracing (0.5.0)
     parallel (1.20.1)
@@ -163,8 +182,11 @@ GEM
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.3)
+    slop (4.9.1)
     thor (1.1.0)
-    thrift (0.14.2)
+    thrift (0.15.0)
+    thwait (0.2.0)
+      e2mmap
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -1,4 +1,4 @@
-# JCW · [![Supporting](https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_badge.png)](https://github.com/Cado-Labs/) · [![Coverage Status](https://coveralls.io/repos/github/Cado-Labs/jcw/badge.svg?branch=gem-without-zeitwerk)](https://coveralls.io/github/Cado-Labs/jcw?branch=gem-without-zeitwerk)
+# JCW &middot; <a target="_blank" href="https://github.com/Cado-Labs"><img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_badge.svg" alt="Supported by Cado Labs" style="max-width: 100%; height: 20px"></a> &middot; [![Coverage Status](https://coveralls.io/repos/github/Cado-Labs/jcw/badge.svg?branch=gem-without-zeitwerk)](https://coveralls.io/github/Cado-Labs/jcw?branch=gem-without-zeitwerk) &middot; [![Gem Version](https://badge.fury.io/rb/jcw.svg)](https://badge.fury.io/rb/jcw)
 
 Simple wrapper for the gem "jaeger-client" with simpler customization.
 
@@ -6,7 +6,7 @@ Simple wrapper for the gem "jaeger-client" with simpler customization.
 
 <p>
   <a href="https://github.com/Cado-Labs">
-    <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_supporting.svg" alt="Supported by Cado Labs" />
+    <img src="https://github.com/Cado-Labs/cado-labs-resources/blob/main/cado_labs_supporting_rounded.svg" alt="Supported by Cado Labs" />
   </a>
 </p>
 
@@ -25,7 +25,7 @@ gem install jcw
 ```
 
 ```ruby
-require 'jcw' 
+require 'jcw'
 ```
 
 ## Usage
@@ -68,17 +68,57 @@ Rails.application.middleware.use(JCW::RackTracer)
 # Not recommended for UDP sender, because default max packet size is 65,000 bytes.
 Rails.application.config.tap do |config|
   config.middleware.use(
-  ::JCW::RackTracer,
-  on_finish_span:
-    -> (span) { ::JCW::JaegerLogger.current.logs.each { |log| span.log_kv(**log) } },
+    JCW::RackTracer,
+    on_finish_span: lambda do |span|
+      JCW::Logger.current.logs.each { |log| span.log_kv(**log) }
+      JCW::Logger.current.clear # Do not forget to avoid memory leaks
+    end,
   )
-  config.logger.extend(::JCW::JaegerLoggerExtension)
+
+  config.logger.extend(JCW::LoggerExtension)
 end
 ```
 - `config.subscribe_to` - not recommended for UDP sender, because default max packet size is 65,000 bytes.
 
+#### GRPC Integration
+
+Client side
+
+```ruby
+# Add JCW::Interceptors::Gruf::Client Interceptor to Gruf Client Initializer
+options = {}
+client_options = { timeout: 10, interceptors: [JCW::Interceptors::Gruf::Client.new] }
+
+client = Gruf::Client.new(
+  service: Test::Service, options: options, client_options: client_options
+)
+
+request_method = "some_method"
+client.call(request_method)
+```
+
+Server side
+
+```ruby
+# Add Server Interceptor
+Rails.configuration.to_prepare do
+  Gruf.configure do |config|
+    config.interceptors.use(JCW::Interceptors::Gruf::Server)
+  end
+end  
+
+# Configure
+::JCW::Wrapper.configure do |config|
+  config.service_name = "Service Name"
+  config.connection = { protocol: :udp, host: "127.0.0.1", port: 6831 }
+  config.enabled = true
+  config.subscribe_to = [/.*/]
+  config.grpc_ignore_methods = %w[grpc.ignore.method]
+end
+```
+
 ### Contributing
- 
+
  - Fork it ( https://github.com/Cado-Labs/jcw )
  - Create your feature branch (`git checkout -b feature/my-new-feature`)
  - Commit your changes (`git commit -am '[feature_context] Add some feature'`)
@@ -92,7 +132,7 @@ Released under MIT License.
 ## Supporting
 
 <a href="https://github.com/Cado-Labs">
-  <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_logo.png" alt="Supported by Cado Labs" />
+  <img src="https://github.com/Cado-Labs/cado-labs-resources/blob/main/cado_labs_supporting_rounded.svg" alt="Supported by Cado Labs" />
 </a>
 
 ## Authors

data/jcw.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Wrapper for the gem 'jaeger-client' with simpler customization."
   spec.homepage      = "https://github.com/Cado-Labs/jcw"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "gruf", "~> 2.10"
   spec.add_dependency "httprb-opentracing", "~> 0.4.0"
   spec.add_dependency "jaeger-client", "~> 1.1.0"
   spec.add_dependency "rack-tracer", "~> 0.9.0"

data/lib/jcw/config.rb

@@ -7,7 +7,8 @@ module JCW
                 :subscribe_to,
                 :connection,
                 :flush_interval,
-                :tags
+                :tags,
+                :grpc_ignore_methods
 
     def enabled
       @enabled ||= false
@@ -34,5 +35,9 @@ module JCW
     def tags
       @tags ||= {}
     end
+
+    def grpc_ignore_methods
+      @grpc_ignore_methods ||= []
+    end
   end
 end

data/lib/jcw/init.rb

@@ -14,7 +14,7 @@ module JCW
       def init_jaeger_client
         return unless config.enabled?
 
-        reporter = config.connection[:protocol] == :tcp ? tcp_reporter : nil
+        reporter = config.connection[:protocol].to_sym == :tcp ? tcp_reporter : nil
 
         OpenTracing.global_tracer = Jaeger::Client.build(
           service_name: config.service_name,
@@ -41,11 +41,10 @@ module JCW
       end
 
       def activate_subscribers
-        subscribers = config.subscribe_to
-        return if subscribers.blank?
+        events = config.subscribe_to
+        return if events.blank?
 
-        Tracing.register_subscribers(subscribers)
-        Tracing.subscribe_tracing_events
+        events.each { |event| JCW::Subscriber.subscribe_to_event!(event) }
       end
 
       def init_http_tracer

data/lib/jcw/interceptors/gruf/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "gruf"
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Client < ::Gruf::Interceptors::ClientInterceptor
+        def call(request_context:)
+          tracer = OpenTracing.global_tracer
+          metadata = request_context.metadata
+
+          tags = {
+            "component" => "gRPC",
+            "span.kind" => "client",
+            "grpc.method_type" => "request_response",
+            "grpc.headers" => metadata,
+          }
+
+          tracer.start_active_span(request_context.method.to_s, tags: tags) do |current_scope|
+            current_span = current_scope.span
+            current_span.log_kv(
+              event: "request",
+              data: request_context.requests.map { |request| request.try(:to_h) },
+            )
+            hpack_carrier = Hpack.new(metadata)
+            tracer.inject(current_span.context, ::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
+
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jcw/interceptors/gruf/hpack.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Hpack
+        def initialize(wrapped)
+          @wrapped = wrapped
+        end
+
+        def [](key)
+          @wrapped[key.downcase]
+        end
+
+        def []=(key, value)
+          return unless value
+
+          @wrapped[key.downcase] = value
+        end
+
+        def each(&block)
+          @wrapped.each(&block)
+        end
+      end
+    end
+  end
+end

data/lib/jcw/interceptors/gruf/server.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "gruf"
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Server < ::Gruf::Interceptors::ServerInterceptor
+        # rubocop:disable Metrics/MethodLength
+        def call
+          method = request.method_name
+          return yield if Wrapper.config.grpc_ignore_methods.include?(method)
+
+          tracer = OpenTracing.global_tracer
+          on_finish_span = options[:on_finish_span]
+          service_class = request.service
+          method_name = request.method_key
+          name = method_name.to_s.camelize
+          route = "/#{service_class.service_name}/#{name}"
+
+          begin
+            tags = {
+              "component" => "gRPC",
+              "span.kind" => "server",
+              "grpc.method_type" => "request_response",
+            }
+            hpack_carrier = Hpack.new(request.active_call.metadata)
+            parent_span_context = tracer.extract(::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
+            current_scope = tracer.start_active_span(
+              route,
+              child_of: parent_span_context,
+              tags: tags,
+            )
+            current_span = current_scope.span
+            current_span.log_kv(event: "request", data: request.message.to_h)
+
+            response = yield
+
+            if response.try(:error_fields)
+              current_span.set_tag("error", true)
+              current_span.log_kv(event: "error", data: response.to_h)
+            end
+          rescue => e
+            if current_span
+              current_span.set_tag("error", true)
+              current_span.log_kv(event: "error", error_object: e)
+            end
+            raise
+          ensure
+            on_finish_span&.call(current_span)
+            current_scope.close if current_span
+          end
+
+          response
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/jcw/subscriber.rb

@@ -1,26 +1,31 @@
 # frozen_string_literal: true
 
 module JCW
-  class Subscriber
-    class << self
-      def subscribe_to_event!(event_name)
-        ActiveSupport::Notifications.subscribe(event_name) do |*args|
-          (span = OpenTracing.scope_manager.active&.span) or next
-          event = ActiveSupport::Notifications::Event.new(*args)
-          span.log_kv(context: span_context(event))
-        end
+  module Subscriber
+    extend self
+
+    IGNORED_PAYLOAD_KEYS = %i[request response headers exception exception_object].freeze
+
+    def subscribe_to_event!(event)
+      ActiveSupport::Notifications.subscribe(event) do |name, _start, _finish, _uid, payload|
+        add(name, payload)
       end
+    end
 
-      private
+    def add(name, payload)
+      # skip Rails internal events
+      return if name.start_with?("!")
 
-      def span_context(event)
-        {
-          name: event.name,
-          time: event.time,
-          payload: event.payload.to_s,
-          transaction_id: event.transaction_id,
-        }.as_json
+      span = OpenTracing.scope_manager.active&.span
+      return if span.blank?
+
+      if payload.is_a?(Hash)
+        # we should only mutate the copy of the payload
+        payload = payload.dup
+        IGNORED_PAYLOAD_KEYS.each { |key| payload.delete(key) if payload.key?(key) }
       end
+
+      span.log_kv(message: name, context: JSON.dump(payload))
     end
   end
 end

data/lib/jcw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JCW
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/jcw/wrapper.rb

@@ -17,10 +17,12 @@ module JCW
   end
 end
 
-require_relative "tracing"
 require_relative "init"
 require_relative "subscriber"
 require_relative "http_tracer"
 require_relative "rack_tracer"
+require_relative "interceptors/gruf/client"
+require_relative "interceptors/gruf/server"
+require_relative "interceptors/gruf/hpack"
 require_relative "logger"
 require_relative "logger_extension"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcw
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alexander Starovojtov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: httprb-opentracing
   requirement: !ruby/object:Gem::Requirement
@@ -244,11 +258,13 @@ files:
 - lib/jcw/config.rb
 - lib/jcw/http_tracer.rb
 - lib/jcw/init.rb
+- lib/jcw/interceptors/gruf/client.rb
+- lib/jcw/interceptors/gruf/hpack.rb
+- lib/jcw/interceptors/gruf/server.rb
 - lib/jcw/logger.rb
 - lib/jcw/logger_extension.rb
 - lib/jcw/rack_tracer.rb
 - lib/jcw/subscriber.rb
-- lib/jcw/tracing.rb
 - lib/jcw/version.rb
 - lib/jcw/wrapper.rb
 homepage: https://github.com/Cado-Labs/jcw
@@ -263,7 +279,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/jcw/tracing.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module JCW
-  module Tracing
-    class << self
-      attr_reader :subscribers
-
-      def register_subscribers(subscribers)
-        @subscribers = subscribers
-      end
-
-      def subscribe_tracing_events
-        subscribers.each { |subscriber| Subscriber.subscribe_to_event!(subscriber) }
-      end
-    end
-  end
-end