22/generated/streams_config.html

<table class="data-table"><tbody>
<tr>
<th>Name</th>
<th>Description</th>
<th>Type</th>
<th>Default</th>
<th>Valid Values</th>
<th>Importance</th>
</tr>
<tr>
<td>application.id</td></td><td>An identifier for the stream processing application. Must be unique within the Kafka cluster. It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix.</td></td><td>string</td></td><td></td></td><td></td></td><td>high</td></td></tr>
<tr>
<td>bootstrap.servers</td></td><td>A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping&mdash;this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form <code>host1:port1,host2:port2,...</code>. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down).</td></td><td>list</td></td><td></td></td><td></td></td><td>high</td></td></tr>
<tr>
<td>replication.factor</td></td><td>The replication factor for change log topics and repartition topics created by the stream processing application.</td></td><td>int</td></td><td>1</td></td><td></td></td><td>high</td></td></tr>
<tr>
<td>state.dir</td></td><td>Directory location for state store.</td></td><td>string</td></td><td>/tmp/kafka-streams</td></td><td></td></td><td>high</td></td></tr>
<tr>
<td>cache.max.bytes.buffering</td></td><td>Maximum number of memory bytes to be used for buffering across all threads</td></td><td>long</td></td><td>10485760</td></td><td>[0,...]</td></td><td>medium</td></td></tr>
<tr>
<td>client.id</td></td><td>An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer, with pattern '<client.id>-StreamThread-<threadSequenceNumber>-<consumer|producer|restore-consumer>'.</td></td><td>string</td></td><td>""</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>default.deserialization.exception.handler</td></td><td>Exception handling class that implements the <code>org.apache.kafka.streams.errors.DeserializationExceptionHandler</code> interface.</td></td><td>class</td></td><td>org.apache.kafka.streams.errors.LogAndFailExceptionHandler</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>default.key.serde</td></td><td> Default serializer / deserializer class for key that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well</td></td><td>class</td></td><td>org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>default.production.exception.handler</td></td><td>Exception handling class that implements the <code>org.apache.kafka.streams.errors.ProductionExceptionHandler</code> interface.</td></td><td>class</td></td><td>org.apache.kafka.streams.errors.DefaultProductionExceptionHandler</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>default.timestamp.extractor</td></td><td>Default timestamp extractor class that implements the <code>org.apache.kafka.streams.processor.TimestampExtractor</code> interface.</td></td><td>class</td></td><td>org.apache.kafka.streams.processor.FailOnInvalidTimestamp</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>default.value.serde</td></td><td>Default serializer / deserializer class for value that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well</td></td><td>class</td></td><td>org.apache.kafka.common.serialization.Serdes$ByteArraySerde</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>max.task.idle.ms</td></td><td>Maximum amount of time a stream task will stay idle when not all of its partition buffers contain records, to avoid potential out-of-order record processing across multiple input streams.</td></td><td>long</td></td><td>0</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>num.standby.replicas</td></td><td>The number of standby replicas for each task.</td></td><td>int</td></td><td>0</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>num.stream.threads</td></td><td>The number of threads to execute stream processing.</td></td><td>int</td></td><td>1</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>processing.guarantee</td></td><td>The processing guarantee that should be used. Possible values are <code>at_least_once</code> (default) and <code>exactly_once</code>. Note that exactly-once processing requires a cluster of at least three brokers by default what is the recommended setting for production; for development you can change this, by adjusting broker setting <code>transaction.state.log.replication.factor</code> and <code>transaction.state.log.min.isr</code>.</td></td><td>string</td></td><td>at_least_once</td></td><td>[at_least_once, exactly_once]</td></td><td>medium</td></td></tr>
<tr>
<td>security.protocol</td></td><td>Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.</td></td><td>string</td></td><td>PLAINTEXT</td></td><td></td></td><td>medium</td></td></tr>
<tr>
<td>topology.optimization</td></td><td>A configuration telling Kafka Streams if it should optimize the topology, disabled by default</td></td><td>string</td></td><td>none</td></td><td>[none, all]</td></td><td>medium</td></td></tr>
<tr>
<td>application.server</td></td><td>A host:port pair pointing to an embedded user defined endpoint that can be used for discovering the locations of state stores within a single KafkaStreams application</td></td><td>string</td></td><td>""</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>buffered.records.per.partition</td></td><td>Maximum number of records to buffer per partition.</td></td><td>int</td></td><td>1000</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>commit.interval.ms</td></td><td>The frequency with which to save the position of the processor. (Note, if <code>processing.guarantee</code> is set to <code>exactly_once</code>, the default value is <code>100</code>, otherwise the default value is <code>30000</code>.</td></td><td>long</td></td><td>30000</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>connections.max.idle.ms</td></td><td>Close idle connections after the number of milliseconds specified by this config.</td></td><td>long</td></td><td>540000</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>metadata.max.age.ms</td></td><td>The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions.</td></td><td>long</td></td><td>300000</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>metric.reporters</td></td><td>A list of classes to use as metrics reporters. Implementing the <code>org.apache.kafka.common.metrics.MetricsReporter</code> interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics.</td></td><td>list</td></td><td>""</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>metrics.num.samples</td></td><td>The number of samples maintained to compute metrics.</td></td><td>int</td></td><td>2</td></td><td>[1,...]</td></td><td>low</td></td></tr>
<tr>
<td>metrics.recording.level</td></td><td>The highest recording level for metrics.</td></td><td>string</td></td><td>INFO</td></td><td>[INFO, DEBUG]</td></td><td>low</td></td></tr>
<tr>
<td>metrics.sample.window.ms</td></td><td>The window of time a metrics sample is computed over.</td></td><td>long</td></td><td>30000</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>partition.grouper</td></td><td>Partition grouper class that implements the <code>org.apache.kafka.streams.processor.PartitionGrouper</code> interface.</td></td><td>class</td></td><td>org.apache.kafka.streams.processor.DefaultPartitionGrouper</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>poll.ms</td></td><td>The amount of time in milliseconds to block waiting for input.</td></td><td>long</td></td><td>100</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>receive.buffer.bytes</td></td><td>The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used.</td></td><td>int</td></td><td>32768</td></td><td>[-1,...]</td></td><td>low</td></td></tr>
<tr>
<td>reconnect.backoff.max.ms</td></td><td>The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms.</td></td><td>long</td></td><td>1000</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>reconnect.backoff.ms</td></td><td>The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker.</td></td><td>long</td></td><td>50</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>request.timeout.ms</td></td><td>The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted.</td></td><td>int</td></td><td>40000</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>retries</td></td><td>Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error.</td></td><td>int</td></td><td>0</td></td><td>[0,...,2147483647]</td></td><td>low</td></td></tr>
<tr>
<td>retry.backoff.ms</td></td><td>The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios.</td></td><td>long</td></td><td>100</td></td><td>[0,...]</td></td><td>low</td></td></tr>
<tr>
<td>rocksdb.config.setter</td></td><td>A Rocks DB config setter class or class name that implements the <code>org.apache.kafka.streams.state.RocksDBConfigSetter</code> interface</td></td><td>class</td></td><td>null</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>send.buffer.bytes</td></td><td>The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used.</td></td><td>int</td></td><td>131072</td></td><td>[-1,...]</td></td><td>low</td></td></tr>
<tr>
<td>state.cleanup.delay.ms</td></td><td>The amount of time in milliseconds to wait before deleting state when a partition has migrated. Only state directories that have not been modified for at least <code>state.cleanup.delay.ms</code> will be removed</td></td><td>long</td></td><td>600000</td></td><td></td></td><td>low</td></td></tr>
<tr>
<td>upgrade.from</td></td><td>Allows upgrading from versions 0.10.0/0.10.1/0.10.2/0.11.0/1.0/1.1 to version 1.2 (or newer) in a backward compatible way. When upgrading from 1.2 to a newer version it is not required to specify this config.Default is null. Accepted values are "0.10.0", "0.10.1", "0.10.2", "0.11.0", "1.0", "1.1" (for upgrading from the corresponding old version).</td></td><td>string</td></td><td>null</td></td><td>[null, 0.10.0, 0.10.1, 0.10.2, 0.11.0, 1.0, 1.1]</td></td><td>low</td></td></tr>
<tr>
<td>windowstore.changelog.additional.retention.ms</td></td><td>Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift. Default is 1 day</td></td><td>long</td></td><td>86400000</td></td><td></td></td><td>low</td></td></tr>
</tbody></table>