Class: Karafka::Setup::Configurators::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/karafka/setup/configurators/base.rb

Overview

Note:

This should be used only for internal Karafka dependencies configuration End users configuration should go to the after_init block

Karafka has some components that it relies on (like Sidekiq) We need to configure all of them only when the framework was set up. Any class that descends from this one will be automatically invoked upon setup (after it)

Examples:

Configure an Example class

class ExampleConfigurator < Base
  def setup
    ExampleClass.logger = Karafka.logger
    ExampleClass.redis = config.redis
  end
end

Direct Known Subclasses

Params, WaterDrop

Class Method Summary collapse

Class Method Details

.setup(_config) ⇒ Object

This method needs to be implemented in a subclass

Parameters:

  • _config (Karafka::Config) —

    config instance

Raises:

  • (NotImplementedError) 


23
24
25
 
# File 'lib/karafka/setup/configurators/base.rb', line 23

def self.setup(_config)
  raise NotImplementedError
end