This is an automated email from the ASF dual-hosted git repository.
mjsax pushed a commit to branch 4.0
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/4.0 by this push:
new d7f27e15443 MINOR: Update 4.0.0 documentation for Kafka Streams
(#18124)
d7f27e15443 is described below
commit d7f27e1544384ca48e5c7b4bb187a94d812fbb49
Author: Alieh Saeedi <107070585+aliehsaee...@users.noreply.github.com>
AuthorDate: Tue Jan 14 22:14:22 2025 +0100
MINOR: Update 4.0.0 documentation for Kafka Streams (#18124)
Reviewers: Matthias J. Sax <matth...@confluent.io>
---
docs/streams/upgrade-guide.html | 69 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html
index 8c1446af7da..d1d9eb2b347 100644
--- a/docs/streams/upgrade-guide.html
+++ b/docs/streams/upgrade-guide.html
@@ -141,6 +141,20 @@
<h3><a id="streams_api_changes_400"
href="#streams_api_changes_400">Streams API changes in 4.0.0</a></h3>
+ <p>
+ In this release, eos-v1 (Exactly Once Semantics version 1) is no
longer supported. To use eos-v2, brokers must be running version 2.5 or later.
+ Additionally, all deprecated methods, classes, APIs, and config
parameters up to and including AK 3.5 release have been removed.
+ A few important ones are listed below. The full list can be found <a
href="https://issues.apache.org/jira/browse/KAFKA-12822";>here</a>.
+ <ul>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-12829";>Old processor
APIs</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-12823";>KStream#through() in
both Java and Scala</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-16339";>"transformer" methods
and classes in both Java and Scala</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-12824";>kstream.KStream#branch
in both Java and Scala</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-16332";>builder methods for
Time/Session/Join/SlidingWindows</a></li>
+ <li><a
href="https://issues.apache.org/jira/browse/KAFKA-12827";>KafkaStreams#setUncaughtExceptionHandler()</a></li>
+ </ul>
+ </p>
+
<p>
In this release the <code>ClientInstanceIds</code> instance stores the
global consumer<code>Uuid</code> for the
<a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-714%3A+Client+metrics+and+observability#KIP714:Clientmetricsandobservability-Clientidentificationandtheclientinstanceid";>KIP-714</a>
@@ -161,6 +175,61 @@
<code>TransformerSupplier</code>, <code>ValueTransformer</code>, and
<code>ValueTransformerSupplier</code>.
</p>
+ <p>
+ Previously, the <code>ProductionExceptionHandler</code> was not
invoked on a (retriable) <code>TimeoutException</code>. With Kafka Streams 4.0,
the handler is called, and the default handler would return <code>RETRY</code>
to not change existing behavior.
+ However, a custom handler can now decide to break the infinite retry
loop by returning either <code>CONTINUE</code> or <code>FAIL</code> (<a
href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=311627309";>KIP-1065</a>).
+ </p>
+
+ <p>
+ In this release, Kafka Streams metrics can be collected broker side
via the KIP-714 broker-plugin.
+ For more detailed information, refer to <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1076%3A++Metrics+for+client+applications+KIP-714+extension";>KIP-1076</a>
document please.
+ </p>
+
+ <p>
+ <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1077%3A+Deprecate+%60ForeachProcessor%60+and+move+to+internal+package";>KIP-1077</a>
+ deprecates the <code>ForeachProcessor</code> class.
+ This change is aimed at improving the organization and clarity of the
Kafka Streams API by ensuring that internal classes are not exposed in public
packages.
+ </p>
+
+ <p>
+ <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1078%3A+Remove+Leaking+Getter+Methods+in+Joined+Helper+Class";>KIP-1078</a>
deprecates the leaking getter methods in the <code>Joined</code> helper class.
+ These methods are deprecated without a replacement for future removal,
as they don't add any value to Kafka Streams users.
+ </p>
+
+ <p>
+ To ensures better encapsulation and organization of configuration
documentation within Kafka Streams,
+ <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1085%3A+Fix+leaking+*_DOC+variables+in+StreamsConfig";>KIP-1085</a>
+ deprecate certain public doc description variables that are only used
within the <code>StreamsConfig</code> or <code>TopologyConfig</code> classes.
+ Additionally, the unused variable <code>DUMMY_THREAD_INDEX</code> will
also be deprecated.
+ </p>
+
+ <p>
+ Due to the removal of the already deprecated <code>#through</code>
method in Kafka Streams, the <code>intermediateTopicsOption</code> of
<code>StreamsResetter</code> tool in Apache Kafka is
+ not needed any more and therefore is deprecated (<a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1087%3A+Removing+intermediateTopicsOption+from+StreamsResetter";>KIP-1087</a>).
+ </p>
+
+ <p>
+ Since string metrics cannot be collected on the broker side (KIP-714),
<a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1091%3A+Improved+Kafka+Streams+operator+metrics";>KIP-1091</a>
+ introduces numeric counterparts to allow proper broker-side metric
collection for Kafka Streams applications.
+ These metrics will be available at the <code>INFO</code> recording
level, and a thread-level metric with a String value will be available for
users leveraging Java Management Extensions (<code>JMX</code>).
+ </p>
+
+ <p>
+ 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
+ <a href="">KIP-1104</a>.
+ KIP-1104 allows foreign key extraction from both the key and value in
KTable joins in Apache Kafka.
+ Previously, foreign key joins in KTables only allowed extraction from
the value, which led to data duplication and potential inconsistencies.
+ 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.
+ The existing methods will be deprecated but not removed, ensuring
backward compatibility. This change aims to reduce storage overhead and improve
API usability.
+ </p>
+
+ <p>
+ With introduction of <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1106%3A+Add+duration+based+offset+reset+option+for+consumer+clients";>KIP-1106</a>,
+ the existing <code>Topology.AutoOffsetReset</code> is deprecated and
replaced with a new class <code>org.apache.kafka.streams.AutoOffsetReset</code>
to capture the reset strategies.
+ New methods will be added to the
<code>org.apache.kafka.streams.Topology</code> and
<code>org.apache.kafka.streams.kstream.Consumed</code> classes to support the
new reset strategy.
+ These changes aim to provide more flexibility and efficiency in
managing offsets, especially in scenarios involving long-term storage and
infinite retention.
+ </p>
+
<p>
You can now configure your topology with a
<code>ProcessorWrapper</code>, which allows you to access and optionally
wrap/replace
any processor in the topology by injecting an alternative
<code>ProcessorSupplier</code> in its place. This can be used to peek
