From effbad9e80f45b4f02d87f22d759c7fa008cee81 Mon Sep 17 00:00:00 2001 From: yunchi Date: Wed, 16 Apr 2025 20:19:44 -0700 Subject: [PATCH] KAFKA-19151 docs: clarify that flush.ms requires log.flush.scheduler.interval.ms config (#19479) Enhanced docs of `flush.ms` to remind users the flush is triggered by `log.flush.scheduler.interval.ms`. Reviewers: PoAn Yang , Ken Huang , TengYao Chi , Chia-Ping Tsai --- .../java/org/apache/kafka/common/config/TopicConfig.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java b/clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java index f3157bb1b1a..e22787fb658 100755 --- a/clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java +++ b/clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java @@ -58,9 +58,10 @@ public class TopicConfig { public static final String FLUSH_MS_CONFIG = "flush.ms"; public static final String FLUSH_MS_DOC = "This setting allows specifying a time interval at which we will " + "force an fsync of data written to the log. For example if this was set to 1000 " + - "we would fsync after 1000 ms had passed. In general we recommend you not set " + - "this and use replication for durability and allow the operating system's background " + - "flush capabilities as it is more efficient."; + "we would fsync after 1000 ms had passed. Note that this setting depends on the broker-level " + + "configuration log.flush.scheduler.interval.ms, which controls how frequently the flush check occurs. " + + "In general we recommend you not set this and use replication for durability and allow the operating system's " + + "background flush capabilities as it is more efficient."; public static final String RETENTION_BYTES_CONFIG = "retention.bytes"; public static final String RETENTION_BYTES_DOC = "This configuration controls the maximum size a partition " +