Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "DOC0000362" into parent

Message broker is a set of components that allow supporting message exchange among other system components. This functionality allows you to handle processing transactions in real-time, such as notification processing , and importing. Also, also message queue queues are used when you are starting a Scheduled Script.

Key Terms


Message broker – a – a system component, the main function of which is to keep and share messages among other system components.

Producer – a program or a system module sending a message into a the Queue (producing a message).

Consumer – a program or a system module receiving that receives a message from a the Queue and processing processes it.

Queue – a part of a Message Broker; a list implemented on the FIFO basis (First In First Out). It is intended to keep messages of similar type and allocate them among responsible Consumers.

Exchange – a part of a Message Broker responsible for the message allocation among Queues.

Routing Key – a key that is needed for message allocation among Queues.

Binding – a connection between Exchanges or between an the Exchange and a the Queue.


Message Broker

operation

operating modes


Message broker can operate with instant messages and delayed messages. The difference is that delayed messages are sent after some time specified in the $delay parameter.

Instant

messages

message processing


Instant messages message processing consists of several stages:

  1. Message sending
  2. Message storage in queue
  3. Message processing.

Message sending

In brief, the component (program or module) producing a message (a Producer) generates a message and enhances it with a service data (such as Routing Key, User ID, Sys_ID referenced to the User Token (user_token) table). Before sending, the message is serialized.

Sending example:

Code Block
languagejs
themeEclipse
linenumberstrue
$this->producer->publish($message = 'message', $routingKey = 'echo');

Message storage in queue

After Once messages are queued up, then they should then be processed.

The queue listens to the specified Consumer state (it is based on the Routing Key). When If the Consumer can get gets the message, then it happens. If the queue has no consumers, then the messages line up in the queue but do not disappear.

By default, every queue has at least one consumer. If a queue has more than one consumer bound, then it allocates messages among them.

Message processing

Consumer is implemented as a background process running in a separate Docker container. It runs a shell app within the container; after that, the message is processed by a back-end interface with a specific classes class, which are is chosen based on the Routing Key specified in the message.

Before processing, a consumer should perform user (or impersonator) authorization, which were is the message sending initiatorsinitiator; necessary authorization information can be found in every message.

Delayed messages processing


In general, delayed messages message processing is similar to instant messages message processing. The difference is that the parameter responsible for delay specifying is implemented, allowing that this message should to be sent with a delay specified.

Logging


All message exchanging activities are logged and can be found in the Queue Messages (sys_queue_message) table.

Queue Message fields description

FieldDescriptionMessageContent of the message sending. This field is mandatory.Routing KeyMessage routing key. This field is mandatory.Scheduled start timeRepresents date and time of suggested message processing start (based on the value specified in the delay parameter); otherwise, contains NULL.Start timeContains a date and time when the message processing starts.End timeContains a date and time when the message processing ends.State

Message processing state. Available options:

  • Pending
  • In Process
  • Completed
  • Error
Log Exception IDThis field displays the ID of the thrown log exception if there was one; otherwise, contains NULL.Memory usage, MbIn there, total memory amount (in bytes) for message processing is displayed.

 to the standard output (Stdout).

Environment settings


Message broker system consists of two containers.:

  1. Within the first container, the message broker is running externally and available via TCP. Also,
the specific plugin
  1. a specific plugin is configured there
for creating
  1. to create delayed messages.
  2. Within the second container, the supervisor daemon runs the required workers amount (can be set by an environment variable).
In the case of
  1. If one of
this
  1. these processes fails, the supervisor starts the new one.

Table of Contents
absoluteUrltrue
classfixedPosition