kafkAlerts

Open source, usability driven web application for monitoring and alerting Apache Kafka® broker metrics

---

Table of Contents

• Product Description
• Install and Run
• Install Locally
• How to Use
• Contribute
• Our Team
• License

---

Product Description

With usability and accessibility at the forefront of all our design decisions, kafkAlerts offers a better way to visualize Kafka broker metrics and receive alerts. Only the most relevant data renders on the screen, including what brokers are alerting and appropriate metrics for those brokers.

All other brokers will be listed in your feed and can be expanded to view metrics with the click or press of a button.

---

Install and Run

To begin using kafkAlerts, navigate to kafkalerts.com and create an account.

• Make sure that Prometheus is running and connected to your cluster.
• Click on the user menu icon in the top right.
• Click on 'Connect Cluster'.
• Input your Prometheus instance and broker ids.

Install Locally

If you would prefer to run kafkAlerts locally, you may fork and clone our Github repository.

• In your terminal run:
  • npm install
  • npm run dev
• Once the application is running, navigate to localhost:3000 and input the port of your Prometheus server and brokers you would like to monitor.

---

How to Use

Once you have successfully installed kafkAlerts and connected to your cluster, simply log in to view all of your brokers in one place.

• If any brokers are alerting, you will see them listed by id in your alerts menu.
• Click on that id to be taken directly to the alerting broker. Here you can find metrics that may indicate where there is an issue.
• Click on non-alerting brokers to view their metrics and see how they are generally performing.
• To add more brokers, simply go to the user menu at the top, click on 'Connect Cluster' and add any additional broker ids.

---

Contribute

If you would like to contribute to this product by improving current functionality or adding a feature, please fork the repository and submit a pull request.

Some of our planned features for kafkAlerts include:

• Additional testing
• Custom metrics
• User defined accessibility templates
• Adding OAuth authentication
• Alerting based on user defined SLIs
• Expanding metric insights

---

Our Team

Questions, comments, concerns... funny memes? Reach out to us any time!

Hazel Bolivar

Ian Flynn

Krystal Fung

Annie Rosen

Jeb Stone

---

License

MIT Licensed