Sha256: 02e2a5254dd64b818021a4d02b9da529501de0bcad397e1b8e86a5a2c5172410

Contents?: true

Size: 1.54 KB

Versions: 41

Compression:

Stored size: 1.54 KB

Contents

# frozen_string_literal: true

# This Karafka component is a Pro component under a commercial license.
# This Karafka component is NOT licensed under LGPL.
#
# All of the commercial components are present in the lib/karafka/pro directory of this
# repository and their usage requires commercial license agreement.
#
# Karafka has also commercial-friendly license, commercial support and commercial components.
#
# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
# your code to Maciej Mensfeld.

module Karafka
  module Pro
    # Feature that introduces a granular memory management for each message and messages iterator
    #
    # It allows for better resource allocation by providing an API to clear payload and raw payload
    # from a message after those are no longer needed but before whole messages are freed and
    # removed by Ruby GC.
    #
    # This can be useful when processing bigger batches or bigger messages one after another and
    # wanting not to have all of the data loaded into memory.
    #
    # Can yield significant memory savings (up to 80%).
    module Cleaner
      class << self
        # @param _config [Karafka::Core::Configurable::Node] root node config
        def pre_setup(_config)
          ::Karafka::Messages::Message.prepend(Messages::Message)
          ::Karafka::Messages::Messages.prepend(Messages::Messages)
        end

        # @param _config [Karafka::Core::Configurable::Node] root node config
        def post_setup(_config)
          true
        end
      end
    end
  end
end

Version data entries

41 entries across 41 versions & 1 rubygems

Version Path
karafka-2.3.0 lib/karafka/pro/cleaner.rb
karafka-2.3.0.rc1 lib/karafka/pro/cleaner.rb
karafka-2.3.0.alpha2 lib/karafka/pro/cleaner.rb
karafka-2.3.0.alpha1 lib/karafka/pro/cleaner.rb
karafka-2.2.14 lib/karafka/pro/cleaner.rb
karafka-2.2.13 lib/karafka/pro/cleaner.rb
karafka-2.2.12 lib/karafka/pro/cleaner.rb
karafka-2.2.11 lib/karafka/pro/cleaner.rb
karafka-2.2.10 lib/karafka/pro/cleaner.rb
karafka-2.2.9 lib/karafka/pro/cleaner.rb
karafka-2.2.8 lib/karafka/pro/cleaner.rb
karafka-2.2.8.beta1 lib/karafka/pro/cleaner.rb
karafka-2.2.7 lib/karafka/pro/cleaner.rb
karafka-2.2.6 lib/karafka/pro/cleaner.rb
karafka-2.2.5 lib/karafka/pro/cleaner.rb
karafka-2.2.4 lib/karafka/pro/cleaner.rb
karafka-2.2.3 lib/karafka/pro/cleaner.rb
karafka-2.2.2 lib/karafka/pro/cleaner.rb
karafka-2.2.1 lib/karafka/pro/cleaner.rb
karafka-2.2.0 lib/karafka/pro/cleaner.rb