jcw 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fc0e3e0c34e18f281b228fc45782f30109ba9125c6730ff170982f9c683e5c
-  data.tar.gz: 4ac948f3822db7891f59919616302077757c6ef0a71f6e2a4a09c06ced413241
+  metadata.gz: c7621b3db92b4172f29ae46a914d6f5a33611f276dfaa17d1effeff36f16c68b
+  data.tar.gz: c9ac2ea12ee2862fcb762673dd5285e7422b86fe91c38a39f9fa66bd890fa83c
 SHA512:
-  metadata.gz: 9e75ea2fb98b023b70b2cf7b84074a9ec4a6bef9f7a901d48da09ac6a9f1b63c4b9b6d9838f83658729e602c27bcf739fa869437d95022bd0b92060f92cf3239
-  data.tar.gz: 5b5c8c1248f89e9fc28a82b3dab536da66115c34e03254cbb3822e5123076998c4b9674969343766f9b51a6ad14bcf78d99fa6620a353af549f4536968d7a3d7
+  metadata.gz: e6558c6b64a50a283c6e9a97024ee8191fd595bb73b071ae84259ec7a61d51ab4046b6f70e33f335bedf7888f791f170375e2b7f3ab428a373259716c9acfe19
+  data.tar.gz: c5d6da1d532632920fdce571c254737654d0e37c7aca2d89bf8852126ae15882c3f4965461b341ecfcbf04add3a366010b103d5cd83cf2fe1df8b9c71860e15d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jcw (0.1.2)
+    jcw (0.1.3)
       activesupport (>= 5.0)
       httprb-opentracing (~> 0.4.0)
       jaeger-client (~> 1.1.0)
@@ -74,12 +74,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)
@@ -164,7 +164,7 @@ GEM
     simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.3)
     thor (1.1.0)
-    thrift (0.14.2)
+    thrift (0.15.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -25,7 +25,7 @@ gem install jcw
 ```
 
 ```ruby
-require 'jcw' 
+require 'jcw'
 ```
 
 ## Usage
@@ -68,17 +68,20 @@ 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.
 
 ### 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'`)

data/lib/jcw/init.rb

@@ -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/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.2"
+  VERSION = "0.1.3"
 end

data/lib/jcw/wrapper.rb

@@ -17,7 +17,6 @@ module JCW
   end
 end
 
-require_relative "tracing"
 require_relative "init"
 require_relative "subscriber"
 require_relative "http_tracer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcw
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexander Starovojtov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -248,7 +248,6 @@ files:
 - 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

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