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.

Sign up for GitHub

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

Jump to bottom

docs: update README to add possible values for requireAcks producer config #1455

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update README to add possible values for requireAcks producer config #1455

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 22 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,25 @@ const client = new kafka.KafkaClient({kafkaHost: '10.3.100.196:9092'});
## Producer
### Producer(KafkaClient, [options], [customPartitioner])
* `client`: client which keeps a connection with the Kafka server.
* `options`: options for producer,
* `options`: options for producer
* `requireAcks`: Configuration for when to consider a message as acknowledged, default 1. Other values are:
* `0` = no acknowledgements
* `1` = only leader should acknowledge
* `-1` = all in-sync replicas should acknowledge (depends on cluster configuration [`min.insync.replicas`](https://kafka.apache.org/documentation/#brokerconfigs_min.insync.replicas))
* `ackTimeoutMs`: The amount of time in milliseconds to wait for all acks before considered, default 100ms
* `partitionerType`: Partitioner type, default 0. Other values are:
* `0` = default
* `1` = random
* `2` = cyclic
* `3` = keyed
* `4` = custom

`options` example:

```js
{
// Configuration for when to consider a message as acknowledged, default 1
requireAcks: 1,
// The amount of time in milliseconds to wait for all acks before considered, default 100ms
ackTimeoutMs: 100,
// Partitioner type (default = 0, random = 1, cyclic = 2, keyed = 3, custom = 4), default 0
partitionerType: 2
}
```
Expand Down Expand Up @@ -212,13 +222,17 @@ client.createTopics(topicsToCreate, (error, result) => {
## HighLevelProducer
### HighLevelProducer(KafkaClient, [options], [customPartitioner])
* `client`: client which keeps a connection with the Kafka server. Round-robins produce requests to the available topic partitions
* `options`: options for producer,

* `options`: options for producer
* `requireAcks`: Configuration for when to consider a message as acknowledged, default 1. Other values are:
* `0` = no acknowledgements
* `1` = only leader should acknowledge
* `-1` = all in-sync replicas should acknowledge (depends on cluster configuration [`min.insync.replicas`](https://kafka.apache.org/documentation/#brokerconfigs_min.insync.replicas))
* `ackTimeoutMs`: The amount of time in milliseconds to wait for all acks before considered, default 100ms

`options` example:
```js
{
// Configuration for when to consider a message as acknowledged, default 1
requireAcks: 1,
// The amount of time in milliseconds to wait for all acks before considered, default 100ms
ackTimeoutMs: 100
}
```
Expand Down