KAFKA-19209: Clarify index.interval.bytes impact on offset and time index #686
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brandboat
reviewed
Apr 29, 2025
40/generated/topic_config.html
Outdated
| @@ -111,7 +111,12 @@ <h4><a id="follower.replication.throttled.replicas"></a><a id="topicconfigs_foll | |||
| </li> | |||
| <li> | |||
| <h4><a id="index.interval.bytes"></a><a id="topicconfigs_index.interval.bytes" href="#topicconfigs_index.interval.bytes">index.interval.bytes</a></h4> | |||
| <p>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.</p> | |||
| <p>This setting controls how frequently Kafka adds entries to its offset index and, conditionally, to its time index. After appending a batch of messages, if the total bytes written since the last index entry exceed this value, Kafka will:</p> | |||
There was a problem hiding this comment.
Hi @shmily7829, thanks for the PR!
Normally we'll fix the config doc in https://github.com/apache/kafka/blob/269e2d898b76b5c9c58232c35bee805ceacc2ead/clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java#L117
This doc you are editing here is generated by script.
There was a problem hiding this comment.
Hi @brandboat,
Thank you for the reminder.
I will make the corrections by this weekend.
There was a problem hiding this comment.
The updated PR has been submitted at apache/kafka#19657.
Therefore, I’ll go ahead and close this one.
@brandboat Thank you for your time and review!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update docs to note index.interval.bytes sets entry frequency for offset index and, conditionally, time index.