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

MINOR: cleanup policy doc update (#6692) 

Reviewers: Guozhang Wang <wangguoz@gmail.com>
This commit is contained in:
Joyce Fee 2019-05-08 20:38:28 -05:00 committed by Guozhang Wang
parent e6cff21fd8
commit cc4a7f01e8
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/design.html
View File

@ -523,16 +523,20 @@
<h4><a id="design_compactionconfig" href="#design_compactionconfig">Configuring The Log Cleaner</a></h4>
The log cleaner is enabled by default. This will start the pool of cleaner threads.
To enable log cleaning on a particular topic you can add the log-specific property
To enable log cleaning on a particular topic, add the log-specific property
<pre class="brush: text;"> log.cleanup.policy=compact</pre>
This can be done either at topic creation time or using the alter topic command.
<p>
The <code>log.cleanup.policy</code> property is a broker configuration setting defined
in the broker's <code>server.properties</code> file; it affects all of the topics
in the cluster that do not have a configuration override in place as documented
<a href="/documentation.html#brokerconfigs">here</a>.
The log cleaner can be configured to retain a minimum amount of the uncompacted "head" of the log. This is enabled by setting the compaction time lag.
<pre class="brush: text;"> log.cleaner.min.compaction.lag.ms</pre>
This can be used to prevent messages newer than a minimum message age from being subject to compaction. If not set, all log segments are eligible for compaction except for the last segment, i.e. the one currently
being written to. The active segment will not be compacted even if all of its messages are older than the minimum compaction time lag.
</p>
<p>
Further cleaner configurations are described <a href="/documentation.html#brokerconfigs">here</a>.