Settings for the consumer.
To stay source compatible with future releases, you are recommended to construct the settings as follows:
ConsumerSettings(bootstrapServers)
.withGroupId(groupId)
.withProperties(properties)
.... etc.
Value parameters
- bootstrapServers
-
the Kafka bootstrap servers
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
WARNING: zio.kafka.consumer.fetch.FetchStrategy is an EXPERIMENTAL API and may change in an incompatible way without notice in any zio-kafka version.
WARNING: zio.kafka.consumer.fetch.FetchStrategy is an EXPERIMENTAL API and may change in an incompatible way without notice in any zio-kafka version.
Value parameters
- fetchStrategy
-
The fetch strategy which selects which partitions can fetch data in the next poll. The default is to use the zio.kafka.consumer.fetch.QueueSizeBasedFetchStrategy with a
maxPartitionQueueSizeparameter of 1024, which is calculated by taking 2 * the defaultmax.poll.recordsof 500, rounded to the nearest power of 2.
Attributes
Value parameters
- maxPartitionQueueSize
-
Maximum number of records to be buffered per partition. This buffer improves throughput and supports varying downstream message processing time, while maintaining some backpressure. Large values effectively disable backpressure at the cost of high memory usage, low values will effectively disable prefetching in favour of low memory consumption. The number of records that is fetched on every poll is controlled by the
max.poll.recordssetting, the number of records fetched for every partition is somewhere between 0 andmax.poll.records. A value that is a power of 2 offers somewhat better queueing performance. The default value for this parameter is 1024, calculated by taking 2 * the defaultmax.poll.recordsof 500, rounded to the nearest power of 2.
Attributes
The maximum time to block while polling the Kafka consumer. The Kafka consumer will return earlier when the maximum number of record to poll (see https://kafka.apache.org/documentation/#consumerconfigs_max.poll.records) is collected.
The maximum time to block while polling the Kafka consumer. The Kafka consumer will return earlier when the maximum number of record to poll (see https://kafka.apache.org/documentation/#consumerconfigs_max.poll.records) is collected.
The default is 50ms which to good for low latency applications. Set this higher, e.g. 500ms for better throughput.
Attributes
Value parameters
- value
-
When
trueall streams are restarted during a rebalance, including those streams that are not revoked. The default isfalse.
Attributes
Value parameters
- timeout
-
Internal timeout for each iteration of the command processing and polling loop, use to detect stalling. This should be much larger than the pollTimeout and the time it takes to process chunks of records. If your consumer is not subscribed for long periods during its lifetime, this timeout should take that into account as well. When the timeout expires, the plainStream/partitionedStream/etc will fail with a Consumer.RunloopTimeout.