[kafka] branch trunk updated: MINOR: improve description of `commit.interval.ms` config (#12169)

[mj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 44edad5bb5 MINOR: improve description of `commit.interval.ms` config (#12169)
44edad5bb5 is described below

commit 44edad5bb54ee23cb40b02180a84eb9edc052978
Author: Matthias J. Sax <mj...@apache.org>
AuthorDate: Tue Jun 14 22:29:25 2022 -0700

    MINOR: improve description of `commit.interval.ms` config (#12169)
    
    Reviewers: Luke Chen <sh...@gmail.com>, Kvicii Y <@Kvicii>, Bruno Cadonna <br...@confluent.io>, A. Sophie Blee-Goldman <so...@confluent.io>
---
 streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
index 73d519b4a6..bc52c9f9b1 100644
--- a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
+++ b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
@@ -452,7 +452,9 @@ public class StreamsConfig extends AbstractConfig {
     /** {@code commit.interval.ms} */
     @SuppressWarnings("WeakerAccess")
     public static final String COMMIT_INTERVAL_MS_CONFIG = "commit.interval.ms";
-    private static final String COMMIT_INTERVAL_MS_DOC = "The frequency in milliseconds with which to save the position of the processor." +
+    private static final String COMMIT_INTERVAL_MS_DOC = "The frequency in milliseconds with which to commit processing progress." +
+        " For at-least-once processing, committing means to save the position (ie, offsets) of the processor." +
+        " For exactly-once processing, it means to commit the transaction which includes to save the position and to make the committed data in the output topic visible to consumers with isolation level read_committed." +
         " (Note, if <code>processing.guarantee</code> is set to <code>" + EXACTLY_ONCE_V2 + "</code>, <code>" + EXACTLY_ONCE + "</code>,the default value is <code>" + EOS_DEFAULT_COMMIT_INTERVAL_MS + "</code>," +
         " otherwise the default value is <code>" + DEFAULT_COMMIT_INTERVAL_MS + "</code>.";