Skip to content

Commit 382011f

Browse files
committed
MINOR: Add 4.0.1 docs
1 parent 6b04790 commit 382011f

File tree

8 files changed

+3303
-134
lines changed

8 files changed

+3303
-134
lines changed

40/generated/connect_rest.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ info:
88
name: Apache 2.0
99
url: https://www.apache.org/licenses/LICENSE-2.0.html
1010
title: Kafka Connect REST API
11-
version: 4.0.0
11+
version: 4.0.1
1212
paths:
1313
/:
1414
get:

40/generated/protocol_messages.html

Lines changed: 3263 additions & 109 deletions
Large diffs are not rendered by default.

40/generated/topic_config.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ <h4><a id="remote.log.delete.on.disable"></a><a id="topicconfigs_remote.log.dele
276276
</li>
277277
<li>
278278
<h4><a id="remote.storage.enable"></a><a id="topicconfigs_remote.storage.enable" href="#topicconfigs_remote.storage.enable">remote.storage.enable</a></h4>
279-
<p>To enable tiered storage for a topic, set this configuration as true. You can not disable this config once it is enabled. It will be provided in future versions.</p>
279+
<p>To enable tiered storage for a topic, set this configuration to true. To disable tiered storage for a topic that has it enabled, set this configuration to false. When disabling, you must also set <code>remote.log.delete.on.disable</code> to true.</p>
280280
<table><tbody>
281281
<tr><th>Type:</th><td>boolean</td></tr>
282282
<tr><th>Default:</th><td>false</td></tr>

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

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -296,12 +296,12 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
296296
<tr class="row-even"><td>commit.interval.ms</td>
297297
<td>Low</td>
298298
<td colspan="2">The frequency in milliseconds with which to save the position (offsets in source topics) of tasks.</td>
299-
<td><code class="docutils literal"><span class="pre">30000</span></code> (30 seconds)</td>
299+
<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>
300300
</tr>
301301
<tr class="row-odd"><td>default.deserialization.exception.handler (Deprecated. Use deserialization.exception.handler instead.)</td>
302302
<td>Medium</td>
303303
<td colspan="2">Exception handling class that implements the <code class="docutils literal"><span class="pre">DeserializationExceptionHandler</span></code> interface.</td>
304-
<td><code class="docutils literal"><span class="pre">LogAndContinueExceptionHandler</span></code></td>
304+
<td><code class="docutils literal"><span class="pre">LogAndFailExceptionHandler</span></code></td>
305305
</tr>
306306
<tr class="row-even"><td>default.key.serde</td>
307307
<td>Medium</td>
@@ -326,11 +326,10 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
326326
set by the user or all serdes must be passed in explicitly (see also default.key.serde).</td>
327327
<td><code class="docutils literal"><span class="pre">null</span></code></td>
328328
</tr>
329-
<tr class="row-even"><td>default.dsl.store</td>
329+
<tr class="row-even"><td>default.dsl.store (Deprecated. Use dsl.store.suppliers.class instead.)</td>
330330
<td>Low</td>
331331
<td colspan="2">
332-
[DEPRECATED] The default state store type used by DSL operators. Deprecated in
333-
favor of <code>dsl.store.suppliers.class</code>
332+
The default state store type used by DSL operators.
334333
</td>
335334
<td><code class="docutils literal"><span class="pre">"ROCKS_DB"</span></code></td>
336335
</tr>
@@ -481,54 +480,59 @@ <h4><a class="toc-backref" href="#id45">num.standby.replicas</a><a class="header
481480
The default of <code>-1</code> (meaning: use broker default replication factor) requires broker version 2.4 or newer.</td>
482481
<td><code class="docutils literal"><span class="pre">-1</span></code></td>
483482
</tr>
484-
<tr class="row-even"><td>retry.backoff.ms</td>
483+
<tr class="row-even"><td>repartition.purge.interval.ms</td>
484+
<td>Low</td>
485+
<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>
486+
<td><code class="docutils literal"><span class="pre">30000</span></code> (30 seconds)</td>
487+
</tr>
488+
<tr class="row-odd"><td>retry.backoff.ms</td>
485489
<td>Low</td>
486490
<td colspan="2">The amount of time in milliseconds, before a request is retried.</td>
487491
<td><code class="docutils literal"><span class="pre">100</span></code></td>
488492
</tr>
489-
<tr class="row-odd"><td>rocksdb.config.setter</td>
493+
<tr class="row-even"><td>rocksdb.config.setter</td>
490494
<td>Medium</td>
491495
<td colspan="2">The RocksDB configuration.</td>
492496
<td><code class="docutils literal"><span class="pre">null</span></code></td>
493497
</tr>
494-
<tr class="row-even"><td>state.cleanup.delay.ms</td>
498+
<tr class="row-odd"><td>state.cleanup.delay.ms</td>
495499
<td>Low</td>
496500
<td colspan="2">The amount of time in milliseconds to wait before deleting state when a partition has migrated.</td>
497501
<td><code class="docutils literal"><span class="pre">600000</span></code></td> (10 minutes)</td>
498502
</tr>
499-
<tr class="row-odd"><td>state.dir</td>
503+
<tr class="row-even"><td>state.dir</td>
500504
<td>High</td>
501505
<td colspan="2">Directory location for state stores.</td>
502506
<td><code class="docutils literal"><span class="pre">/${java.io.tmpdir}/kafka-streams</span></code></td>
503507
</tr>
504-
<tr class="row-even"><td>task.assignor.class</td>
508+
<tr class="row-odd"><td>task.assignor.class</td>
505509
<td>Medium</td>
506510
<td colspan="2">A task assignor class or class name implementing the <code>TaskAssignor</code> interface.</td>
507511
<td>The high-availability task assignor.</td>
508512
</tr>
509-
<tr class="row-odd"><td>task.timeout.ms</td>
513+
<tr class="row-even"><td>task.timeout.ms</td>
510514
<td>Medium</td>
511515
<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>
512516
<td><code class="docutils literal"><span class="pre">300000</span></code></td> (5 minutes)</td>
513517
</tr>
514-
<tr class="row-even"><td>topology.optimization</td>
518+
<tr class="row-odd"><td>topology.optimization</td>
515519
<td>Medium</td>
516520
<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>),
517521
<code>StreamsConfig.SINGLE_STORE_SELF_JOIN</code> (<code>single.store.self.join</code>). </td>
518522
<td><code class="docutils literal"><span class="pre">"NO_OPTIMIZATION"</span></code></td>
519523
</tr>
520-
<tr class="row-odd"><td>upgrade.from</td>
524+
<tr class="row-even"><td>upgrade.from</td>
521525
<td>Medium</td>
522526
<td colspan="2">The version you are upgrading from during a rolling upgrade.
523527
See <a class="reference internal" href="#streams-developer-guide-upgrade-from"><span class="std std-ref">Upgrade From</span></a></td>
524528
<td><code class="docutils literal"><span class="pre">null</span></code></td>
525529
</tr>
526-
<tr class="row-even"><td>windowstore.changelog.additional.retention.ms</td>
530+
<tr class="row-odd"><td>windowstore.changelog.additional.retention.ms</td>
527531
<td>Low</td>
528532
<td colspan="2">Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift.</td>
529533
<td><code class="docutils literal"><span class="pre">86400000</span></code></td> (1 day)</td>
530534
</tr>
531-
<tr class="row-odd"><td>window.size.ms</td>
535+
<tr class="row-even"><td>window.size.ms</td>
532536
<td>Low</td>
533537
<td colspan="2">Sets window size for the deserializer in order to calculate window end times.</td>
534538
<td><code class="docutils literal"><span class="pre">null</span></code></td>

