Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 9, 2025
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
721b708
KAFKA-19209: Clarify index.interval.bytes impact on offset and time
shmily7829 May 6, 2025
4f462b2
fix:add blank
shmily7829 May 6, 2025
cfad359
Merge branch 'apache:trunk' into KAFKA-19209
shmily7829 May 8, 2025
360c4a4
KAFKA-19209: Improve clarity and readability of index.interval.bytes …
shmily7829 May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,12 @@ public class TopicConfig {
"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_DOC = "This setting controls how frequently " +
"Kafka adds an index entry to its offset index. The default setting ensures that we index a " +
"message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact " +
"position in the log but makes the index larger. You probably don't need to change this.";
public static final String INDEX_INTERVAL_BYTES_DOC = "This setting controls how frequently Kafka " +
"adds entries to its offset index and, conditionally, to its time index. " +
"The default setting ensures that we index a message roughly every 4096 bytes. " +
"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_DOC = "The time to wait before deleting a file from the " +
Expand Down