This is an automated email from the ASF dual-hosted git repository.
chia7712 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 effbad9e80f KAFKA-19151 docs: clarify that flush.ms requires
log.flush.scheduler.interval.ms config (#19479)
effbad9e80f is described below
commit effbad9e80f45b4f02d87f22d759c7fa008cee81
Author: yunchi <yunchip...@gmail.com>
AuthorDate: Wed Apr 16 20:19:44 2025 -0700
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 <pay...@apache.org>, Ken Huang
<s7133...@gmail.com>, TengYao Chi <kiting...@gmail.com>, Chia-Ping Tsai
<chia7...@gmail.com>
---
.../src/main/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 <code>log.flush.scheduler.interval.ms</code>, 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 " +
