Skip to content

Commit e4ccca6

Browse files
committed
docs: enhance the docs of flush.ms by reminding users the flush is triggered by log.flush.scheduler.interval.ms
1 parent fb2ce76 commit e4ccca6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +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 " +
61+
"we would fsync after 1000 ms had passed. Note that this setting depends on the broker-level " +
62+
"configuration \"log.flush.scheduler.interval.ms\", which controls how frequently the flush check occurs. " +
63+
"If \"log.flush.scheduler.interval.ms\" is not configured, the topic config \"flush.ms\" will not be triggered. " +
64+
"In general we recommend you not set this and use replication for durability and allow the operating system's background " +
6365
"flush capabilities as it is more efficient.";
6466

6567
public static final String RETENTION_BYTES_CONFIG = "retention.bytes";

0 commit comments

Comments
 (0)