karafka 1.2.0.beta4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7df4ccab5fe5e942f4d97bdcb099ed1f754e3902c52775f9272e0f351c879ff
-  data.tar.gz: 73417de830c717ab59a74375091d45c43308c58b43fd00bdc7bd579b6f2ded6b
+  metadata.gz: 0bb0a1f72768ebf4bf720ebda57ebc26a0178275adabffd494b24e1612e9b38a
+  data.tar.gz: f586038a0498227e8a287cc173a23e77bb99b6cb8d453c39be55a220e2a0d361
 SHA512:
-  metadata.gz: 37cfeeb29cf0728d21e1dcd269c0432ec972bd6cc0b08f690fa49c3e2026ab2b8d2c558229c227dded52ee8a631859a17757422041fdce3ad424993573a5e6ac
-  data.tar.gz: 85061228901bdced44d5cf699d10ceb51a0bc818d39fdbcbd1f24b667d75d459f405262ca9036e63357637850d7084da8e71429808e6fd6f094cfbb82f581f05
+  metadata.gz: e2b862da6372bc91f76bc01c20eb21ccde9d61d67749ccce97eadd2f739484dbd68a149d08d6e275d94d95b6ce9610d86c2d01e85bb1841a80e048ed832810ac
+  data.tar.gz: 06fb89700e59f810ec984b54f0424cfdeb98c79e17b8629010f011e68edff5fa1e345576a7b28ed07aff440739ed11824016da6083601a92b8f83fcca68e576e

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Karafka framework changelog
 
-## 1.2.0.beta4
+## 1.2.0
 - Spec improvements
 - #260 - Specs missing randomization
 - #251 - Shutdown upon non responding (unreachable) cluster is not possible
@@ -17,6 +17,7 @@
 - #184 - Seek to
 - #284 - Dynamic Params parent class
 - #275 - ssl_ca_certs_from_system
+- #296 - Instrument forceful exit with an error
 - Replaced some of the activesupport parts with dry-inflector
 - Lower ActiveSupport dependency
 - Remove configurators in favor of the after_init block configurator

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka (1.2.0.beta4)
+    karafka (1.2.0)
       activesupport (>= 4.0)
       dry-configurable (~> 0.7)
       dry-inflector (~> 0.1.1)
@@ -28,13 +28,13 @@ GEM
       king_konf (~> 0.1.8)
       ruby-kafka (~> 0.5.1)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.0)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
     dry-container (0.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.4)
+    dry-core (0.4.5)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.2.0)
     dry-events (0.1.0)
@@ -66,8 +66,8 @@ GEM
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
       dry-types (~> 0.12.0)
-    envlogic (1.0.4)
-      activesupport
+    envlogic (1.1.0)
+      dry-inflector (~> 0.1)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     inflecto (0.0.2)
@@ -75,8 +75,8 @@ GEM
     king_konf (0.1.10)
     minitest (5.11.3)
     multi_json (1.13.1)
-    null-logger (0.1.4)
-    rake (12.3.0)
+    null-logger (0.1.5)
+    rake (12.3.1)
     require_all (2.0.0)
     rouge (2.2.1)
     rspec (3.7.0)
@@ -92,9 +92,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    ruby-kafka (0.5.3)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    ruby-kafka (0.5.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)

data/README.md

@@ -8,7 +8,7 @@ Karafka allows you to capture everything that happens in your systems in large s
 
 Karafka not only handles incoming messages but also provides tools for building complex data-flow applications that receive and send messages.
 
-**Warning**: Wiki and all the docs refer to the 1.2.0.beta2. Sorry for the inconvenience. We will release the stable 1.2.0 version soon.
+**Warning**: Wiki and all the docs refer to the 1.2.0.beta4. Sorry for the inconvenience. We will release the stable 1.2.0 version soon.
 
 ## How does it work
 

data/lib/karafka/connection/client.rb

@@ -31,21 +31,25 @@ module Karafka
           # always yield an array of messages, so we have consistent API (always a batch)
           kafka_consumer.each_message(*settings) { |message| yield([message]) }
         end
-      rescue Kafka::ProcessingError => e
+      rescue Kafka::ProcessingError => error
         # If there was an error during consumption, we have to log it, pause current partition
         # and process other things
         Karafka.monitor.instrument(
           'connection.client.fetch_loop.error',
           caller: self,
-          error: e.cause
+          error: error.cause
         )
-        pause(e.topic, e.partition)
+        pause(error.topic, error.partition)
         retry
         # This is on purpose - see the notes for this method
         # rubocop:disable RescueException
-      rescue Exception => e
+      rescue Exception => error
         # rubocop:enable RescueException
-        Karafka.monitor.instrument('connection.client.fetch_loop.error', caller: self, error: e)
+        Karafka.monitor.instrument(
+          'connection.client.fetch_loop.error',
+          caller: self,
+          error: error
+        )
         retry
       end
 

data/lib/karafka/instrumentation/listener.rb

@@ -86,6 +86,21 @@ module Karafka
           info "Responded from #{calling} using #{responder} with following data #{data}"
         end
 
+        # Logs info that we're going to stop the Karafka server
+        # @param _event [Dry::Events::Event] event details including payload
+        def on_server_stop(_event)
+          # We use a separate thread as logging can't be called from trap context
+          Thread.new { info "Stopping Karafka server #{::Process.pid}" }
+        end
+
+        # Logs an error that Karafka was unable to stop the server gracefully and it had to do a
+        #   forced exit
+        # @param _event [Dry::Events::Event] event details including payload
+        def on_server_stop_error(_event)
+          # We use a separate thread as logging can't be called from trap context
+          Thread.new { error "Forceful Karafka server #{::Process.pid} stop" }
+        end
+
         USED_LOG_LEVELS.each do |log_level|
           define_method log_level do |*args|
             Karafka.logger.send(log_level, *args)

data/lib/karafka/instrumentation/monitor.rb

@@ -34,6 +34,8 @@ module Karafka
         async_producer.call.retry
         sync_producer.call.error
         sync_producer.call.retry
+        server.stop
+        server.stop.error
       ].freeze
 
       private_constant :BASE_EVENTS

data/lib/karafka/server.rb

@@ -67,8 +67,9 @@ module Karafka
       # Stops Karafka with a supervision (as long as there is a shutdown timeout)
       # If consumers won't stop in a given timeframe, it will force them to exit
       def stop_supervised
-        Karafka::App.stop!
+        Karafka.monitor.instrument('server.stop', {})
 
+        Karafka::App.stop!
         # If there is no shutdown timeout, we don't exit and wait until all the consumers
         # had done their work
         return unless Karafka::App.config.shutdown_timeout
@@ -81,8 +82,11 @@ module Karafka
           sleep SUPERVISION_SLEEP
         end
 
+        Karafka.monitor.instrument('server.stop.error', {})
         # We're done waiting, lets kill them!
         consumer_threads.each(&:terminate)
+
+        # exit is not within the instrumentation as it would not trigger due to exit
         Kernel.exit FORCEFUL_EXIT_CODE
       end
     end

data/lib/karafka/templates/karafka.rb.example

@@ -19,6 +19,8 @@ class KarafkaApp < Karafka::App
     config.client_id = 'example_app'
     config.backend = :inline
     config.batch_fetching = true
+    # Uncomment this for Rails app integration
+    # config.logger = Rails.logger
   end
 
   after_init do |config|

data/lib/karafka/version.rb

@@ -3,5 +3,5 @@
 # Main module namespace
 module Karafka
   # Current Karafka version
-  VERSION = '1.2.0.beta4'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 1.2.0.beta4
+  version: 1.2.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -289,9 +289,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6