Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
omarsmak committed May 12, 2020
1 parent 2299b74 commit 6f7b5c1
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ You can use placeholders in the arg command and fill these settings by environme
args: ["-b", "$(BOOTSTRAP_SERVERS)","-m", "$(MODE)","-c", "$(CONSUMER_GROUPS)","-i", "$(POLL_INTERVAL)", "-p", "$(HTTP_PORT)"]
```

## Changelog
#### 0.0.7:
- 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.
- Kafka client updated to version 2.5.0.

#### 0.0.6:
- Issue #8: Support configuration file as parameter
- Kafka client updated to version 2.4.1.


## Usage
java -jar kafka-consumer-lag-monitoring.jar -h
Usage: <main class> [-hV] [-b=<kafkaBootstrapServers>]
Expand Down Expand Up @@ -86,6 +96,7 @@ To learn more about the configuration that you can use here, please refer the fo
Kafka AdminClient configs: https://kafka.apache.org/documentation/#adminclientconfigs

Kafka Consumer configs: https://kafka.apache.org/documentation/#consumerconfigs

### Console Mode
This mode will print the consumer lag per partition and the total lag among all partitions and continuously refreshing the metrics per the value of `--poll.interval` startup parameter. Example output:

Expand Down Expand Up @@ -160,7 +171,7 @@ and under `<dependencies>..</dependencies>`:
<dependency>
<groupId>com.omarsmak.kafka</groupId>
<artifactId>consumer-lag-monitoring</artifactId>
<version>0.0.6</version>
<version>0.0.7</version>
</dependency>
```

Expand All @@ -173,7 +184,7 @@ repositories {
```
and under `dependencies` the following:
```
compile 'com.omarsmak.kafka:consumer-lag-monitoring:0.0.6'
compile 'com.omarsmak.kafka:consumer-lag-monitoring:0.0.7'
```
**Note:** Since [bintray jcenter](https://bintray.com/bintray/jcenter) is shadowing all maven central packages, you don't need to include both.
Expand Down

0 comments on commit 6f7b5c1

Please sign in to comment.