An open source monitoring tool for the Apache Kafka Ecosystem

Table of Contents

• Key Features
• Walkthrough
• Setup
• The Development Team

Key Features

• Intuitive Kafka ecosystem overview
• Critical cluster health and network metrics - with alerts for critical failures
• Graphical display of performance metrics for Brokers, Producers, and Consumers

Walkthrough

Enter the Prometheus port where your Kafka Instance is located

Upon successful connection, critical information about your ecosystem, producers, consumers, and brokers becomes available

Setup

1. KafMira requires an Apache Kafka instance connected to Prometheus, via a JMX Exporter
2. To allow Consumer and Producer metrics to display properly, please ensure that your prometheus.yml targets are setup using the following parameters:
   • Producers to be monitored are labeled with job_name : 'producer'
   • Consumers to be monitored are labeled with job_name : 'consumer'
3. To download our desktop application, navigate to our website and download the appropriate file for your OS.
   • If you are using the desktop application, you may need to configure your privacy or security settings to allow the application to open without being verified
     • On Mac, after installation, run the command sudo xattr -cr /Applications/KafMira.app to allow the app to run
   • Alternatively, you can also clone the repository directly from GitHub and run these commands in your terminal: - npm install - npm run watch - npm run start
4. Enter your Prometheus port number for KafMira to verify the port connection
5. Navigate through the various displays
6. Should you wish to disconnect or enter another port, use the 'Disconnect' option

The KafMira Development Team

Robert Koulakes | Nicholaos Sofocleous | Nicholas Suzuki | Gibran Haq

Please visit our website for more information and installation options.

Our thanks...

Please feel free to fork, clone, to contribute and help KafMira grow! Remember to leave a star if you'd like to support our work!

- the KafMira Team