Skip to content

Commit effbad9

Browse files
authored
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 <[email protected]>, Ken Huang <[email protected]>, TengYao Chi <[email protected]>, Chia-Ping Tsai <[email protected]>
1 parent b4e75fb commit effbad9

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,10 @@ public class TopicConfig {
5858
public static final String FLUSH_MS_CONFIG = "flush.ms";
5959
public static final String FLUSH_MS_DOC = "This setting allows specifying a time interval at which we will " +
6060
"force an fsync of data written to the log. For example if this was set to 1000 " +
61-
"we would fsync after 1000 ms had passed. In general we recommend you not set " +
62-
"this and use replication for durability and allow the operating system's background " +
63-
"flush capabilities as it is more efficient.";
61+
"we would fsync after 1000 ms had passed. Note that this setting depends on the broker-level " +
62+
"configuration <code>log.flush.scheduler.interval.ms</code>, which controls how frequently the flush check occurs. " +
63+
"In general we recommend you not set this and use replication for durability and allow the operating system's " +
64+
"background flush capabilities as it is more efficient.";
6465

6566
public static final String RETENTION_BYTES_CONFIG = "retention.bytes";
6667
public static final String RETENTION_BYTES_DOC = "This configuration controls the maximum size a partition " +

0 commit comments

Comments
 (0)