karafka-core 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd6d59f81183ea27ea19b3292f17e94928bf8159527521d542e0ca997e3cfef
-  data.tar.gz: d71e9371eb87e46f3a41468807b0ec66cc817752701ab2ccd9b2b3ffb41d84a3
+  metadata.gz: f3932e3ec9d159f2be8ba43d231197c00770409693e712a6a14f7893aa5671fc
+  data.tar.gz: 86b27fc05550881f80f7d3db32d4e7cd3fcd48b8792d87413d6887ca19722d3f
 SHA512:
-  metadata.gz: 871ccf53e4f17d93ad16ed22484b880ca03a73b96202aa1bf4be1c3cf69b684b0ae63838ff939d4e3503a36a6c62a36dee6ca3757e9255bba272bc74a44777eb
-  data.tar.gz: 36ae734a39ba0f146926ccbeb84755130dee1966fe1398a94fafbf06da58da051ca546538132db218f03a82ee2a56e53698da89786356b34b71bc06775e93aa4
+  metadata.gz: c017f02c04db51ea04a7686a41974622006c0a6eaf07aeaa9edbd7f9e6b32fcca14edf8215da67a9f50d52237c455a3242e900994a9444df833eebf606de74c6
+  data.tar.gz: e07af5f18d2f158209afa0c9615cc2d2459edb4d89a5b4534e9424e3d2243decd1bff316fc7a03556478b9f3f2b1afe5d20cf5367eaa93376350005b6711f158

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Karafka core changelog
 
-## 2.0.1
+## 2.0.2 (2022-08-01)
+- Add extracted statistics decorator (#932)
+
+## 2.0.1 (2022-07-30)
 - Fix a case where setting would match a method monkey-patched on an object (#1) causing initializers not to build proper accessors on nodes. This is not the core bug, but still worth handling this case.
 
-## 2.0.0
+## 2.0.0 (2022-07-28)
 - Initial extraction of common components used in the Karafka ecosystem from WaterDrop.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-core (2.0.1)
+    karafka-core (2.0.2)
       concurrent-ruby (>= 1.1)
 
 GEM

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Core
+    module Monitoring
+      # Many of the librdkafka statistics are absolute values instead of a gauge.
+      # This means, that for example number of messages sent is an absolute growing value
+      # 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
+      class StatisticsDecorator
+        def initialize
+          @previous = {}.freeze
+        end
+
+        # @param emited_stats [Hash] original emited statistics
+        # @return [Hash] emited statistics extended with the diff data
+        # @note We modify the emited statistics, instead of creating new. Since we don't expose
+        #   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)
+          diff(
+            @previous,
+            emited_stats
+          )
+
+          @previous = emited_stats
+
+          emited_stats.freeze
+        end
+
+        private
+
+        # Calculates the diff of the provided values and modifies in place the emited statistics
+        #
+        # @param previous [Object] previous value from the given scope in which
+        #   we are
+        # @param current [Object] current scope from emitted statistics
+        # @return [Object] the diff if the values were numerics or the current scope
+        def diff(previous, current)
+          if current.is_a?(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,
+                key,
+                diff((previous || {})[key], (current || {})[key])
+              )
+            end
+          end
+
+          # Diff can be computed only for numerics
+          return current unless current.is_a?(Numeric)
+          # If there was no previous value, delta is always zero
+          return 0 unless previous
+          # Should never happen but just in case, a type changed in between stats
+          return current unless previous.is_a?(Numeric)
+
+          current - previous
+        end
+
+        # Appends the result of the diff to a given key as long as the result is numeric
+        #
+        # @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)
+          return unless result.is_a?(Numeric)
+          return if current.frozen?
+
+          current["#{key}_d"] = result
+        end
+      end
+    end
+  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.0.1'
+    VERSION = '2.0.2'
   end
 end

data/lib/karafka-core.rb

@@ -11,6 +11,7 @@
   karafka/core/monitoring/event
   karafka/core/monitoring/monitor
   karafka/core/monitoring/notifications
+  karafka/core/monitoring/statistics_decorator
   karafka/core/configurable
   karafka/core/configurable/leaf
   karafka/core/configurable/node

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-core
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -34,7 +34,7 @@ cert_chain:
   R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
   pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
   -----END CERTIFICATE-----
-date: 2022-07-30 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -89,6 +89,7 @@ files:
 - lib/karafka/core/monitoring/event.rb
 - lib/karafka/core/monitoring/monitor.rb
 - lib/karafka/core/monitoring/notifications.rb
+- lib/karafka/core/monitoring/statistics_decorator.rb
 - lib/karafka/core/version.rb
 - log/.gitkeep
 homepage: https://karafka.io