Skip to content

Commit f9b31ae

Browse files
committed
docs: Clarify that index.interval.bytes affects both offset and time index entries
1 parent 342f557 commit f9b31ae

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

40/generated/topic_config.html

+6-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,12 @@ <h4><a id="follower.replication.throttled.replicas"></a><a id="topicconfigs_foll
111111
</li>
112112
<li>
113113
<h4><a id="index.interval.bytes"></a><a id="topicconfigs_index.interval.bytes" href="#topicconfigs_index.interval.bytes">index.interval.bytes</a></h4>
114-
<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>
114+
<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>
115+
<ul>
116+
<li>Add an entry to the offset index for the batch's last offset.</li>
117+
<li>Attempt to add an entry to the time index if the batch's maximum timestamp is greater than the last indexed timestamp.</li>
118+
</ul>
119+
<p>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>
115120
<table><tbody>
116121
<tr><th>Type:</th><td>int</td></tr>
117122
<tr><th>Default:</th><td>4096 (4 kibibytes)</td></tr>

0 commit comments

Comments
 (0)