Status
Current state: Under Discussion
Discussion thread: here
JIRA: here
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
Motivation
Currently, in KafkaConsumer
, the position(TopicPartition topicPartition)
method will continue to block indefinitely unless the offsets are retrieved for the provided TopicPartition
. To avoid this scenario from occurring, a TimeoutException
will be thrown once the amount of time spent exceeds requestTimeoutMs
which is a user-configured variable.
Public Interfaces
A TimeoutException
will be thrown when the time spent exceeds requestTimeoutMs
:
/** * Get the offset of the <i>next record</i> that will be fetched (if a record with that offset exists). * This method may issue a remote call to the server if there is no current position for the given partition. * <p> * This call will block until either the position could be determined or an unrecoverable error is * encountered (in which case it is thrown to the caller). * * @param partition The partition to get the position for * @return The current position of the consumer (that is, the offset of the next record to be fetched) * @throws IllegalArgumentException if the provided TopicPartition is not assigned to this consumer * @throws org.apache.kafka.clients.consumer.InvalidOffsetException if no offset is currently defined for * the partition * @throws org.apache.kafka.common.errors.WakeupException if {@link #wakeup()} is called before or while this * function is called * @throws org.apache.kafka.common.errors.InterruptException if the calling thread is interrupted before or while * this function is called + * @throws org.apache.kafka.common.errors.TimeoutException if time spent blocking for offsets exceed requestTimeoutMs * @throws org.apache.kafka.common.errors.AuthenticationException if authentication fails. See the exception for more details * @throws org.apache.kafka.common.errors.AuthorizationException if not authorized to the topic or to the * configured groupId. See the exception for more details * @throws org.apache.kafka.common.KafkaException for any other unrecoverable errors */ public long position(TopicPartition partition);
Proposed Changes
A TimeoutException will be thrown if time spent of position()
method exceeds requestTimeoutMs
.
Compatibility, Deprecation, and Migration Plan
Due to earlier versions of position()
not throwing TimeoutException, some changes will have to be made to existing data structures to take into account what happens if offsets are not retrieved. One potential change could be made to requestTimeoutMs
to factor in a time-bounded position()
method.