lechindianer/kafkaex-lag-exporter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Format README

Browse Source
This commit is contained in:
Pascal Schmid
2024-04-16 08:09:41 +02:00
parent 0016cd0f74
commit c98e8da2ec
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,30 +1,34 @@
# KafkaexLagExporter # KafkaExLagExporter
This project will collect Kafka consumer lag and provide them via Prometheus. This project will collect Kafka consumer lag and provide them via Prometheus.
## Metrics ## Metrics
[Prometheus](https://prometheus.io/) is a standard way to represent metrics in a modern cross-platform manner. KafkaexLagExporter exposes several metrics as an HTTP endpoint that can be readily scraped by Prometheus. [Prometheus](https://prometheus.io/) is a standard way to represent metrics in a modern cross-platform manner.
KafkaExLagExporter exposes several metrics as an HTTP endpoint that can be readily scraped by Prometheus.
**`kafka_consumergroup_group_topic_sum_lag`** **`kafka_consumergroup_group_topic_sum_lag`**
Labels: `cluster_name, group, topic, consumer_id, member_host` Labels: `cluster_name, group, topic, consumer_id, member_host`
The sum of the difference between the last produced offset and the last consumed offset of all partitions in this topic for this group. The sum of the difference between the last produced offset and the last consumed offset of all partitions in this
topic for this group.
**`kafka_consumergroup_group_lag`** **`kafka_consumergroup_group_lag`**
Labels: `cluster_name, group, partition, topic, member_host, consumer_id` Labels: `cluster_name, group, partition, topic, member_host, consumer_id`
The difference between the last produced offset and the last consumed offset for this partition in this topic partition for this group. The difference between the last produced offset and the last consumed offset for this partition in this topic
partition for this group.
## Start ## Start
```bash ```bash
docker run -ti --net="host" -e KAFKA_BROKERS=localhost:9093,localhost:9094,localhost:9095 lechindianer/kafkaex_lag_exporter:0.2.0 docker run -ti --net="host" -e KAFKA_BROKERS=localhost:9093,localhost:9094,localhost:9095 -p 4000:4000 \
lechindianer/kafkaex_lag_exporter:0.2.0
``` ```
Now you can check the exposed metrics at [localhost:4000](localhost:4000). Now you can check the exposed metrics at [http://localhost:4000](http://localhost:4000).
## Developing ## Developing
@@ -37,11 +41,11 @@ KAFKA_BROKERS="localhost:9092" iex -S mix
There is also a docker-compose file included which will start Kafka, serve Kowl (Web UI for Kafka) and start There is also a docker-compose file included which will start Kafka, serve Kowl (Web UI for Kafka) and start
KafkaexLagExporter: KafkaexLagExporter:
```bash ```bash
docker-compose up --build docker-compose up --build
``` ```
Kowl is served at [localhost:8080](localhost:8080). Kowl is served at [http://localhost:8080](http://localhost:8080).
### Tests ### Tests
@@ -67,4 +71,5 @@ mix dialyzer
Source is on [Gitlab](https://gitlab.com/lechindianer/kafkaex-lag-exporter). Source is on [Gitlab](https://gitlab.com/lechindianer/kafkaex-lag-exporter).
The initial project [Kafka Lag Exporter](https://github.com/seglo/kafka-lag-exporter) was a huge inspiration for me creating my first real Elixir project. Thank you! The initial project [Kafka Lag Exporter](https://github.com/seglo/kafka-lag-exporter) was a huge inspiration for me
creating my first real Elixir project. Thank you!