Git Product home page Git Product logo

kafka-sprout's Introduction

Kafka Cluster Management UI Tool

δΈ­ζ–‡ | English

About

Kafka Sprout is a web GUI that helps you quickly start up Zookeeper and Kafka servers on your local machine without any code configuration. Easily view, manage, and configure your Kafka topics and brokers with a push of a button. Kafka Sprout also displays relevant realtime metrics including Request Rate, Network I/O Rate, etc. Give it a spin and let us know what features you want next!


πŸ‘‹ Goodbye Clunky Terminal Windows, Hello Web GUI

Start Cluster

Configure and Start Brokers

View, Add, and Delete Topics

Features

πŸš€ Push to Start Zookeeper and Kafka Server

βž• Quickly Add and Delete Topics

πŸ’ͺ Setup Kafka Brokers with Ease

🚦 Monitor Key Performance Metrics

πŸ”Ž Explore Topic and Broker Configurations


Getting Started

Installation

  1. Clone this repo:
git clone https://github.com/oslabs-beta/Kafka-Sprout.git
  1. Run the application in the root folder. This will also install node locally to build the frontend.
mvn spring-boot:run # for Mac
./mvnw spring-boot:run # for Windows
  1. Go to http://localhost:8080/ on your browser.

Set Up

Requirements

  • Java (version 11 or newer)
  • Maven (version 3.6.3 or newer)
  • Kafka (version 0.11.0 or newer)
  • Node.js (version 12.18.3 or newer)

Built With

Spring Boot | Spring Web Socket | Styled Components | React | Typescript | Apache Kafka

Contributors

Brian Hong | Midori Yang | Nak Kim | Nicole Ip | Winford Lin

Contributions Welcome!

If you found this interesting or helpful at all, feel free to drop a ⭐ GitHub stars ⭐ on this project to show your support!

You can contribute by:

  • Raising any issues you find using Kafka Sprout
  • Fixing issues by opening Pull Requests
  • Improving documentation

All bugs, tasks or enhancements are tracked as GitHub issues. Issues which might be a good start for new contributors are marked with "good-start" label.

If you want to get in touch with us first before contributing, shoot us an email at [email protected]. Kafka Sprout is actively maintained!

License

MIT

kafka-sprout's People

Contributors

ghdgnsvy avatar myang5 avatar nicole-ip avatar nydkim avatar winfordlin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

kafka-sprout's Issues

Add feature for starting "inactive" brokers

Check existing properties files and data folders to see what files already exist and display them as "inactive" brokers that can be spun up

  • Would need to make sure an inactive broker has both corresponding properties file and data folder via the ID

Add functionality to refresh cluster status

If for some reason a user starts up a broker outside of the web client, they should be able to make a new GET request to the backend to update the broker list in the client.

Check Zookeeper status on windows

Kafka installed on MacOS with homebrew seems to automatically install a zkServer.sh script that can be used to check if the Zookeeper server is online, but no equivalent file is included with Windows installation.

Add functionality to safely close broker

  • Force killing a broker causes Zookeeper to throw an error later because the ephemeral node connection was not properly shut down, as described here and here.

  • Find the programmatic equivalent of pressing Ctrl + C in a terminal window

"Delete topic" for windows

Kafka's native Admin API does not support topic deletion on Windows machine. two options:

  1. wait until Kafka supports the feature for Windows
  2. manually delete log folder if it can be done safely without any side effects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.