Settings for the Producer.
To stay source compatible with future releases, you are recommended to construct the settings as follows:
ProducerSettings(bootstrapServers)
.withLinger(500.millis)
.withCompression(ProducerCompression.Zstd(3))
.... etc.
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Configure retries for authorization or authentication errors.
Configure retries for authorization or authentication errors.
If you want to retry other (retriable) exceptions, please use the retries configuration property.
⚠️ Retrying may cause records to be produced in a different order than the order in which they were given to zio-kafka.
Value parameters
- authErrorRetrySchedule
-
The schedule at which the producer will retry producing, even when producing fails with an org.apache.kafka.common.errors.AuthorizationException or org.apache.kafka.common.errors.AuthenticationException. This setting helps with failed producing due to too slow authorization or authentication in the broker. For example, to retry 5 times, spaced by 500ms, you can set this to
Schedule.recurs(5) && Schedule.spaced(500.millis)The default is
Schedule.stopwhich is, to fail the producer on the first auth error.
Attributes
Value parameters
- compression
-
The compression codec to use when publishing records. Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression). See also withLinger.
Attributes
Value parameters
- diagnostics
-
an optional callback for key events in the producer life-cycle. The callbacks will be executed in a separate fiber. Since the events are queued, failure to handle these events leads to out of memory errors.
Attributes
Value parameters
- lingerDuration
-
The maximum amount of time a record is allowed to linger in the producer's internal buffer. Higher values allow for better batching (especially important when compression is used), lower values reduce latency and memory usage.
Attributes
Value parameters
- metricLabels
-
The labels given to all metrics collected by the zio-kafka producer. By default, no labels are set. For applications with multiple producers it is recommended to set some metric labels. For example, one can imagine a producer-id that can be used as a label:
producerSettings.withMetricLabels(Set(MetricLabel("producer-id", producerId)))
Attributes
Value parameters
- sendBufferSize
-
The maximum number of record chunks that can queue up while waiting for the underlying producer to become available. Performance critical users that publish a lot of records one by one (instead of in chunks), should consider increasing this value, for example to
10240.