Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 3.51 KB

system-design-overview.md

File metadata and controls

24 lines (14 loc) · 3.51 KB
description
Overview of the Foundry Message-oriented middleware (MoM) system

System Design

System design

Message-oriented middleware (MoM) systems such as Apache ActiveMQ allow designing loosely coupled distributed systems that can run in heterogeneous distributed computer environments. Use of MoM in Foundry allows horizontal scaling of the system by adding new consumer nodes on demand for increased load. It allows for event-driven, reactive workflow management orchestrated by messages sent/received from consumers that are self-contained processing units (microservices) to/from a message dispatcher component. The persistent message queues also make the system resilient to computer crashes and outages, as unfinished messages resulting from a computer failure on a consumer node remain in the message queue and are either picked up by another consumer node (if any are running) or reprocessed when the consumer node restarts.

The overall system consists of a dispatcher, one or more consumer container(s) and a command-line manager interface. The dispatcher listens to the dispatcher message queue for incoming messages from consumer container instance(s). Using its configured workflow, it dispatches messages to the message queue for the listening consumer container(s). The consumer container coordinates a set of configured consumers that perform predefined operation(s) of a document indicated by the message they receive from the dispatcher and ingestors. The harvesters/ingestors are specialized consumers that are responsible for the retrieval of the original data as configured by a harvest descriptor JSON file of the corresponding source. They are triggered by the manager application. These component interactions are summarized in Figure 1 and an example of a specific pipeline is given in the section below.

Figure 1: Foundry dispatcher and consumer container unified modeling language activity diagram.

A message oriented middleware based document processing system

The system uses Apache ActiveMQ as message broker. A producer/dispatcher that hooks into the oplog of the mongodb replica set fetches any updated/inserted documents and depending on their status value dispatch them to ActiveMQ persistent point-to-point (PTP) queues. The messages contain in their body only the MongoDB object id and dispatcher will coalesce multiple documents change records of the same status into a single message for better scalability.

For each different operation that can be done on a document there is a different persistent queue and each persistent queue serves multiple concurrent consumers that listen on messages they are interested. Each message is delivered to a single consumer (PTP) by the dispatcher and the consumer reads the MongoDB objectid(s) from the message body to retrieve the document from the MongoDB replica set, process it , update the job status and save it back to the MongoDB, which creates a change event in the oplog that is picked up by the producer/dispatcher resulting in another message to be queued for that document until the document processing pipeline is finished.

The consumers can be written in non Java languages also using the STOMP protocol (http://stomp.github.io). There are STOMP clients in Perl, Python, Ruby, C/C++).
I suggest providing an API to isolate the consumer developer from message processing for each of the programming language we will support.