Module: Karafka::Web::Errors

Defined in:
lib/karafka/web/errors.rb

Overview

Karafka::Web related errors

Defined Under Namespace

Modules: Management, Processing, Ui

Constant Summary collapse

BaseError =

Base class for all errors related to the web ui

Class.new(::Karafka::Errors::BaseError)
ContractError =

Raised when the a report is not valid for any reason This should never happen and if you see this, please open an issue.

Class.new(BaseError)
KarafkaNotInitializedError =

Raised when you try to configure Web UI but Karafka was not yet configured and is not in a state to accept Web UI integration.

If you are seeing this error, it means you tried to configure and setup the Web UI before you configured Karafka. In case of a “split-setup” where you divided your karafka.rb into separate files, likely you are requiring the web-ui component prior to the one that configures Karafka

Class.new(BaseError)
LateSetupError =

Raised when you try to configure Web UI after it was enabled. It is not allowed because Karafka Web UI uses the setup values during the enablement and their later change may not be fully reflected. Always run #setup before #enable!.

Class.new(BaseError)