40/streams/developer-guide/dsl-api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -764,10 +764,10 @@ <h4 class="anchor-heading"><a id="streams_concepts_globalktable" class="anchor-l
764764
<td>
765765
<p class="first">Manually trigger repartitioning of the stream with desired number of partitions. (<a class="reference external" href="/{{version}}/javadoc/org/apache/kafka/streams/kstream/KStream.html#repartition--">details</a>)</p>
766766

767-
<code><span class="pre">repartition()</span></code> is similar to <code><span class="pre">through()</span></code> however Kafka Streams will manage the topic for you.
767+
Kafka Streams will manage the topic for <code><span class="pre">repartition()</span></code>.
768768
Generated topic is treated as internal topic, as a result data will be purged automatically as any other internal repartition topic.
769769
In addition, you can specify the desired number of partitions, which allows to easily scale in/out downstream sub-topologies.
770-
<code><span class="pre">repartition()</span></code> operation always triggers repartitioning of the stream, as a result it can be used with embedded Processor API methods (like <code><span class="pre">transform()</span></code> et al.) that do not trigger auto repartitioning when key changing operation is performed beforehand.
770+
<code><span class="pre">repartition()</span></code> operation always triggers repartitioning of the stream, as a result it can be used with embedded Processor API methods (like <code><span class="pre">process()</span></code> et al.) that do not trigger auto repartitioning when key changing operation is performed beforehand.
771771

772772
<pre class="line-numbers"><code class="language-java">KStream&lt;byte[], String&gt; stream = ... ;
773773
KStream&lt;byte[], String&gt; repartitionedStream = stream.repartition(Repartitioned.numberOfPartitions(10));</code></pre>

40/streams/upgrade-guide.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ <h3><a id="streams_api_changes_400" href="#streams_api_changes_400">Streams API
216216

217217
<p>
218218
In order to reduce storage overhead and improve API usability, a new method in the Java and Scala APIs that accepts a BiFunction for foreign key extraction is introduced by
219-
<a href="https://cwiki.apache.org/confluence/x/gIuMEw">KIP-1104</a>.
219+
<a href="">KIP-1104</a>.
220220
KIP-1104 allows foreign key extraction from both the key and value in KTable joins in Apache Kafka.
221221
Previously, foreign key joins in KTables only allowed extraction from the value, which led to data duplication and potential inconsistencies.
222222
This enhancement introduces a new method in the Java and Scala APIs that accepts a BiFunction for foreign key extraction, enabling more intuitive and efficient joins.

