Fundamentals

Components

Header

Header.
Every diagram should have a title, date and version. (Also see Architecture Diagram - Best Practices)

Topology

The topology in Kafka Streams represents the logical abstraction layer that defines the data flow and processing logic between streams and state stores in a stream processing application.

It's the outer most building block for your application and one of the library components you begin your design with.

Sub-Topology

A sub-topology is an isolated section of a Kafka Streams topology that processes data independently from other parts, typically due to repartitioning or multiple input topics.

Legend Portrait/Landscape

Diagram Legend.

Basic key/legend that descibes the notation defined by KSTD.

Includes a block of 4 shapes used by the Kafka Streams DSL Operators.

Further KSTD destinguishes between two arrow types:

1. The solid line arrow shows the data flow through the stream procesing topology.
2. For everything else (e.g. IQ, RPC, or other access patterns), a dashed line arrow is used.

Then there's the representation used for topics and state stores.

Last but not least a reference and link to the KSTD docs.

KSTD Watermark

Watermark and link to the website
Spread the word, support KSTD! 🦦 ❤️