lianetm commented on code in PR #14364: URL: https://github.com/apache/kafka/pull/14364#discussion_r1330319691
########## clients/src/main/java/org/apache/kafka/clients/consumer/internals/HeartbeatRequestManager.java: ########## @@ -0,0 +1,255 @@ +/* + * 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.CommonClientConfigs; +import org.apache.kafka.clients.consumer.ConsumerConfig; +import org.apache.kafka.common.KafkaException; +import org.apache.kafka.common.errors.GroupAuthorizationException; +import org.apache.kafka.common.message.ConsumerGroupHeartbeatRequestData; +import org.apache.kafka.common.protocol.Errors; +import org.apache.kafka.common.requests.ConsumerGroupHeartbeatRequest; +import org.apache.kafka.common.requests.ConsumerGroupHeartbeatResponse; +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; + +public class HeartbeatRequestManager implements RequestManager { + private final Time time; + private final Logger logger; + + private final int rebalanceTimeoutMs; + + private final CoordinatorRequestManager coordinatorRequestManager; + private final SubscriptionState subscriptions; + private final HeartbeatRequestState heartbeatRequestState; + private final MembershipManager membershipManager; + private final ErrorEventHandler nonRetriableErrorHandler; + + public HeartbeatRequestManager( + final Time time, + final LogContext logContext, + final ConsumerConfig config, + final CoordinatorRequestManager coordinatorRequestManager, + final SubscriptionState subscriptions, + final MembershipManager membershipManager, + final ErrorEventHandler nonRetriableErrorHandler) { + this.coordinatorRequestManager = coordinatorRequestManager; + this.time = time; + this.logger = logContext.logger(HeartbeatRequestManager.class); + this.subscriptions = subscriptions; + this.membershipManager = membershipManager; + this.nonRetriableErrorHandler = nonRetriableErrorHandler; + this.rebalanceTimeoutMs = config.getInt(CommonClientConfigs.MAX_POLL_INTERVAL_MS_CONFIG); + + long heartbeatIntervalMs = config.getInt(ConsumerConfig.HEARTBEAT_INTERVAL_MS_CONFIG); + long retryBackoffMs = config.getLong(ConsumerConfig.RETRY_BACKOFF_MS_CONFIG); + long retryBackoffMaxMs = config.getLong(ConsumerConfig.RETRY_BACKOFF_MAX_MS_CONFIG); + this.heartbeatRequestState = new HeartbeatRequestState(logContext, time, heartbeatIntervalMs, retryBackoffMs, + retryBackoffMaxMs, rebalanceTimeoutMs); + } + + // Visible for testing + HeartbeatRequestManager( + final Time time, + final LogContext logContext, + final ConsumerConfig config, + final CoordinatorRequestManager coordinatorRequestManager, + final SubscriptionState subscriptions, + final MembershipManager membershipManager, + final HeartbeatRequestState heartbeatRequestState, + final ErrorEventHandler nonRetriableErrorHandler) { + this.time = time; + this.logger = logContext.logger(this.getClass()); + this.subscriptions = subscriptions; + this.rebalanceTimeoutMs = config.getInt(CommonClientConfigs.MAX_POLL_INTERVAL_MS_CONFIG); + this.coordinatorRequestManager = coordinatorRequestManager; + this.heartbeatRequestState = heartbeatRequestState; + this.membershipManager = membershipManager; + this.nonRetriableErrorHandler = nonRetriableErrorHandler; + } + + @Override + public NetworkClientDelegate.PollResult poll(long currentTimeMs) { + if (!coordinatorRequestManager.coordinator().isPresent() || membershipManager.notInGroup()) { + return new NetworkClientDelegate.PollResult( + Long.MAX_VALUE, Collections.emptyList()); + } + + if (!heartbeatRequestState.canSendRequest(currentTimeMs)) { + return new NetworkClientDelegate.PollResult( + heartbeatRequestState.nextHeartbeatMs(currentTimeMs), + Collections.emptyList()); + } + this.heartbeatRequestState.onSendAttempt(currentTimeMs); + NetworkClientDelegate.UnsentRequest request = makeHeartbeatRequest(); + // return Long.MAX_VALUE because we will update the timer when the response is received + return new NetworkClientDelegate.PollResult(Long.MAX_VALUE, Collections.singletonList(request)); + } + + private NetworkClientDelegate.UnsentRequest makeHeartbeatRequest() { + ConsumerGroupHeartbeatRequestData data = new ConsumerGroupHeartbeatRequestData() + .setGroupId(membershipManager.groupId()) + .setMemberEpoch(membershipManager.memberEpoch()) + .setMemberId(membershipManager.memberId()) + .setRebalanceTimeoutMs(rebalanceTimeoutMs); + + membershipManager.groupInstanceId().ifPresent(data::setInstanceId); + + if (this.subscriptions.hasPatternSubscription()) { + // We haven't discsussed how Regex is stored in the consumer. We could do it in the subscriptionState + // , in the memberStateManager, or here. + // data.setSubscribedTopicRegex(regex) + } else { + data.setSubscribedTopicNames(new ArrayList<>(this.subscriptions.subscription())); + } + + if (this.membershipManager.assignorSelection().serverAssignor().isPresent()) { + data.setServerAssignor(this.membershipManager.assignorSelection().serverAssignor().get()); + } + + NetworkClientDelegate.UnsentRequest request = new NetworkClientDelegate.UnsentRequest( + new ConsumerGroupHeartbeatRequest.Builder(data), + coordinatorRequestManager.coordinator()); + + request.future().whenComplete((response, exception) -> { + final long currentTimeMs = time.milliseconds(); + if (exception == null) { + onSuccess((ConsumerGroupHeartbeatResponse) response.responseBody(), currentTimeMs); + } else { + onFailure(exception, currentTimeMs); + } + }); + return request; + } + + private void onFailure(final Throwable exception, final long responseTimeMs) { + this.heartbeatRequestState.onFailedAttempt(responseTimeMs); + logger.debug("failed sending heartbeat due to {}", exception.getMessage()); + } + + private void onSuccess(final ConsumerGroupHeartbeatResponse response, long currentTimeMs) { + if (response.data().errorCode() == Errors.NONE.code()) { + this.heartbeatRequestState.onSuccessfulAttempt(currentTimeMs); + this.heartbeatRequestState.reset(); + try { + membershipManager.updateState(response.data()); + } catch (KafkaException e) { + logger.error("Received unexpected error in heartbeat response: {}", e.getMessage()); + } + return; + } + + onError(response, currentTimeMs); + } + + private void onError(final ConsumerGroupHeartbeatResponse response, + final long currentTimeMs) { + + this.heartbeatRequestState.onFailedAttempt(currentTimeMs); + short errorCode = response.data().errorCode(); + if (errorCode == Errors.NOT_COORDINATOR.code() || errorCode == Errors.COORDINATOR_NOT_AVAILABLE.code()) { + logger.info("GroupHeartbeatRequest failed: coordinator is either not started or not valid. Retrying in " + + "{}ms: {}", + heartbeatRequestState.remainingBackoffMs(currentTimeMs), + response.data().errorMessage()); + coordinatorRequestManager.markCoordinatorUnknown(response.data().errorMessage(), currentTimeMs); + } else if (errorCode == Errors.COORDINATOR_LOAD_IN_PROGRESS.code()) { + // retry + logger.info("GroupHeartbeatRequest failed: Coordinator {} is loading. Retrying in {}ms: {}", + coordinatorRequestManager.coordinator(), + heartbeatRequestState.remainingBackoffMs(currentTimeMs), + response.data().errorMessage()); + } else if (errorCode == Errors.GROUP_AUTHORIZATION_FAILED.code()) { + GroupAuthorizationException error = GroupAuthorizationException.forGroupId(membershipManager.groupId()); + logger.error("GroupHeartbeatRequest failed due to group authorization failure: {}", error.getMessage()); + nonRetriableErrorHandler.handle(error); + } else if (errorCode == Errors.INVALID_REQUEST.code()) { + logger.error("GroupHeartbeatRequest failed due to fatal error: {}", response.data().errorMessage()); + nonRetriableErrorHandler.handle(Errors.INVALID_REQUEST.exception()); + } else if (errorCode == Errors.GROUP_MAX_SIZE_REACHED.code()) { + logger.error("GroupHeartbeatRequest failed due to the max group size limit: {}", + response.data().errorMessage()); + nonRetriableErrorHandler.handle(Errors.GROUP_MAX_SIZE_REACHED.exception()); + } else if (errorCode == Errors.UNSUPPORTED_ASSIGNOR.code()) { + logger.error("GroupHeartbeatRequest failed due to unsupported assignor {}: {}", + membershipManager.assignorSelection(), response.data().errorMessage()); + nonRetriableErrorHandler.handle(Errors.UNSUPPORTED_ASSIGNOR.exception()); + } else if (errorCode == Errors.UNRELEASED_INSTANCE_ID.code()) { + logger.error("GroupHeartbeatRequest failed due to the instance id {} was not released: {}", + membershipManager.groupInstanceId().orElse("null"), + response.data().errorMessage()); + nonRetriableErrorHandler.handle(Errors.UNRELEASED_INSTANCE_ID.exception()); + } + membershipManager.updateState(response.data()); Review Comment: Agree that we need to better define responsibilities. As I see it for now, the membershipMgr should only come into play here when it's time to `updateState`, and that would be : - when no errors in HB response (to extract relevant state info from the response and transition to `Stable`) - when there is a non-retriable error (to transition to `Failed`) Any retriable error received in the HB response would be handled in the heartbeat manager here, while the state remains unchanged (ex. UNJOINED). With this approach, there would error handling in both, the heartbeat manager and the membership manager but for different purposes: - heartbeatManager handles errors to continue retrying the request if needed (until it gets a success or fatal error, in which case it would stop retrying and call `updateState`) - membershipManager `updateState` internally handles fatal errors only, just to update state info accordingly (ex. reset epoch on Fence) and do the right transition. WDYT? -- 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-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
