Class: Karafka::Setup::Config

Inherits:
Object
  • Object
show all
Extended by:
Core::Configurable
Defined in:
lib/karafka/setup/config.rb

Overview

Note:

If you want to do some configurations after all of this is done, please add to karafka/config a proper file (needs to inherit from Karafka::Setup::Configurators::Base and implement setup method) after that everything will happen automatically

Note:

This config object allows to create a 1 level nesting (nodes) only. This should be enough and will still keep the code simple

Configurator for setting up all the framework details that are required to make it work

See Also:

  • for more details about configurators api

Class Method Summary collapse

Class Method Details

.setup ⇒ Object

Configuring method



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/karafka/setup/config.rb', line 406

def setup(&)
  # Will prepare and verify license if present
  Licenser.prepare_and_verify(config.license)

  # Pre-setup configure all routing features that would need this
  Routing::Features::Base.pre_setup_all(config)

  # Will configure all the pro components
  # This needs to happen before end user configuration as the end user may overwrite some
  # of the pro defaults with custom components
  Pro::Loader.pre_setup_all(config) if Karafka.pro?

  # Wrap config in a proxy that intercepts producer block configuration
  proxy = ConfigProxy.new(config)
  # We need to check for the block presence here because user can just run setup without
  # any block given
  configure { yield(proxy) if block_given? }

  Contracts::Config.new.validate!(
    config.to_h,
    scope: %w[config]
  )

  configure_components(proxy)

  # Refreshes the references that are cached that might have been changed by the config
  Karafka.refresh!

  # Post-setup configure all routing features that would need this
  Routing::Features::Base.post_setup_all(config)

  # Runs things that need to be executed after config is defined and all the components
  # are also configured
  Pro::Loader.post_setup_all(config) if Karafka.pro?

  # Subscribe the assignments tracker so we can always query all current assignments
  config.monitor.subscribe(Instrumentation::AssignmentsTracker.instance)

  Karafka::App.initialized!
end