Skip to content
This repository has been archived by the owner on Jun 16, 2022. It is now read-only.
/ silk-engine Public archive

Simple library for event processing with Kafka. Built on top of KafkaJS and inspired by Robinhood's Faust. Will be moved to Scala soon.

License

Notifications You must be signed in to change notification settings

jon-esperanza/silk-engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Silk Engine

Simple library for event processing with Kafka.
Built on top of KafkaJS and inspired by Robinhood's Faust

Project vision

Flexible
Freedom of creating multiple Silk Engines and subscribing to as many topics as needed.

Read optimized
Designed to perform complex read queries, and is not designed to execute writes and updates to databases.

Single instance
No need to distribute the preparation and execution of asynchronous jobs. This event processing engine assumes both roles.

Precomputed
Contents of cache can be computed before it is needed.

Clever caching
Executed queries are cached so that reads from this engine are served quickly. We have default in-memory key/value store but users can also integrate a redis configuration.

Fresh data
Event-driven architecture allows the data in our cache to remain fresh and consistently synchronized as the data changes.

Desired use cases

  • Event processing
  • Distributed joins & aggregations
  • Asynchronous job execution
  • Data denormalization
  • Distributed computing

Key highlights

Event process pipeline
Silk Engine is a great way to coordinate and execute event-driven jobs. The way our system works is like this:

flowchart LR;
MessageData --> Merchant
Job --> Merchant
Merchant --> EventType
EventType --> Topic
Loading

As we can see, a Merchant should always be fixed to a specific message event in the Kafka topic (i.e OrderPlaced, OrderDelivered). This structure allows a consistent serialization of messages with Silk Engine and distributed processing of message events. We shouldn't be using a model meant for placed orders on messages about delivered orders.

While we encourage good practice by having different topics per message event type, we understand sometimes it works best to keep them all in a single topic so we simply assist with the filtering and parsing of your event messages.

This atomicity is enforced by either validating the Kafka message header attribute event-type or the message key to the event parameter passed into the Merchant.
This makes sure that we DO NOT use the single user-defined MessageData to serialize several different types of messages from a kafka topic.

Centralized Message Data
Silk Engine takes your data model to serialize the messages consumed by using a single instance of the data model provided. This greatly resembles the Singleton pattern. The single instance is used to store valid serialized message data and wipe all data after Merchant job execution for easy reuse. This simulates an in-memory cache with cache invalidation for each Merchant to use as they prepare, execute, and cleanup a job.

This single instance works well with our system because they are assigned one per merchant and one merchant per message event (as mentioned earlier: ensures consistent serialization of messages), another thing that allows this single instance to thrive is the sequential events from Kafka that mitigate any race conditions on our data object. Our CentralizedSingleInstance type defines how our data objects work.

export type CentralizedSingleInstance = {
  [keys: string]: any;

  /**
   * Helps ensure that this single instance is cleared and ready for the next message serialization.
   */
  clearInstance(): void;
  /**
   * Helps ensure that the message serialization was successful.
   * @returns boolean
   */
  validInstance(): boolean;
};

This single instance data object for each merchant has many advantages to our engine:

  • Absolute control over the data flow coming from messages.
  • Centralized cache with easy access.
  • Lightweight and optimized performance for job storage as creating multiple instances of your data model for each message recieved could be costly.

Benchmarks

This is the estimated performance overhead for some of Silk Engine's processes and workflow.

Event Message Processing (Single Merchant): 0.018ms

Event Message Processing (Multiple Merchants: 5): 0.042ms

About

Simple library for event processing with Kafka. Built on top of KafkaJS and inspired by Robinhood's Faust. Will be moved to Scala soon.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published