Skip to content

Commit 6562427

Browse files
authored
KAFKA-15307: Kafka Streams configuration docs outdated (#20329)
Updated Kafka Streams configuration documentation to stay latest with version 4.0.0. Reviewers: Matthias J. Sax <[email protected]>
1 parent 4a5562c commit 6562427

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

docs/streams/developer-guide/config-streams.html

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -298,12 +298,12 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
298298
<tr class="row-even"><td>commit.interval.ms</td>
299299
<td>Low</td>
300300
<td colspan="2">The frequency in milliseconds with which to save the position (offsets in source topics) of tasks.</td>
301-
<td><code class="docutils literal"><span class="pre">30000</span></code> (30 seconds)</td>
301+
<td><code class="docutils literal"><span class="pre">30000</span></code> (30 seconds) (at-least-once) / <code class="docutils literal"><span class="pre">100</span></code> (exactly-once)</td>
302302
</tr>
303303
<tr class="row-odd"><td>default.deserialization.exception.handler (Deprecated. Use deserialization.exception.handler instead.)</td>
304304
<td>Medium</td>
305305
<td colspan="2">Exception handling class that implements the <code class="docutils literal"><span class="pre">DeserializationExceptionHandler</span></code> interface.</td>
306-
<td><code class="docutils literal"><span class="pre">LogAndContinueExceptionHandler</span></code></td>
306+
<td><code class="docutils literal"><span class="pre">LogAndFailExceptionHandler</span></code></td>
307307
</tr>
308308
<tr class="row-even"><td>default.key.serde</td>
309309
<td>Medium</td>
@@ -328,11 +328,10 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
328328
set by the user or all serdes must be passed in explicitly (see also default.key.serde).</td>
329329
<td><code class="docutils literal"><span class="pre">null</span></code></td>
330330
</tr>
331-
<tr class="row-even"><td>default.dsl.store</td>
331+
<tr class="row-even"><td>default.dsl.store (Deprecated. Use dsl.store.suppliers.class instead.)</td>
332332
<td>Low</td>
333333
<td colspan="2">
334-
[DEPRECATED] The default state store type used by DSL operators. Deprecated in
335-
favor of <code>dsl.store.suppliers.class</code>
334+
The default state store type used by DSL operators.
336335
</td>
337336
<td><code class="docutils literal"><span class="pre">"ROCKS_DB"</span></code></td>
338337
</tr>
@@ -492,54 +491,59 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
492491
The default of <code>-1</code> (meaning: use broker default replication factor) requires broker version 2.4 or newer.</td>
493492
<td><code class="docutils literal"><span class="pre">-1</span></code></td>
494493
</tr>
495-
<tr class="row-odd"><td>retry.backoff.ms</td>
494+
<tr class="row-odd"><td>repartition.purge.interval.ms</td>
495+
<td>Low</td>
496+
<td colspan="2">The frequency in milliseconds with which to delete fully consumed records from repartition topics. Purging will occur after at least this value since the last purge, but may be delayed until later.</td>
497+
<td><code class="docutils literal"><span class="pre">30000</span></code> (30 seconds)</td>
498+
</tr>
499+
<tr class="row-even"><td>retry.backoff.ms</td>
496500
<td>Low</td>
497501
<td colspan="2">The amount of time in milliseconds, before a request is retried.</td>
498502
<td><code class="docutils literal"><span class="pre">100</span></code></td>
499503
</tr>
500-
<tr class="row-even"><td>rocksdb.config.setter</td>
504+
<tr class="row-odd"><td>rocksdb.config.setter</td>
501505
<td>Medium</td>
502506
<td colspan="2">The RocksDB configuration.</td>
503507
<td><code class="docutils literal"><span class="pre">null</span></code></td>
504508
</tr>
505-
<tr class="row-odd"><td>state.cleanup.delay.ms</td>
509+
<tr class="row-even"><td>state.cleanup.delay.ms</td>
506510
<td>Low</td>
507511
<td colspan="2">The amount of time in milliseconds to wait before deleting state when a partition has migrated.</td>
508512
<td><code class="docutils literal"><span class="pre">600000</span></code></td> (10 minutes)</td>
509513
</tr>
510-
<tr class="row-even"><td>state.dir</td>
514+
<tr class="row-odd"><td>state.dir</td>
511515
<td>High</td>
512516
<td colspan="2">Directory location for state stores.</td>
513517
<td><code class="docutils literal"><span class="pre">/${java.io.tmpdir}/kafka-streams</span></code></td>
514518
</tr>
515-
<tr class="row-odd"><td>task.assignor.class</td>
519+
<tr class="row-even"><td>task.assignor.class</td>
516520
<td>Medium</td>
517521
<td colspan="2">A task assignor class or class name implementing the <code>TaskAssignor</code> interface.</td>
518522
<td>The high-availability task assignor.</td>
519523
</tr>
520-
<tr class="row-even"><td>task.timeout.ms</td>
524+
<tr class="row-odd"><td>task.timeout.ms</td>
521525
<td>Medium</td>
522526
<td colspan="2">The maximum amount of time in milliseconds a task might stall due to internal errors and retries until an error is raised. For a timeout of <code>0 ms</code>, a task would raise an error for the first internal error. For any timeout larger than <code>0 ms</code>, a task will retry at least once before an error is raised.</td>
523527
<td><code class="docutils literal"><span class="pre">300000</span></code></td> (5 minutes)</td>
524528
</tr>
525-
<tr class="row-odd"><td>topology.optimization</td>
529+
<tr class="row-even"><td>topology.optimization</td>
526530
<td>Medium</td>
527531
<td colspan="2">A configuration telling Kafka Streams if it should optimize the topology and what optimizations to apply. Acceptable values are: <code>StreamsConfig.NO_OPTIMIZATION</code> (<code>none</code>), <code>StreamsConfig.OPTIMIZE</code> (<code>all</code>) or a comma separated list of specific optimizations: <code>StreamsConfig.REUSE_KTABLE_SOURCE_TOPICS</code> (<code>reuse.ktable.source.topics</code>), <code>StreamsConfig.MERGE_REPARTITION_TOPICS</code> (<code>merge.repartition.topics</code>),
528532
<code>StreamsConfig.SINGLE_STORE_SELF_JOIN</code> (<code>single.store.self.join</code>). </td>
529533
<td><code class="docutils literal"><span class="pre">"NO_OPTIMIZATION"</span></code></td>
530534
</tr>
531-
<tr class="row-even"><td>upgrade.from</td>
535+
<tr class="row-odd"><td>upgrade.from</td>
532536
<td>Medium</td>
533537
<td colspan="2">The version you are upgrading from during a rolling upgrade.
534538
See <a class="reference internal" href="#streams-developer-guide-upgrade-from"><span class="std std-ref">Upgrade From</span></a></td>
535539
<td><code class="docutils literal"><span class="pre">null</span></code></td>
536540
</tr>
537-
<tr class="row-odd"><td>windowstore.changelog.additional.retention.ms</td>
541+
<tr class="row-even"><td>windowstore.changelog.additional.retention.ms</td>
538542
<td>Low</td>
539543
<td colspan="2">Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift.</td>
540544
<td><code class="docutils literal"><span class="pre">86400000</span></code></td> (1 day)</td>
541545
</tr>
542-
<tr class="row-even"><td>window.size.ms</td>
546+
<tr class="row-odd"><td>window.size.ms</td>
543547
<td>Low</td>
544548
<td colspan="2">Sets window size for the deserializer in order to calculate window end times.</td>
545549
<td><code class="docutils literal"><span class="pre">null</span></code></td>

0 commit comments

Comments
 (0)