You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-12Lines changed: 27 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,25 @@ In summary, consumer lag tells us 2 things:
23
23
24
24
### Supported Kafka Versions
25
25
Since this client uses Kafka Admin Client and Kafka Consumer client version of *2+*, therefore this client supportes Kafka brokders from version **0.10.2+**.
26
+
27
+
## Features
28
+
* Rich metrics that show detailed consumer lags on both level, on the consumer group level and on the consumer member level for more granularity.
29
+
* Metrics are available for both, console and Prometheus.
30
+
* Ready to use thin Docker image for your cloud deployments such as Kubernetes.
31
+
* The tool is also available as maven package in case you want to embedded it into your application.
32
+
33
+
## Changelog
34
+
#### 0.0.8:
35
+
- Issue #23: Extend Lag stats on consumer member level.
36
+
- Issue #20: Support consumer group and topic deletion on the fly.
37
+
- Issue #21: Change default port to 9739
38
+
#### 0.0.7:
39
+
- Issue #17: Now this client will show newly joined consumer groups as well **without the need to restart the client**. You should start it once and it will always refresh the consumer groups list according to the poll interval.
40
+
- Kafka client updated to version 2.5.0.
41
+
42
+
#### 0.0.6:
43
+
- Issue #8: Support configuration file as parameter
44
+
- Kafka client updated to version 2.4.1.
26
45
27
46
## Installation and Usage
28
47
#### Uber JAR
@@ -48,16 +67,6 @@ You can use placeholders in the arg command and fill these settings by environme
- Issue #17: Now this client will show newly joined consumer groups as well **without the need to restart the client**. You should start it once and it will always refresh the consumer groups list according to the poll interval.
54
-
- Kafka client updated to version 2.5.0.
55
-
56
-
#### 0.0.6:
57
-
- Issue #8: Support configuration file as parameter
The total lag of a consumer group behind the head of a topic. This gives the total lags from all partitions over each topic, it provides good visibility but not a precise measurement since is not partition aware.
The lag of a consumer member within consumer group behind the head of a given partition of a topic.
171
+
157
172
## Usage as Library
158
173
If you want to use this client embedded into your application, you can achieve that by adding a [dependency](https://bintray.com/omarsmak/kafka/consumer-lag-monitoring) to this tool in your `pom.xml` or `gradle.build` as explained below:
159
174
#### Maven
@@ -171,7 +186,7 @@ and under `<dependencies>..</dependencies>`:
.help("The total lag of a consumer group member behind the head of a topic. This gives the total lags over each consumer member within consumer group")
0 commit comments