root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

KAFKA-19209: Clarify index.interval.bytes impact on offset and time index (#19657) 

Update docs to note index.interval.bytes sets entry frequency for offset index and, conditionally, time index. Improve clarity and readability of index.interval.bytes description.

Reviewers: Luke Chen <showuon@gmail.com>
This commit is contained in:
ShihYuan Lin 2025-05-09 09:48:55 +08:00 committed by GitHub
parent b5c468fd7c
commit 1ccaddaa70
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -111,10 +111,12 @@ public class TopicConfig {
"The largest record batch size allowed by Kafka (after compression if compression is enabled)."; "The largest record batch size allowed by Kafka (after compression if compression is enabled).";
public static final String INDEX_INTERVAL_BYTES_CONFIG = "index.interval.bytes"; public static final String INDEX_INTERVAL_BYTES_CONFIG = "index.interval.bytes";
public static final String INDEX_INTERVAL_BYTES_DOC = "This setting controls how frequently " + public static final String INDEX_INTERVAL_BYTES_DOC = "This setting controls how frequently Kafka " +
"Kafka adds an index entry to its offset index. The default setting ensures that we index a " + "adds entries to its offset index and, conditionally, to its time index. " +
"message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact " + "The default setting ensures that we index a message roughly every 4096 bytes. " +
"position in the log but makes the index larger. You probably don't need to change this."; "More frequent indexing allows reads to jump closer to the exact position in the log " +
"but results in larger index files. You probably don't need to change this." +
"<p> Note: the time index will be inserted only when the timestamp is greater than the last indexed timestamp.</p>";
public static final String FILE_DELETE_DELAY_MS_CONFIG = "file.delete.delay.ms"; public static final String FILE_DELETE_DELAY_MS_CONFIG = "file.delete.delay.ms";
public static final String FILE_DELETE_DELAY_MS_DOC = "The time to wait before deleting a file from the " + public static final String FILE_DELETE_DELAY_MS_DOC = "The time to wait before deleting a file from the " +