Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve metrics description in README #473

Merged
merged 2 commits into from
Feb 12, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 56 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Kafka exporter for Prometheus. For other metrics from Kafka, have a look at the
Table of Contents
-----------------

- [Compatibility](#compatibility)
- [Dependency](#dependency)
- [Download](#download)
- [Compile](#compile)
- [Build Binary](#build-binary)
- [Build Docker Image](#build-docker-image)
- [Run](#run)
- [Run Binary](#run-binary)
- [Run Docker Image](#run-docker-image)
- - [Run Docker Compose](#run-docker-compose)
- [Flags](#flags)
- [Notes](#notes)
- [Metrics](#metrics)
- [Brokers](#brokers)
- [Topics](#topics)
- [Consumer Groups](#consumer-groups)
- [Grafana Dashboard](#grafana-dashboard)
- [Contribute](#contribute)
- [Donation](#donation)
- [License](#license)
- [Compatibility](#compatibility)
- [Dependency](#dependency)
- [Download](#download)
- [Compile](#compile)
- [Build Binary](#build-binary)
- [Build Docker Image](#build-docker-image)
- [Run](#run)
- [Run Binary](#run-binary)
- [Run Docker Image](#run-docker-image)
- [Run Docker Compose](#run-docker-compose)
- [Flags](#flags)
- [Notes](#notes)
- [Metrics](#metrics)
- [Brokers](#brokers)
- [Topics](#topics)
- [Consumer Groups](#consumer-groups)
- [Grafana Dashboard](#grafana-dashboard)
- [Contribute](#contribute)
- [Donation](#donation)
- [License](#license)

Compatibility
-------------
Expand All @@ -39,9 +39,9 @@ Support [Apache Kafka](https://kafka.apache.org) version 0.10.1.0 (and later).
Dependency
----------

- [Prometheus](https://prometheus.io)
- [Sarama](https://shopify.github.io/sarama)
- [Golang](https://golang.org)
- [Prometheus](https://prometheus.io)
- [Sarama](https://shopify.github.io/sarama)
- [Golang](https://golang.org)

Download
--------
Expand Down Expand Up @@ -169,20 +169,30 @@ For details on the underlying metrics please see [Apache Kafka](https://kafka.ap

**Metrics details**

| Name | Exposed informations |
|-----------------|----------------------------------------|
| `kafka_brokers` | Number of Brokers in the Kafka Cluster |
| Name | Exposed informations |
|---------------------|----------------------------------------|
| `kafka_brokers` | Number of Brokers in the Kafka Cluster |
| `kafka_broker_info` | Information about the Kafka Broker |

**Metrics output example**

```txt
# HELP kafka_brokers Number of Brokers in the Kafka Cluster.
# TYPE kafka_brokers gauge
kafka_brokers 3
# HELP kafka_broker_info Information about the Kafka Broker.
# TYPE kafka_broker_info gauge
kafka_broker_info{address="b-1.kafka-example.org:9092",id="1"} 1
kafka_broker_info{address="b-2.kafka-example.org:9092",id="2"} 2
kafka_broker_info{address="b-3.kafka-example.org:9092",id="3"} 3
```

### Topics

**Required permissions**

Describe all topics.

**Metrics details**

| Name | Exposed informations |
Expand Down Expand Up @@ -234,13 +244,20 @@ kafka_topic_partition_under_replicated_partition{partition="0",topic="__consumer

### Consumer Groups

**Required permissions**

Describe all groups.

**Metrics details**

| Name | Exposed informations |
|----------------------------------------------|--------------------------------------------------------------------------|
| `kafka_consumergroup_current_offset` | Current Offset of a ConsumerGroup at Topic/Partition |
| `kafka_consumergroup_current_offset_sum` | Current Offset of a ConsumerGroup at Topic for all partitions |
| `kafka_consumergroup_lag` | Current Approximate Lag of a ConsumerGroup at Topic/Partition |
| `kafka_consumergroup_lag_sum` | Current Approximate Lag of a ConsumerGroup at Topic for all partitions |
| `kafka_consumergroupzookeeper_lag_zookeeper` | Current Approximate Lag(zookeeper) of a ConsumerGroup at Topic/Partition |
| `kafka_consumergroup_members` | Amount of members in a consumer group |

#### Important Note

Expand All @@ -256,9 +273,22 @@ To be able to collect the metrics `kafka_consumergroupzookeeper_lag_zookeeper`,
# TYPE kafka_consumergroup_current_offset gauge
kafka_consumergroup_current_offset{consumergroup="KMOffsetCache-kafka-manager-3806276532-ml44w",partition="0",topic="__consumer_offsets"} -1

# HELP kafka_consumergroup_current_offset_sum Current Offset of a ConsumerGroup at Topic for all partitions
# TYPE kafka_consumergroup_current_offset_sum gauge
kafka_consumergroup_current_offset_sum{consumergroup="KMOffsetCache-kafka-manager-3806276532-ml44w",topic="__consumer_offsets"} -1

# HELP kafka_consumergroup_lag Current Approximate Lag of a ConsumerGroup at Topic/Partition
# TYPE kafka_consumergroup_lag gauge
kafka_consumergroup_lag{consumergroup="KMOffsetCache-kafka-manager-3806276532-ml44w",partition="0",topic="__consumer_offsets"} 1

# HELP kafka_consumergroup_lag_sum Current Approximate Lag of a ConsumerGroup at Topic for all partitions
# TYPE kafka_consumergroup_lag_sum gauge
kafka_consumergroup_lag_sum{consumergroup="KMOffsetCache-kafka-manager-3806276532-ml44w",topic="__consumer_offsets"} 1

# HELP kafka_consumergroup_members Amount of members in a consumer group
# TYPE kafka_consumergroup_members gauge
kafka_consumergroup_members{consumergroup="KMOffsetCache-kafka-manager-3806276532-ml44w"} 1

```

Grafana Dashboard
Expand Down
Loading