[GitHub] [kafka] guozhangwang commented on a change in pull request #11329: KAFKA-13301; Optimized the interpretation of the relationship between 'request.timeout. ms' and 'max.poll.interval.ms' in the document.

[GitBox <gi...@apache.org>]

guozhangwang commented on a change in pull request #11329:
URL: https://github.com/apache/kafka/pull/11329#discussion_r710331384



##########
File path: docs/upgrade.html
##########
@@ -1543,9 +1543,8 @@ <h5><a id="upgrade_1010_notable" href="#upgrade_1010_notable">Notable changes in
     <li> The new Java Consumer now supports heartbeating from a background thread. There is a new configuration
          <code>max.poll.interval.ms</code> which controls the maximum time between poll invocations before the consumer
          will proactively leave the group (5 minutes by default). The value of the configuration
-         <code>request.timeout.ms</code> must always be larger than <code>max.poll.interval.ms</code> because this is the maximum
-         time that a JoinGroup request can block on the server while the consumer is rebalancing, so we have changed its default
-         value to just above 5 minutes. Finally, the default value of <code>session.timeout.ms</code> has been adjusted down to
+         <code>request.timeout.ms</code> must always be smaller than <code>max.poll.interval.ms</code>, so we have changed

Review comment:
       It's better to still explain the reason why it's better to be larger. How about the following:
   
   ```
   <code>request.timeout.ms</code> (default to 30 seconds) must always be smaller than <code>max.poll.interval.ms</code>, since that is the maximum time that a JoinGroup request can block on the server while the consumer is rebalance. Finally...
   ```




-- 
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