Simple developer oriented admin panel for your Apache kafka clusters
Report Bug
·
Request Feature
Kafka Panel is a desktop app for Linux (*) made to manage your Apache Kafka clusters. It is designed to be simple for the use of Software Developers who only need to handle basic operations, like create topic, delete topic, produce a message, etc (check out the Usage section to discover all the features)
* Mac and Windows are not officially supported right now due to some problems in the publish release pipeline but since the project is made with Tauri you can always clone it and build the package for your OS with the command npm ci && npm run tauri build.
To install Kafka Panel you just need to head to the Releases page and download the most recent one.
Here is explained for each page what features it provides and how to use them.
Topics page provides you with a quick overview of the topics, where you can create see a list and delete them. You can also change the connection (configured in Settings page) which will give you access to all the topics that specific user has permissions on.
You might also notice the small dot besides every topic, this is the "topic status" where it can be Consuming meaning that there's a consumer connected to it, Disconnected meaning it has committed offsets to it but is not currently being consumed, and Unconnected which means your topic has no metadata relative to any consumer group. You will also see this pattern in the Groups page
Messages page is where you can see the latest messages your topic has. A maximum of messages can be configured and by default is 20. Of course you can also send messages by starting from blank or selecting one of the already existing messages as starting point.
Message templates have at their disposal the full power of faker.js. To use it you just need to declare a string with double brackets and write any faker.js function you want, for example "{{faker.person.firstName('female')}}". You also can use the values generated in the key object to populate the value object.
Example:
{
"headers": {
"version": "v1.0.0",
"type": "{{faker.helpers.arrayElement(['locked', 'unlocked'])}}"
},
"key": {
"id": "{{faker.string.uuid()}}"
},
"value": {
"id": "{{key.id}}",
"name": "{{faker.person.fullName()}}",
"country": "Italy"
}
}This will result in:
{
"headers": {
"version": "v1.0.0",
"type": "unlocked"
},
"key": {
"id": "4de3d8b0-d680-4b4b-b1de-a4825ff51c50"
},
"value": {
"id": "4de3d8b0-d680-4b4b-b1de-a4825ff51c50",
"name": "Ernestine Connelly",
"country": "Italy"
}
}In Groups page you see the consumer groups connected to your topic with the status indicator that we saw in the Topics page and the lag.
You can also move the offsets forward to skip certain messages, but only when the consumer group is disconnected and of course there's lag.
Messages Storage page is meant to provide you with a local storage of your favorite messages from all the topics and connections. Not only that, it also allows you to send each message to whatever connection and whatever topic you'd like.
Messages can be saved in storage with the little "DB" icon you'll find on each message you've already sent, specifying some tags before saving to make your search easier in the future.
Autosends page lets you configure multiple auto message sending processes where you can specify duration, interval, connection/topic and the message template to send.
Of course, with autosends you can also use the faker.js and key interpolation mechanism and for each message sent by the autosend process the message content will be re-interpolated with new different values.
Last but not least, the settings page lets you configure your connections to your cluster with a simple json.
Example:
[
{
"name": "Localhost",
"brokers": [
"localhost:9092"
]
},
{
"name": "Remote cluster 1",
"brokers": [
"some-long-address-to-the-node-cluster-1:9093",
"some-long-address-to-the-node-cluster-1-broker-2:9093"
],
"auth": {
"username": "Username",
"password": "Password",
"mechanism": "SCRAM-SHA-256"
},
"groupPrefix": "some-prefix-authorized-by-acls"
}
]Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Icons used from Bootstrap icons
Hermes icons created by Freepik - Flaticon