karafka-core 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37a3eb440f0d9b3dd0c4d12c9adf68ad6a1863c934c240e0c5a78dca0ca77b5
-  data.tar.gz: 6a20ec79c112500bf3df39c565cd5609ee6d632515c17230fd5ed0a5f1678697
+  metadata.gz: 267d7bea7b3b01122363dfe4d2157f9e400b89b375a8f21c61e913dfb54b89e6
+  data.tar.gz: f5b5b6d2b0e253aa3df2444fbd02aebae91b232e66b836f895128173eab481af
 SHA512:
-  metadata.gz: 173bf9d5d86be0c159b9351930b97e36a2bc897be3ad14a1f6ca3532ef2bc393d9b554f4825e322a77f67718bdb6b8d15e08c4cc810e89db0e1b104454935543
-  data.tar.gz: ba1bc96234bf57660dd821b9f0ecb3f7d8dd6bdc9210f2c0b2e5dfafb9ad7b22ebf7578608eb92f0f8159f45ad9f2f675b8ed579c5eb2b93bacbe27def07bb5d
+  metadata.gz: 2d5a57339a3259cd1561af52e33eb31b592d8e7b59201d3394a8f58f75ddd5c8acd835b94a8c9d50a93f48137191a5bb9d0570002234f2593652ed16b76a9b81
+  data.tar.gz: 3d00d4800f4c9ac425fd3f951b7bdee94a407a23d009c921f2c64799f32e36ea936814235dec0df922941036361c500e65fcda210aaf983c38ec9f3bf00c09e5

data/.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           - ruby: '3.2'
             coverage: 'true'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install package dependencies
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
       - name: Set up Ruby
@@ -49,7 +49,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Ruby
@@ -68,7 +68,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Run Coditsu

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Karafka core changelog
 
+### 2.2.2 (2023-09-11)
+- [Fix] Reuse previous frozen duration as a base for incoming computation.
+
+## 2.2.1 (2023-09-10)
+- Optimize statistics decorator by minimizing number of new objects created.
+- Expand the decoration to include new value `_fd` providing freeze duration in milliseconds. This value informs us for how many consecutive ms the given value did not change. It can be useful for detecting values that should change once in a while but are stale.
+
 ## 2.2.0 (2023-09-01)
 - [Maintenance] Update the signing cert (old expired)
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.2.0)
+    karafka-core (2.2.2)
       concurrent-ruby (>= 1.1)
       karafka-rdkafka (>= 0.13.1, < 0.14.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,7 +17,7 @@ GEM
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    factory_bot (6.2.1)
+    factory_bot (6.3.0)
       activesupport (>= 5.0.0)
     ffi (1.15.5)
     i18n (1.14.1)
@@ -27,7 +27,7 @@ GEM
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.2)
-    minitest (5.18.0)
+    minitest (5.19.0)
     rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)

data/lib/karafka/core/monitoring/statistics_decorator.rb

@@ -8,9 +8,26 @@ module Karafka
       # instead of being a value of messages sent from the last statistics report.
       # This decorator calculates the diff against previously emited stats, so we get also
       # the diff together with the original values
+      #
+      # It adds two extra values to numerics:
+      #   - KEY_d - delta of the previous value and current
+      #   - KEY_fd - freeze duration - describes how long the delta remains unchanged (zero)
+      #              and can be useful for detecting values that "hang" for extended period of time
+      #              and do not have any change (delta always zero). This value is in ms for the
+      #              consistency with other time operators we use.
       class StatisticsDecorator
+        include Helpers::Time
+
+        # Empty hash for internal referencing
+        EMPTY_HASH = {}.freeze
+
+        private_constant :EMPTY_HASH
+
         def initialize
-          @previous = {}.freeze
+          @previous = EMPTY_HASH
+          # Operate on ms precision only
+          @previous_at = monotonic_now.round
+          @current_at = @previous_at
         end
 
         # @param emited_stats [Hash] original emited statistics
@@ -19,12 +36,17 @@ module Karafka
         #   any API to get raw data, users can just assume that the result of this decoration is
         #   the proper raw stats that they can use
         def call(emited_stats)
+          @current_at = monotonic_now.round
+
+          @change_d = @current_at - @previous_at
+
           diff(
             @previous,
             emited_stats
           )
 
           @previous = emited_stats
+          @previous_at = @current_at
 
           emited_stats.freeze
         end
@@ -39,13 +61,17 @@ module Karafka
         # @return [Object] the diff if the values were numerics or the current scope
         def diff(previous, current)
           if current.is_a?(Hash)
+            filled_previous = previous || EMPTY_HASH
+            filled_current = current || EMPTY_HASH
+
             # @note We cannot use #each_key as we modify the content of the current scope
             #   in place (in case it's a hash)
             current.keys.each do |key|
               append(
-                current,
+                filled_previous,
+                filled_current,
                 key,
-                diff((previous || {})[key], (current || {})[key])
+                diff(filled_previous[key], filled_current[key])
               )
             end
           end
@@ -62,13 +88,23 @@ module Karafka
 
         # Appends the result of the diff to a given key as long as the result is numeric
         #
+        # @param previous [Hash] previous scope
         # @param current [Hash] current scope
         # @param key [Symbol] key based on which we were diffing
         # @param result [Object] diff result
-        def append(current, key, result)
+        def append(previous, current, key, result)
           return unless result.is_a?(Numeric)
           return if current.frozen?
 
+          freeze_duration_key = "#{key}_fd"
+
+          if result.zero?
+            current[freeze_duration_key] = previous[freeze_duration_key] || 0
+            current[freeze_duration_key] += @change_d
+          else
+            current[freeze_duration_key] = 0
+          end
+
           current["#{key}_d"] = result
         end
       end

data/lib/karafka/core/version.rb

@@ -4,6 +4,6 @@ module Karafka
   module Core
     # Current Karafka::Core version
     # We follow the versioning schema of given Karafka version
-    VERSION = '2.2.0'
+    VERSION = '2.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby