KAFKA-14468: Implement CommitRequestManager to manage the commit and autocommit requests #13021
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.clients.consumer.internals; | ||
|
|
||
| import org.apache.kafka.clients.ClientResponse; | ||
| import org.apache.kafka.clients.consumer.ConsumerConfig; | ||
| import org.apache.kafka.clients.consumer.OffsetAndMetadata; | ||
| import org.apache.kafka.clients.consumer.RetriableCommitFailedException; | ||
| import org.apache.kafka.common.TopicPartition; | ||
| import org.apache.kafka.common.message.OffsetCommitRequestData; | ||
| import org.apache.kafka.common.record.RecordBatch; | ||
| import org.apache.kafka.common.requests.OffsetCommitRequest; | ||
| import org.apache.kafka.common.utils.LogContext; | ||
| import org.apache.kafka.common.utils.Time; | ||
| import org.apache.kafka.common.utils.Timer; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.Queue; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class CommitRequestManager implements RequestManager { | ||
| private final Queue<StagedCommit> stagedCommits; | ||
| // TODO: We will need to refactor the subscriptionState | ||
| private final SubscriptionState subscriptionState; | ||
| private final Logger log; | ||
| private final Optional<AutoCommitState> autoCommitState; | ||
|
Contributor
There was a problem hiding this comment. The optional is kind of annoying. I wonder if we could treat auto-commit disabled as having an auto-commit interval of
Contributor
Author
There was a problem hiding this comment. It makes sense to use a MaxValue as well, my counter argument is, i think explicitly disabling autoCommitState makes the logic more straightforward. |
||
| private final CoordinatorRequestManager coordinatorRequestManager; | ||
| private final GroupStateManager groupState; | ||
|
Contributor
There was a problem hiding this comment. I'd suggest we either change the class name to just
Contributor
Author
There was a problem hiding this comment. Agreed. makes sense. thanks. |
||
|
|
||
| public CommitRequestManager( | ||
|
philipnee marked this conversation as resolved.
Outdated
|
||
| final Time time, | ||
| final LogContext logContext, | ||
| final SubscriptionState subscriptionState, | ||
| final ConsumerConfig config, | ||
| final CoordinatorRequestManager coordinatorRequestManager, | ||
| final GroupStateManager groupState) { | ||
| Objects.requireNonNull(coordinatorRequestManager, "Coordinator is needed upon committing offsets"); | ||
| this.log = logContext.logger(getClass()); | ||
| this.stagedCommits = new LinkedList<>(); | ||
| if (config.getBoolean(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG)) { | ||
| final long autoCommitInterval = | ||
| Integer.toUnsignedLong(config.getInt(ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG)); | ||
| this.autoCommitState = Optional.of(new AutoCommitState(time, autoCommitInterval)); | ||
| } else { | ||
| this.autoCommitState = Optional.empty(); | ||
| } | ||
| this.coordinatorRequestManager = coordinatorRequestManager; | ||
| this.groupState = groupState; | ||
| this.subscriptionState = subscriptionState; | ||
| } | ||
|
|
||
| /** | ||
| * Poll for the commit request if there's any. The function will also try to autocommit, if enabled. | ||
| * | ||
| * @param currentTimeMs | ||
| * @return | ||
| */ | ||
| @Override | ||
| public NetworkClientDelegate.PollResult poll(final long currentTimeMs) { | ||
| maybeAutoCommit(currentTimeMs); | ||
|
|
||
| if (stagedCommits.isEmpty()) { | ||
|
Contributor
There was a problem hiding this comment. The
Contributor
Author
There was a problem hiding this comment. thanks, addressed. |
||
| return new NetworkClientDelegate.PollResult(Long.MAX_VALUE, new ArrayList<>()); | ||
| } | ||
|
|
||
| List<NetworkClientDelegate.UnsentRequest> unsentCommitRequests = | ||
| stagedCommits.stream().map(StagedCommit::toUnsentRequest).collect(Collectors.toList()); | ||
| return new NetworkClientDelegate.PollResult(Long.MAX_VALUE, Collections.unmodifiableList(unsentCommitRequests)); | ||
| } | ||
|
|
||
| public CompletableFuture<ClientResponse> add(final Map<TopicPartition, OffsetAndMetadata> offsets) { | ||
| StagedCommit commit = new StagedCommit( | ||
| offsets, | ||
| groupState.groupId, | ||
| groupState.groupInstanceId.orElse(null), | ||
| groupState.generation); | ||
| this.stagedCommits.add(commit); | ||
| return commit.future(); | ||
| } | ||
|
|
||
| private void maybeAutoCommit(final long currentTimeMs) { | ||
|
philipnee marked this conversation as resolved.
Outdated
|
||
| if (!autoCommitState.isPresent()) { | ||
| return; | ||
| } | ||
|
|
||
| AutoCommitState autocommit = autoCommitState.get(); | ||
| if (!autocommit.canSendAutocommit(currentTimeMs)) { | ||
| return; | ||
| } | ||
|
|
||
| Map<TopicPartition, OffsetAndMetadata> allConsumedOffsets = subscriptionState.allConsumed(); | ||
| log.debug("Auto-committing offsets {}", allConsumedOffsets); | ||
| sendAutoCommit(allConsumedOffsets); | ||
|
Contributor
There was a problem hiding this comment. I'm wondering if we should reset immediately or should we have a flag of If we want to go very fancy, we can potentially just update the unsent auto commit request inside the
Contributor
Author
There was a problem hiding this comment. Hmm, I see your point. Let's track the inflight status in the autocommit state and reset them upon completing the future (in the callback). |
||
| autocommit.reset(); | ||
| } | ||
|
|
||
| // Visible for testing | ||
| CompletableFuture<ClientResponse> sendAutoCommit(final Map<TopicPartition, OffsetAndMetadata> allConsumedOffsets) { | ||
| CompletableFuture<ClientResponse> future = this.add(allConsumedOffsets); | ||
| future.whenComplete((response, throwable) -> { | ||
| if (throwable == null) { | ||
| log.debug("Completed asynchronous auto-commit of offsets {}", allConsumedOffsets); | ||
| } | ||
|
|
||
| if (throwable instanceof RetriableCommitFailedException) { | ||
|
Contributor
There was a problem hiding this comment. merge this as
Contributor
Author
There was a problem hiding this comment. I moved it to the exceptionally block, it think it would be clearer this way. |
||
| log.debug("Asynchronous auto-commit of offsets {} failed due to retriable error: {}", allConsumedOffsets, | ||
| throwable); | ||
| } else { | ||
| log.warn("Asynchronous auto-commit of offsets {} failed: {}", allConsumedOffsets, | ||
| throwable.getMessage()); | ||
| } | ||
| }); | ||
| return future; | ||
| } | ||
|
|
||
| public void clientPoll(final long currentTimeMs) { | ||
| this.autoCommitState.ifPresent(t -> t.ack(currentTimeMs)); | ||
| } | ||
|
|
||
| private class StagedCommit { | ||
| private final Map<TopicPartition, OffsetAndMetadata> offsets; | ||
| private final String groupId; | ||
| private final GroupStateManager.Generation generation; | ||
| private final String groupInstanceId; | ||
| private final NetworkClientDelegate.FutureCompletionHandler future; | ||
|
|
||
| public StagedCommit(final Map<TopicPartition, OffsetAndMetadata> offsets, | ||
| final String groupId, | ||
| final String groupInstanceId, | ||
| final GroupStateManager.Generation generation) { | ||
| this.offsets = offsets; | ||
| // if no callback is provided, DefaultOffsetCommitCallback will be used. | ||
| this.future = new NetworkClientDelegate.FutureCompletionHandler(); | ||
| this.groupId = groupId; | ||
| this.generation = generation; | ||
| this.groupInstanceId = groupInstanceId; | ||
| } | ||
|
|
||
| public CompletableFuture<ClientResponse> future() { | ||
| return future.future(); | ||
| } | ||
|
|
||
| public NetworkClientDelegate.UnsentRequest toUnsentRequest() { | ||
| Map<String, OffsetCommitRequestData.OffsetCommitRequestTopic> requestTopicDataMap = new HashMap<>(); | ||
| for (Map.Entry<TopicPartition, OffsetAndMetadata> entry : offsets.entrySet()) { | ||
| TopicPartition topicPartition = entry.getKey(); | ||
| OffsetAndMetadata offsetAndMetadata = entry.getValue(); | ||
|
|
||
| OffsetCommitRequestData.OffsetCommitRequestTopic topic = requestTopicDataMap | ||
| .getOrDefault(topicPartition.topic(), | ||
| new OffsetCommitRequestData.OffsetCommitRequestTopic() | ||
| .setName(topicPartition.topic()) | ||
| ); | ||
|
|
||
| topic.partitions().add(new OffsetCommitRequestData.OffsetCommitRequestPartition() | ||
| .setPartitionIndex(topicPartition.partition()) | ||
| .setCommittedOffset(offsetAndMetadata.offset()) | ||
| .setCommittedLeaderEpoch(offsetAndMetadata.leaderEpoch().orElse(RecordBatch.NO_PARTITION_LEADER_EPOCH)) | ||
| .setCommittedMetadata(offsetAndMetadata.metadata()) | ||
| ); | ||
| requestTopicDataMap.put(topicPartition.topic(), topic); | ||
| } | ||
|
|
||
| OffsetCommitRequest.Builder builder = new OffsetCommitRequest.Builder( | ||
| new OffsetCommitRequestData() | ||
| .setGroupId(this.groupId) | ||
| .setGenerationId(generation.generationId) | ||
| .setMemberId(generation.memberId) | ||
| .setGroupInstanceId(groupInstanceId) | ||
| .setTopics(new ArrayList<>(requestTopicDataMap.values()))); | ||
| return new NetworkClientDelegate.UnsentRequest( | ||
| builder, | ||
| coordinatorRequestManager.coordinator(), | ||
| future); | ||
| } | ||
| } | ||
|
|
||
| static class AutoCommitState { | ||
| private final Timer timer; | ||
| private final long autoCommitInterval; | ||
|
|
||
| public AutoCommitState( | ||
| final Time time, | ||
| final long autoCommitInterval) { | ||
| this.autoCommitInterval = autoCommitInterval; | ||
| this.timer = time.timer(autoCommitInterval); | ||
| } | ||
|
|
||
| public boolean canSendAutocommit(final long currentTimeMs) { | ||
| return this.timer.isExpired(); | ||
| } | ||
|
|
||
| public void reset() { | ||
| this.timer.reset(autoCommitInterval); | ||
| } | ||
|
|
||
| public void ack(final long currentTimeMs) { | ||
| this.timer.update(currentTimeMs); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should finalize the plan for subscriptionState, whether we will reuse the same class or implement a new one (and deprecate the old one)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the main problem with using the current
SubscriptionStateis that it couples together the commit position and the fetch position. With the move to the background thread, I don't think we can depend on these advancing in lock-step anymore. The fetch position can advance after we have received a fetch position and the commit position will be advanced when the application callspoll(). With that said, it is probably simpler to build this into the currentSubscriptionStateinstead of creating something new.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1. I checked the current SusbscriptionState class and feel it's still resuable.