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.
| Usage | Value |
|---|---|
| Environment Variable | HEALTHCHECK_PORT |
| Command-Line Argument | --port |
| Default Value | 9290 |
Kafka Host
The host of the Kafka instance to run the health check against. This is used with kafkacat.
| Usage | Value |
|---|---|
| Environment Variable | HEALTHCHECK_KAFKA_HOST |
| Command-Line Argument | --kafka-host |
| Default Value | localhost |
Kafka Port
The port of the Kafka instance to run the health check against. This is used with kafkacat.
| Usage | Value |
|---|---|
| Environment Variable | HEALTHCHECK_KAFKA_PORT |
| Command-Line Argument | --kafka-port |
| Default Value | 9092 |
Log Level
The level of logs to be shown by the application.
| Usage | Value |
|---|---|
| Environment Variable | HEALTHCHECK_LOG_LEVEL |
| Command-Line Argument | --log-level |
| Default Value | INFO |
| Valid Values | DEBUG, INFO, WARNING, ERROR |
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.
86 Dec 29, 2022
1 Dec 22, 2021
1 Dec 5, 2021
1 Apr 24, 2022
2 Feb 3, 2022
1 Feb 12, 2022
789 Dec 26, 2022
157 Dec 28, 2022
370 Dec 22, 2022
60 Jan 03, 2023
1 Oct 13, 2021
0 Nov 11, 2021
57 Dec 12, 2022
24 Sep 29, 2022
6 Feb 13, 2022
11 Nov 11, 2022
76 Dec 31, 2022
60 Nov 21, 2022
2 Nov 18, 2021
2 Mar 10, 2022
1 Jan 19, 2022
45 May 23, 2022
73 Dec 30, 2022
2 Jun 10, 2022
269 Dec 23, 2022
37 Nov 24, 2022
1 Dec 22, 2021
93 Dec 27, 2022
6 Mar 26, 2022