KMinion (previously known as Kafka Minion) is a feature-rich and flexible Prometheus Exporter to monitor your Apache Kafka cluster. All valuable information that are accessible via the Kafka protocol are supposed to be accessible using KMinion.
You can find a list of all exported metrics here: /docs/metrics.md
All images will be built on each push to master or for every new release. You can find an overview of all available tags in our quay.io repository.
docker pull quay.io/cloudhut/kminion:master
A Helm chart will be maintained as part of this repository under /charts.
All options in KMinion can be configured via YAML or environment variables. Configuring some options via YAML and some via environment variables is also possible. Environment variables take precedence in this case. You can find the reference config with additional documentation in /docs/reference-config.yaml.
If you want to use a YAML config file, specify the path to the config file by setting the env variable
I uploaded three separate Grafana dashboards that can be used as inspiration in order to create your own dashboards. Please take note that these dashboards might not immediately work for you due to different labeling in your Prometheus config.
Cluster Dashboard: https://grafana.com/grafana/dashboards/14012
Consumer Group Dashboard: https://grafana.com/grafana/dashboards/14014
Topic Dashboard: https://grafana.com/grafana/dashboards/14013
This repo contains a docker-compose file that you can run on your machine. It will spin up a Kafka & ZooKeeper cluster and starts KMinion on port 8080 which is exposed to your host machine:
# 1. Clone this repo # 2. Browse to the repo's root directory and run: docker-compose up
We use Discord to communicate. If you are looking for more interactive discussions or support, you are invited to join our Discord server: https://discord.gg/KQj7P6v
KMinion is distributed under the MIT License.