kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: MINOR: Fix documentation of compaction
Date Wed, 02 Nov 2016 01:17:52 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 94909a8f8 -> c62dc28ce


MINOR: Fix documentation of compaction

Removed a duplicate line and also cleaned up some of the language around compaction guarantees.

Author: Apurva Mehta <apurva.1618@gmail.com>

Reviewers: Gwen Shapira

Closes #2089 from apurvam/fix-documentation-of-compaction and squashes the following commits:

03c5bdd [Apurva Mehta] Fix line length to be consistent with the rest of the file
0af1a86 [Apurva Mehta] MINOR: fix duplicate line in docs for compaction.


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/c62dc28c
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/c62dc28c
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/c62dc28c

Branch: refs/heads/trunk
Commit: c62dc28ceb215da003dba39fa845c29bbd7271fa
Parents: 94909a8
Author: Apurva Mehta <apurva.1618@gmail.com>
Authored: Tue Nov 1 18:17:42 2016 -0700
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Tue Nov 1 18:17:42 2016 -0700

----------------------------------------------------------------------
 docs/design.html | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/c62dc28c/docs/design.html
----------------------------------------------------------------------
diff --git a/docs/design.html b/docs/design.html
index a666487..57db133 100644
--- a/docs/design.html
+++ b/docs/design.html
@@ -488,12 +488,9 @@ Log compaction guarantees the following:
 guarantee the minimum length of time must pass after a message is written before it could
be compacted. I.e. it provides a lower bound on how long each message will remain in the (uncompacted)
head.
 <li>Ordering of messages is always maintained.  Compaction will never re-order messages,
just remove some.
 <li>The offset for a message never changes.  It is the permanent identifier for a position
in the log.
-<li>Any read progressing from offset 0 will see at least the final state of all records
in the order they were written. All delete markers for deleted records will be seen provided
the reader reaches the head of
-the log in a time period less than the topic's delete.retention.ms setting (the default is
24 hours). This is important as delete marker removal happens concurrently with read (and
thus it is important that we not
-remove any delete marker prior to the reader seeing it).
-<li>Any consumer progressing from the start of the log will see at least the <em>final</em>
state of all records in the order they were written.  All delete markers for deleted records
will be seen provided the
-consumer reaches the head of the log in a time period less than the topic's <code>delete.retention.ms</code>
setting (the default is 24 hours).  This is important as delete marker removal happens concurrently
with
-read, and thus it is important that we do not remove any delete marker prior to the consumer
seeing it.
+<li>Any consumer progressing from the start of the log will see at least the final
state of all records in the order they were written.  Additionally, all delete markers for
deleted records will be seen, provided 
+the consumer reaches the head of the log in a time period less than the topic's <code>delete.retention.ms</code>
setting (the default is 24 hours).  In other words: since the removal of delete markers happens

+concurrently with reads, it is possible for a consumer to miss delete markers if it lags
by more than <code>delete.retention.ms</code>.
 </ol>
 
 <h4><a id="design_compactiondetails" href="#design_compactiondetails">Log Compaction
Details</a></h4>


Mime
View raw message