[
https://issues.apache.org/jira/browse/KAFKA-19209?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17948239#comment-17948239
]
ASF GitHub Bot commented on KAFKA-19209:
----------------------------------------
brandboat commented on code in PR #686:
URL: https://github.com/apache/kafka-site/pull/686#discussion_r2067026790
##########
40/generated/topic_config.html:
##########
@@ -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>
Review 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.
> "index.interval.bytes" config doc should also mention time index
> ----------------------------------------------------------------
>
> Key: KAFKA-19209
> URL: https://issues.apache.org/jira/browse/KAFKA-19209
> Project: Kafka
> Issue Type: Improvement
> Reporter: Luke Chen
> Assignee: ShihYuanLin
> Priority: Major
> Labels: newbie
>
> h4.
> [index.interval.bytes|https://kafka.apache.org/documentation/#topicconfigs_index.interval.bytes]
> The config description only says it controls the interval with which we add
> an entry to the offset index. But it also controls the interval of time
> index[1], with some condition[2]. We should make the doc clear.
>
> ref:
> #
> https://github.com/apache/kafka/blob/443c01ca80cbeecd8c1b4272742cd5b05f43568e/storage/src/main/java/org/apache/kafka/storage/internals/log/LogSegment.java#L258
> #
> https://github.com/apache/kafka/blob/443c01ca80cbeecd8c1b4272742cd5b05f43568e/storage/src/main/java/org/apache/kafka/storage/internals/log/TimeIndex.java#L173-L183
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
