Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Luca Filipponi authored Sep 29, 2019
1 parent 7793127 commit b3b1109
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# kafka-message-seeker

This application will start a kafka consumer that will scan a topic looking for the a string.
This application will start a kafka consumer that will scan a topic looking for the specified string. It is useful when you have a fragment of a kafka message and you want to find the whole together with its offset and partition.
To run the application you need the jar (you can build or download it from [releases](https://github.com/LFilips/kafka-message-seeker/releases)) with these options:

### How to use
```
Usage: kafkaMessage seeker [options]
Expand All @@ -12,8 +13,8 @@ Usage: kafkaMessage seeker [options]
-o, --offset <value> The offset to start with (for every partition!)
```

For example if you want to find all the messages that contains the string "hello" starting from
offset 1000 on the topic "test_topic" you should run in this way:
For example if you want to find all the messages containing the string "hello" starting from
offset 1000 on the topic "test_topic" you have to use these args:

`java -jar kafka-message-seeker.jar --topic test_topic --offset 1000 --search-for hello`

Expand Down Expand Up @@ -56,4 +57,4 @@ If the kafka-message-seeker can't connect to the broker will timeout after a whi

```
Exception in thread "main" org.apache.kafka.common.errors.TimeoutException: Timeout expired while fetching topic metadata
```
```

0 comments on commit b3b1109

Please sign in to comment.