https://github.com/epam/eco-kafka-manager
https://github.com/epam/eco-kafka-manager
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/epam/eco-kafka-manager
- Owner: epam
- License: apache-2.0
- Created: 2019-10-21T11:05:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-09-17T13:43:22.000Z (10 months ago)
- Last Synced: 2025-09-17T15:33:32.076Z (10 months ago)
- Language: Java
- Size: 18.6 MB
- Stars: 31
- Watchers: 9
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eco Kafka Manager
Eco Kafka Manager is a tool for monitoring and managing [Apache Kafka](https://kafka.apache.org/).
The currently supported version is [3.0](https://kafka.apache.org/30/documentation.html)
The currently supported java version 17.
## Features
* Inspect Kafka resources (brokers, topics, consumers, permissions, transactions)
* Create/update/delete/purge topic
* Reset consumer group offsets
* Consumer group lag
* Add description to resources
* Export resources
* Topic/consumer offset RPM (Rate Per Minute)
* Topic browser to read messages in different formats
* Authorization
* REST API & client
* User-Defined metrics
## Project structure
The repository contains the following packages:
* [commons](/commons) - common models, utilities, extensions, etc
* [core](/core) - core services to manage Kafka resources
* [udmetrics](/udmetrics) - service to manage User-Defined metrics
* [rest](/rest) - RESTful interface
* [client](/client) - REST client
* [ui](/ui) - web UI
## Building artifacts
To build artifacts, run the following command sequence:
```
git clone git@github.com:epam/eco-kafka-manager.git
cd eco-kafka-manager
mvn clean package
```
To skip tests, JavaDocs, and static code analysis, run:
```
mvn clean package -PpackageOnly
```
## Quick start
The prerequisites for the quick start include:
* [Docker](https://www.docker.com/get-started)
* [Docker Compose](https://docs.docker.com/compose/install/)
### Installation to connect to an existing Apache Kafka
The installation consists of one service:
* Eco Kafka Manager UI
Note: Specify suitable value for `KAFKA_SERVERS_URL`.
For Linux, run the following command sequence:
```
git clone git@github.com:epam/eco-kafka-manager.git
cd eco-kafka-manager
export KAFKA_SERVERS_URL="kafka:9092"
docker-compose -f docker/docker-compose.yaml up
```
For Windows (Powershell), run the following command sequence:
```
git clone git@github.com:epam/eco-kafka-manager.git
cd eco-kafka-manager
$env:KAFKA_SERVERS_URL="kafka:9092"
docker-compose -f docker/docker-compose.yaml up
```
To open Eco Kafka Manager UI web interface, go to [http://localhost:8082](http://localhost:8082)
To stop all services, run:
```
docker-compose -f docker/docker-compose.yaml down
```
### All-in-one installation
The installation consists of:
* Zookeeper
* Kafka
* Eco Kafka Manager UI
Run the following command sequence:
```
git clone git@github.com:epam/eco-kafka-manager.git
cd eco-kafka-manager
docker-compose -f docker/docker-compose-all.yaml up
```
To open Eco Kafka Manager UI web interface, go to [http://localhost:8082](http://localhost:8082)
To stop all services, run:
```
docker-compose -f docker/docker-compose-all.yaml down
```
## Compatibility matrix
Eco Kafka Manager | Kafka | Java
--- |-------|------|
3.0.0 | 3.0.x | 17 |
2.0.x | 3.0.x | 11 |
1.4.x | 2.4.x | 8 |
1.3.x | 2.3.x | 8 |
1.2.x | 2.2.x | 8 |
1.1.x | 2.1.x | 8 |
1.0.x | 2.0.x | 8 |
0.1.x | 1.0.x | 8 |
## License
Eco Kafka Manager is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)