aidenblinn / kaffia

Kafka visualization and deployment app

Intuitive, customizable Kafka cluster metrics

Product Website »

---

Table of Contents 🗺️

• About Kaffia
• Features
• Getting Started
• Contributors
  • Become a contributor
• License

---

About Kaffia 📙

Apache Kafka is one of the most widely used stream-processing platforms, yet it lacks a free, easy-to-use GUI to monitor key Kafka cluster metrics. Without a comprehensive monitoring tool, the barrier to entry of Apache Kafka remains high, and engineers working with Kafka clusters may miss key issues as they come up.

That's why we created Kaffia. Kaffia is an open-source, intuitive GUI for Kafka clusters that allows you to tailor Kafka cluster monitoring to your needs and experience level. All you have to do is finish some quick setup, launch the app, input your monitoring and Kafka broker preferences, and let Kaffia handle the rest!

Read on to see some of our core features and learn how you can get Kaffia up and running on your machine.

---

Core Features 😊

Easy setup ✅

• Easily configure your Kafka cluster broker count, monitor certain metrics, and sign up for email alerts
• One button launches your cluster, metrics scrapers, visualization service, and alert manager—automatically!

Comprehensive visualization 🔎

• View key Kafka metrics (broker count, throughput, topic size, etc.)
• Live updates as you produce to and consume from your cluster
• Intuitive GUI to make parsing complex data less cumbersome

Quickly launch and stop your cluster ⚡️

• Containerize your cluster in Docker Desktop with the click of a button
• Easily shut down your cluster from the Kaffia dashboard

---

Getting Started with Kaffia ⬆️

Kaffia automates cluster configuration and launching by creating a Docker application that containerizes everything from Zookeeper to the metrics scraper. Make sure you have Docker Desktop up and running before you launch Kaffia.

To get started, fork our repository and clone it to your local machine. To install all dependencies, run the following:

npm install

After the dependencies install, you're good to go! Just spin up the app by running this command inside of the Kaffia directory:

npm start

Once Kaffia is up and running, configuring and monitoring your cluster is simple! Just choose your broker count and metrics from the launch screen, hit submit, and watch your cluster launch automatically in Docker Desktop!

After the cluster launches, you'll be able to navigate throughout the app and view different key metrics that will help you monitor your cluster's health without having to do any setup on your end. Enjoy!

---

Contributors 👋

• Liz Blackledge
• Aiden Blinn
• Ritchie Cervantes
• Jonathan Oh

Contribute to Kaffia 💪

We welcome any and all contributions to Kaffia! You can reach out to one of us on LinkedIn if you have any ideas, or you can fork the repository, make some changes, and submit a pull request.

---

License 🧐

MIT License