smconvery / kafkafix Goto Github PK

• Motivation
• Features
• Install
• How to Use
• Contribute
• Contributors

KafkaFix is designed to simple and lightweight local Kafka development tool with support for graphical UI for monitoring JMX attributes with Prometheus.

Kafkafix aims to get rid of all configurations on the user's end to simplify the process and offer better user experience. Users simply have to fire up the application with their docker compose file. Then, everything is good to go.

Users are able to fully manage their local Kafka instance and perform any operations, such as, create topics, start consumers and producers, visualize streams of data, manage errors.

Just visit https://wwww.kafkafix.com and download and install.

1. Start all containers by selecting your docker-compose.yml file.
2. Provide a local port number and click Connect

1. Click Disconnect button and all containers will be stopped.

1. To visualize metrics, click the side panel and then click Metrics
2. Here you will have an options to see all possible JMX metrics
3. Click on any of the metrics and you will be able to see visual representation of data for that metric.

1. All failures incurred by Kafka will be saved locally.
2. Click on the side panel for full history or error logs or click on top right notification panel for most recent error logs.

1. To visualize all streams of data consumed by the conusmer go to right panel and click on the Visualize Streams button.
2. All data will be update in real time.

1. To create a topic, click on the Create Topic button
2. Pass in the topic name and the Number of Partitions you like for the topic to have.

1. To start a producer, click on the Start Producer button
2. Provide name of the topic you would like producer to
3. Kafkafix will start producing to that topic

1. To start a consumer, click on the Start Consumer button
2. Provide a topic name and a group id.
3. Once it's created, consumer will start consuming messages for the specified topic.

1. Simply click on the Delete button next to the topic name.

1. Click on Create a Paritition button.
2. Then pass in a number of partitions to be added for the topic.

1. Before opening a PR for major additions or changes, please test on your local development. This way, it will save overall time spent and allow for faster implementation by maintainers.
2. Conside whether your changes are useful for all users.
3. Avoid breaking changes unless there is an upcoming major release, which are infrequent. We encourage people to care a lot about backwards compatibility.