40/toc.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@
148148
<li><a href="#monitoring">6.7 Monitoring</a>
149149
<ul>
150150
<li><a href="#remote_jmx">Security Considerations for Remote Monitoring using JMX</a>
151+
<li><a href="#group_coordinator_monitoring">Group Coordinator Monitoring</a>
151152
<li><a href="#tiered_storage_monitoring">Tiered Storage Monitoring</a>
152153
<li><a href="#kraft_monitoring">KRaft Monitoring</a>
153154
<li><a href="#selector_monitoring">Selector Monitoring</a>

40/upgrade.html

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
<script id="upgrade-template" type="text/x-handlebars-template">
2121

22-
<h4><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading to 4.0.0</a></h4>
22+
<h4><a id="upgrade_4_0_1" href="#upgrade_4_0_1">Upgrading to 4.0.1</a></h4>
2323

24-
<h5><a id="upgrade_clients_4_0_0" href="#upgrade_clients_4_0_0">Upgrading Clients to 4.0.0</a></h5>
24+
<h5><a id="upgrade_clients_4_0_1" href="#upgrade_clients_4_0_1">Upgrading Clients to 4.0.1</a></h5>
2525

2626
<p><b>For a rolling upgrade:</b></p>
2727

@@ -32,7 +32,7 @@ <h5><a id="upgrade_clients_4_0_0" href="#upgrade_clients_4_0_0">Upgrading Client
3232
or <a href="https://cwiki.apache.org/confluence/x/y4kgF">KIP-1124</a>.</li>
3333
</ol>
3434

35-
<h5><a id="upgrade_servers_4_0_0" href="#upgrade_servers_4_0_0">Upgrading Servers to 4.0.0 from any version 3.3.x through 3.9.x</a></h5>
35+
<h5><a id="upgrade_servers_4_0_1" href="#upgrade_servers_4_0_1">Upgrading Servers to 4.0.1 from any version 3.3.x through 3.9.x</a></h5>
3636

3737
<p>Note: Apache Kafka 4.0 only supports KRaft mode - ZooKeeper mode has been removed. As such, <b>broker upgrades to 4.0.0 (and higher) require KRaft mode and
3838
the software and metadata versions must be at least 3.3.x</b> (the first version when KRaft mode was deemed production ready). For clusters in KRaft mode
@@ -56,7 +56,13 @@ <h5><a id="upgrade_servers_4_0_0" href="#upgrade_servers_4_0_0">Upgrading Server
5656
has a boolean parameter that indicates if there are metadata changes (i.e. <code>IBP_4_0_IV1(23, "4.0", "IV1", true)</code> means this version has metadata changes).
5757
Given your current and target versions, a downgrade is only possible if there are no metadata changes in the versions between.</li>
5858
</ol>
59-
59+
<h5><a id="upgrade_servers_401_notable" href="#upgrade_servers_401_notable">Notable changes in 4.0.1</a></h5>
60+
<ul>
61+
<li>
62+
The filename for rotated <code>state-change.log</code> files has been updated from <code>stage-change.log.[date]</code> to <code>state-change.log.[date]</code> in the log4j2.yaml configuration file.
63+
See <a href="https://issues.apache.org/jira/browse/KAFKA-19576">KAFKA-19576</a> for details.
64+
</li>
65+
</ul>
6066
<h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Notable changes in 4.0.0</a></h5>
6167
<ul>
6268
<li>
@@ -68,7 +74,7 @@ <h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Nota
6874
</li>
6975
<li>
7076
Apache Kafka 4.0 only supports KRaft mode - ZooKeeper mode has been removed. About version upgrade,
71-
check <a href="/{{version}}/documentation.html#upgrade_4_0_0">Upgrading to 4.0.0 from any version 3.3.x through 3.9.x</a> for more info.
77+
check <a href="/{{version}}/documentation.html#upgrade_4_0_1">Upgrading to 4.0.1 from any version 3.3.x through 3.9.x</a> for more info.
7278
</li>
7379
<li>
7480
Apache Kafka 4.0 ships with a brand-new group coordinator implementation (See <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=217387038#KIP848:TheNextGenerationoftheConsumerRebalanceProtocol-GroupCoordinator">here</a>).
@@ -411,6 +417,10 @@ <h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Nota
411417
<li> See <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-890%3A+Transactions+Server-Side+Defense">KIP-890</a> and
412418
<a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1050%3A+Consistent+error+handling+for+Transactions">KIP-1050</a> for more details </li>
413419
</ul>
420+
<li>
421+
The filename for rotated <code>state-change.log</code> files incorrectly rotates to <code>stage-change.log.[date]</code> (changing state to stage). This issue is corrected in 4.0.1.
422+
See <a href="https://issues.apache.org/jira/browse/KAFKA-19576">KAFKA-19576</a> for details.
423+
</li>
414424
</ul>
415425
</li>
416426
</ul>

0 commit comments

Comments
 (0)