kafka-healthcheck

A simple healthcheck wrapper to monitor Kafka.

Kafka Healthcheck is a simple server that provides a singular API endpoint to determine the health of a Kafka instance. This can be used to alert or take action on unhealthy Kafka instances.

The service checks the health by sending kafkacat about that kafkacat

This project is a copy "devshawn" whit modifications for use kafkacat

Usage

Kafka Healthcheck can be installed via pip. Both python and pip are required, as well as kafkacat.

Command-Line

Install kafka-healthcheck via pip:

pip install kafka-healthcheck

To start the healthcheck server, run:

kafka-healthcheck

The server will now be running on localhost:9290.

Configuration

Kafka Healthcheck can be configured via command-line arguments or by environment variables.

Port

The port for the kafka-healthcheck API.

Kafka Host

The host of the Kafka instance to run the health check against. This is used with kafkacat.

Kafka Port

The port of the Kafka instance to run the health check against. This is used with kafkacat.

Log Level

The level of logs to be shown by the application.

All healthy responses are logged at DEBUG. Unhealthy responses are logged at WARNING. Any unexpected errors are logged at ERROR.

License

Copyright (c) 2019 Shawn Seymour.

Extended Copyright (c) 2022 Rodrigo Garcia.

Licensed under the Apache 2.0 license.