https://github.com/oslabs-beta/kafkaview
KafkaView is an open-source Kafka visualizer and data monitoring tool designed to simplify the Kafka ecosystem for developers.
https://github.com/oslabs-beta/kafkaview
css docker docker-compose eslint express html javascript jmx-exporter kafkaview node prometheus react webpack
Last synced: 28 days ago
JSON representation
KafkaView is an open-source Kafka visualizer and data monitoring tool designed to simplify the Kafka ecosystem for developers.
- Host: GitHub
- URL: https://github.com/oslabs-beta/kafkaview
- Owner: oslabs-beta
- License: mit
- Created: 2024-01-16T19:08:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-08T18:23:48.000Z (over 1 year ago)
- Last Synced: 2025-04-08T10:53:18.606Z (about 2 months ago)
- Topics: css, docker, docker-compose, eslint, express, html, javascript, jmx-exporter, kafkaview, node, prometheus, react, webpack
- Language: JavaScript
- Homepage: https://kafkaview.com
- Size: 80.3 MB
- Stars: 45
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KafkaView - Kafka Visualizer and Data Monitoring Tool
## About
Welcome to KafkaView, the open-source tool designed to simplify the Kafka ecosystem for developers and data engineers. Kafka, renowned for its powerful event streaming capabilities, often presents a steep learning curve due to its complex data flow and lack of intuitive monitoring interfaces. KafkaView is here to change that. Visit our website here [KafkaView.com](https://www.kafkaview.com)
## Table of Contents
- [KafkaView - Kafka Visualizer and Data Monitoring Tool](#kafkaview---kafka-visualizer-and-data-monitoring-tool)
- [About](#about)
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Installation](#installation)
- [Roadmap](#roadmap)
- [Contact](#contact)
- [License](#license)
## Description
KafkaView is an intuitive monitoring tool designed to simplify the complexity of Apache Kafka, one of the most potent and prevalent event streaming platforms. Despite Kafka's widespread use, its intricate data flow and ecosystem can be challenging to grasp, and the platform traditionally lacks a user-friendly interface for monitoring. This often makes onboarding a daunting task for new users.
With KafkaView, users gain access to real-time updates that offer a clear view of crucial metrics for Kafka cluster management. This includes visualizing the rate at which data is produced to brokers and tracking the volume of messages across various topics. KafkaView aims to demystify Kafka's operations, presenting a more approachable structure for your Kafka projects.
Especially beneficial for newcomers, KafkaView features a dedicated informational section. This segment provides a detailed overview of the Kafka ecosystem, complete with easy-to-understand descriptions of its components. By making Kafka's inner workings more transparent, KafkaView facilitates a smoother learning curve and enhances the monitoring experience for users at all levels of experience.
## Installation
1. Clone our repository to your local machine by typing the following command into your terminal:
```
git clone https://github.com/oslabs-beta/KafkaView.git
```
2. Open the repo with your favorite IDE. Once complete install the dependencies for our application by typing into your terminal:
- **npm install**
Then type the following command to start the server:
- **npm start**
> [!NOTE]
> Our application should automatically open a web browser window with our home page. You should also see a confirmation message in your terminal that the server has started. If you are encountering an issue here, check if you typed 'npm install' or verify your current repository is correct. Once you have verified everything installed correctly and the server is running, navigate to our home page by clicking this link: [localhost:8080](locahost:8080)
3. Add your Prometheus server by typing in the ip address and exposed port of your server.
> [!NOTE]
> If you would like to demo KafkaView without a prometheus-configured kafka cluster, open kafka-metrics folder and follow steps in the Readme.txt to use our provided setup.
4. Congrats! You can now explore the Kafka ecosystem! You will find a variety of metrics right at your fingertips, including live updates on under-replicated partitions and the total count of messages being transmitted. You can navigate to other metrics by clicking the links at the top of the page.
5. If you would like to learn more about the kafka ecosystem, click on the Kafka Information page. Enjoy!
## Roadmap
- Expand range of metrics. If you would like to see something missing, consider contributing to the project.
- Alert system that send a message to users when a metric reaches a critical threshold
- Expand support for other Kafka controller systems
- Containerize entire project
## Contact
Byrce Kelly
Chris Johnson
Joseph Dafesh
Sean Nguyen
## License
By contributing, you are agreeing that your contributions will be licensed under the [MIT License](/LICENSE).