Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shubhang93 authored Apr 5, 2024
1 parent 58657fa commit 5c20309
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,8 @@ type ConsumerConfig struct {
MaxPollIntervalMS int // Kafka Failure detection interval in milliseconds
}
```
> For more info on what the config keys and values mean please check the below link ( not all config keys are included in Ziggurat, they might be added in the future )
https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md

#### Practical example on setting the `ConsumerCount` value
The `ConsumerCount` value is used to control the concurrency of your handler execution, a higher value does not mean better performance, for an optimum performance please set it to the number of partitions you are consuming from.
Expand All @@ -405,9 +407,6 @@ ziggurat.Event{
}
```

> For more info on what the config keys and values mean please check the below link
https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md

## How to use the ziggurat Event Router
First of all understand if you need a router, a router is required only if you have different handlers for different type of events, if your application
just consumes from one topic, and you just want to handle all events in the same way then a router is not required, you can just pass a `ziggurat.HandlerFunc` OR a type that implements the `ziggurat.Handler` interface directly. A router lets you handle different events in a different ways by defining regex rules.
Expand Down

0 comments on commit 5c20309

Please sign in to comment.