README.md

Kafka streams visualization

This small application allows you to simply create a graph image from a Kafka Streams Ascii topology.

It was heavily inspired by

• https://github.com/zz85/kafka-streams-viz
• Work from danielpetisme on Quarkus dev module for Kafka Streams

I wanted to have something more clean that the rough images of zz85/kafka-streams-viz and I also wanted to have a standalone application as not everyone is using Quarkus

Live version

This app is deployed using github pages: https://gaetancollaud.github.io/kafka-streams-visualization/

How to use

Simply use Toplogy.describe() from Kafka Streams to get the Topology in Ascii format and put the output in the form

Topology myTopology = new StreamsBuilder()
  // yourTopologyHere()
  .build();
System.out.println(myTopology.describe()); // put this output in the form

Features

• Render to SVG
• Render to Canvas (to allow copy/paste of the image)
• Topology stored in the URL (for easy exchange)
• Download images

Under the hood

• Mermaid.js
• Angular
• Angular Material