Package org.apache.storm.kafka.spout
Class KafkaSpoutRetryExponentialBackoff
java.lang.Object
org.apache.storm.kafka.spout.KafkaSpoutRetryExponentialBackoff
- All Implemented Interfaces:
Serializable
,KafkaSpoutRetryService
Implementation of
KafkaSpoutRetryService
using the exponential backoff formula. The time of the nextRetry is set as follows:
nextRetry = failCount == 1 ? currentTime + initialDelay : currentTime + delayPeriod*2^(failCount-1) where failCount = 1, 2, 3, ...
nextRetry = Min(nextRetry, currentTime + maxDelay)- See Also:
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionKafkaSpoutRetryExponentialBackoff
(KafkaSpoutRetryExponentialBackoff.TimeInterval initialDelay, KafkaSpoutRetryExponentialBackoff.TimeInterval delayPeriod, int maxRetries, KafkaSpoutRetryExponentialBackoff.TimeInterval maxDelay) The time stamp of the next retry is scheduled according to the exponential backoff formula (geometric progression): nextRetry = failCount == 1 ? -
Method Summary
Modifier and TypeMethodDescriptionGets the earliest retriable offsets.getMessageId
(org.apache.kafka.common.TopicPartition tp, long offset) Gets theKafkaSpoutMessageId
for the record on the given topic partition and offset.boolean
isReady
(KafkaSpoutMessageId msgId) Checks if a specific failedKafkaSpoutMessageId
is ready to be retried, i.e is scheduled and has retry time that is less than current time.boolean
isScheduled
(KafkaSpoutMessageId msgId) Checks if a specific failedKafkaSpoutMessageId
is scheduled to be retried.int
Get the number of messages ready for retry.boolean
remove
(KafkaSpoutMessageId msgId) Removes a message from the list of messages scheduled for retrial.boolean
retainAll
(Collection<org.apache.kafka.common.TopicPartition> topicPartitions) Retains all the messages whoseTopicPartition
belongs to the specifiedCollection<TopicPartition>
.boolean
schedule
(KafkaSpoutMessageId msgId) Schedules thisKafkaSpoutMessageId
if not yet scheduled, or updates retry time if it has already been scheduled.toString()
-
Constructor Details
-
KafkaSpoutRetryExponentialBackoff
public KafkaSpoutRetryExponentialBackoff(KafkaSpoutRetryExponentialBackoff.TimeInterval initialDelay, KafkaSpoutRetryExponentialBackoff.TimeInterval delayPeriod, int maxRetries, KafkaSpoutRetryExponentialBackoff.TimeInterval maxDelay) The time stamp of the next retry is scheduled according to the exponential backoff formula (geometric progression): nextRetry = failCount == 1 ? currentTime + initialDelay : currentTime + delayPeriod^(failCount-1), where failCount = 1, 2, 3, ... nextRetry = Min(nextRetry, currentTime + maxDelay). By specifying a value for maxRetries lower than Integer.MAX_VALUE, the user decides to sacrifice guarantee of delivery for the previous polled records in favor of processing more records.- Parameters:
initialDelay
- initial delay of the first retrydelayPeriod
- the time interval that is the ratio of the exponential backoff formula (geometric progression)maxRetries
- maximum number of times a tuple is retried before being acked and scheduled for commitmaxDelay
- maximum amount of time waiting before retrying
-
-
Method Details
-
earliestRetriableOffsets
Description copied from interface:KafkaSpoutRetryService
Gets the earliest retriable offsets.- Specified by:
earliestRetriableOffsets
in interfaceKafkaSpoutRetryService
- Returns:
- The earliest retriable offset for each TopicPartition that has offsets ready to be retried, i.e. for which a tuple has failed and has retry time less than current time.
-
isReady
Description copied from interface:KafkaSpoutRetryService
Checks if a specific failedKafkaSpoutMessageId
is ready to be retried, i.e is scheduled and has retry time that is less than current time.- Specified by:
isReady
in interfaceKafkaSpoutRetryService
- Parameters:
msgId
- message to check for readiness- Returns:
- true if message is ready to be retried, false otherwise
-
isScheduled
Description copied from interface:KafkaSpoutRetryService
Checks if a specific failedKafkaSpoutMessageId
is scheduled to be retried. The message may or may not be ready to be retried yet.- Specified by:
isScheduled
in interfaceKafkaSpoutRetryService
- Parameters:
msgId
- message to check for scheduling status- Returns:
- true if the message is scheduled to be retried, regardless of being or not ready to be retried. Returns false is this message is not scheduled for retrial
-
remove
Description copied from interface:KafkaSpoutRetryService
Removes a message from the list of messages scheduled for retrial.- Specified by:
remove
in interfaceKafkaSpoutRetryService
- Parameters:
msgId
- message to remove from retrial- Returns:
- true if the message was scheduled for retrial, false otherwise
-
retainAll
Description copied from interface:KafkaSpoutRetryService
Retains all the messages whoseTopicPartition
belongs to the specifiedCollection<TopicPartition>
. All messages that come from aTopicPartition
NOT existing in the collection will be removed. This method is useful to cleanup state following partition rebalance.- Specified by:
retainAll
in interfaceKafkaSpoutRetryService
- Parameters:
topicPartitions
- Collection ofTopicPartition
for which to keep messages- Returns:
- true if at least one message was removed, false otherwise
-
schedule
Description copied from interface:KafkaSpoutRetryService
Schedules thisKafkaSpoutMessageId
if not yet scheduled, or updates retry time if it has already been scheduled. It may also indicate that the message should not be retried, in which case the message will not be scheduled.- Specified by:
schedule
in interfaceKafkaSpoutRetryService
- Parameters:
msgId
- message to schedule for retrial- Returns:
- true if the message will be retried, false otherwise
-
readyMessageCount
public int readyMessageCount()Description copied from interface:KafkaSpoutRetryService
Get the number of messages ready for retry.- Specified by:
readyMessageCount
in interfaceKafkaSpoutRetryService
- Returns:
- The number of messages that are ready for retry
-
getMessageId
Description copied from interface:KafkaSpoutRetryService
Gets theKafkaSpoutMessageId
for the record on the given topic partition and offset.- Specified by:
getMessageId
in interfaceKafkaSpoutRetryService
- Parameters:
tp
- The topic partition of the recordoffset
- The offset of the record- Returns:
- The id the record was scheduled for retry with,
or a new
KafkaSpoutMessageId
if the record was not scheduled for retry.
-
toString
-