You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2021/09/23 12:17:25 UTC

[GitHub] [kafka] cddr opened a new pull request #11355: Improve documentation on EOS KStream requirements

cddr opened a new pull request #11355:
URL: https://github.com/apache/kafka/pull/11355


   Minor documentation fix to address: https://issues.apache.org/jira/browse/KAFKA-13298
   
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] mjsax commented on a change in pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
mjsax commented on a change in pull request #11355:
URL: https://github.com/apache/kafka/pull/11355#discussion_r717026620



##########
File path: docs/streams/developer-guide/config-streams.html
##########
@@ -742,7 +742,12 @@ <h4><a class="toc-backref" href="#id30">probing.rebalance.interval.ms</a><a clas
               and <code class="docutils literal"><span class="pre">transaction.state.log.min.isr</span></code>
               to the number of brokers you want to use.
               For more details see <a href="../core-concepts#streams_processing_guarantee">Processing Guarantees</a>.
-            </div></blockquote>
+
+              <dl class="docutils">
+                <dt>Recommendation:</dt>
+                  <dd>While it is technically possible to use EOS with any replication factor, using a replication factor lower than 3 effectively voids EOS. Thus it is strongly recommended to use a replication factor of 3 (together with min.in.sync.replicas=2). This recommendation applies to all topics (i.e. __transaction_state, __consumer_offsets, Kafka Streams internal topics, and user topics).</dd>

Review comment:
       Can we break this line into multiple? Hard to review long lines...
   
   Should we use some markup for `__consumer_offsets` (etc) ?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] cddr commented on a change in pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
cddr commented on a change in pull request #11355:
URL: https://github.com/apache/kafka/pull/11355#discussion_r716873048



##########
File path: docs/streams/developer-guide/config-streams.html
##########
@@ -742,7 +742,12 @@ <h4><a class="toc-backref" href="#id30">probing.rebalance.interval.ms</a><a clas
               and <code class="docutils literal"><span class="pre">transaction.state.log.min.isr</span></code>
               to the number of brokers you want to use.
               For more details see <a href="../core-concepts#streams_processing_guarantee">Processing Guarantees</a>.
-            </div></blockquote>
+
+              <dl class="docutils">
+                <dt>Recommendation:</dt>
+                  <dd>While it is technically possible to use EOS with any replication factor, using a replication factor lower than 3 effectively voids EOS. Thus it is strongly recommended to use a replication factor of 3</dd>

Review comment:
       Thanks for the review @mjsax. I have updated the PR accordingly.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] mjsax commented on a change in pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
mjsax commented on a change in pull request #11355:
URL: https://github.com/apache/kafka/pull/11355#discussion_r717026620



##########
File path: docs/streams/developer-guide/config-streams.html
##########
@@ -742,7 +742,12 @@ <h4><a class="toc-backref" href="#id30">probing.rebalance.interval.ms</a><a clas
               and <code class="docutils literal"><span class="pre">transaction.state.log.min.isr</span></code>
               to the number of brokers you want to use.
               For more details see <a href="../core-concepts#streams_processing_guarantee">Processing Guarantees</a>.
-            </div></blockquote>
+
+              <dl class="docutils">
+                <dt>Recommendation:</dt>
+                  <dd>While it is technically possible to use EOS with any replication factor, using a replication factor lower than 3 effectively voids EOS. Thus it is strongly recommended to use a replication factor of 3 (together with min.in.sync.replicas=2). This recommendation applies to all topics (i.e. __transaction_state, __consumer_offsets, Kafka Streams internal topics, and user topics).</dd>

Review comment:
       Can we break this line into multiple? Hard to review long lines...
   
   Should we use some markup for `__consumer_offsets` (etc) ?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] mjsax merged pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
mjsax merged pull request #11355:
URL: https://github.com/apache/kafka/pull/11355


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] mjsax commented on a change in pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
mjsax commented on a change in pull request #11355:
URL: https://github.com/apache/kafka/pull/11355#discussion_r715769874



##########
File path: docs/streams/developer-guide/config-streams.html
##########
@@ -742,7 +742,12 @@ <h4><a class="toc-backref" href="#id30">probing.rebalance.interval.ms</a><a clas
               and <code class="docutils literal"><span class="pre">transaction.state.log.min.isr</span></code>
               to the number of brokers you want to use.
               For more details see <a href="../core-concepts#streams_processing_guarantee">Processing Guarantees</a>.
-            </div></blockquote>
+
+              <dl class="docutils">
+                <dt>Recommendation:</dt>
+                  <dd>While it is technically possible to use EOS with any replication factor, using a replication factor lower than 3 effectively voids EOS. Thus it is strongly recommended to use a replication factor of 3</dd>

Review comment:
       Users should also configure `min.in.sync.replicas=2` for this case. -- We might also want to point out, that the recommendation applies to all topics (ie, __transaction_state, __consumer_offsets, Kafka Streams internal topics, and user topics).
   
   nit: missing `.` at the end.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [kafka] mjsax commented on pull request #11355: KAFKA-13298: Improve documentation on EOS KStream requirements

Posted by GitBox <gi...@apache.org>.
mjsax commented on pull request #11355:
URL: https://github.com/apache/kafka/pull/11355#issuecomment-935259937


   Thanks for the PR @cddr! Merged to `trunk`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org