Class: Karafka::App

Inherits:

Object

• Object
• Karafka::App

Defined in:

lib/karafka/app.rb

Overview

App class

Class Method Summary

• .boot! ⇒ Object

  Sets up all the internal components and bootstrap whole app We need to know details about consumers in order to setup components, that’s why we don’t setup them after std setup is done.

• .config ⇒ Karafka::Config

  Config instance.

• .consumer_groups ⇒ Karafka::Routing::Builder

  Consumers builder instance.

• .setup(&block) ⇒ Object

  Sets up the whole configuration.

Class Method Details

.boot! ⇒ Object

Sets up all the internal components and bootstrap whole app We need to know details about consumers in order to setup components, that’s why we don’t setup them after std setup is done

Raises:

• (Karafka::Errors::InvalidConfiguration) —

  raised when configuration doesn’t match with ConfigurationSchema

# File 'lib/karafka/app.rb', line 19

def boot!
  Setup::Config.validate!
  Setup::Config.setup_components
end

.config ⇒ Karafka::Config

Returns config instance.

Returns:

• (Karafka::Config) —

  config instance

# File 'lib/karafka/app.rb', line 25

def config
  Setup::Config.config
end

.consumer_groups ⇒ Karafka::Routing::Builder

Returns consumers builder instance.

Returns:

• (Karafka::Routing::Builder) —

  consumers builder instance

# File 'lib/karafka/app.rb', line 30

def consumer_groups
  Routing::Builder.instance
end

.setup(&block) ⇒ Object

Sets up the whole configuration

Parameters:

• block (Block) —

  configuration block

# File 'lib/karafka/app.rb', line 9

def setup(&block)
  Setup::Config.setup(&block)
  initialize!
end