diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html index b875fcddc891c..0e56e33952e38 100644 --- a/docs/streams/upgrade-guide.html +++ b/docs/streams/upgrade-guide.html @@ -108,6 +108,35 @@

<

Since 2.6.0 release, Kafka Streams depends on a RocksDB version that requires MacOS 10.14 or higher.

+

Streams API changes in 4.2.0

+ +

+ Kafka Streams now supports Dead Letter Queue (DLQ). + A new config errors.deadletterqueue.topic.name allows to specify the name of the DLQ topic. When set and DefaultProductionExceptionHandler is used, records that cause exceptions will be forwarded to the DLQ topic. + If a custom exception handler is used, it is up to the custom handler to build DLQ records to send, hence, depending on the implementation, the errors.deadletterqueue.topic.name configuration may be ignored. + + org.apache.kafka.streams.errors.ProductionExceptionHandler$ProductionExceptionHandlerResponse is deprecated and replaced by org.apache.kafka.streams.errors.ProductionExceptionHandler$Response. + Methods handle and handleSerializationException in org.apache.kafka.streams.errors.ProductionExceptionHandler are deprecated and replaced by handleError and handleSerializationError respectively in order to use the new Response class. + More details can be found in KIP-1034. +

+ +

+ We introduce a new org.apache.kafka.streams.CloseOptions class which replaces the existing org.apache.kafka.streams.KafkaStreams$CloseOptions. + The latter is deprecated and will be removed in the next major release. + CloseOptions class allows to specify close timeout and group membership operation - whether the consumer needs to leave the group or remain in the group. + More details can be found in KIP-1153. +

+ +

+ Kafka Streams now allows to enable state store directories created by Kafka Streams to have write access for the OS group, via the newly added config allow.os.group.write.access. + More details can be found in KIP-1230. +

+ +

+ org.apache.kafka.streams.errors.BrokerNotFoundException was deprecated and will be removed in the next major release. + More details can be found in KIP-1195. +

+

Streams API changes in 4.1.0

Note: Kafka Streams 4.1.0 contains a critical memory leak bug (KAFKA-19748) that affects users of range scans and certain DSL operators (session windows, sliding windows, stream-stream joins, foreign-key joins). Users running Kafka Streams should consider upgrading directly to 4.1.1 when available.