forked from apache/cassandra-java-driver
-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
4.x: Introduce exponential retry backoff policy #483
Open
dkropachev
wants to merge
1
commit into
scylladb:scylla-4.x
Choose a base branch
from
dkropachev:dk/4.x-add-exponential-retry-backoff-policy
base: scylla-4.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
185 changes: 185 additions & 0 deletions
185
core/src/main/java/com/datastax/oss/driver/api/core/retry/BackoffRetryPolicy.java
This file contains 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,185 @@ | ||
| /* | ||
| * 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 com.datastax.oss.driver.api.core.retry; | ||
|
|
||
| import com.datastax.oss.driver.api.core.ConsistencyLevel; | ||
| import com.datastax.oss.driver.api.core.connection.ClosedConnectionException; | ||
| import com.datastax.oss.driver.api.core.connection.HeartbeatException; | ||
| import com.datastax.oss.driver.api.core.loadbalancing.LoadBalancingPolicy; | ||
| import com.datastax.oss.driver.api.core.servererrors.BootstrappingException; | ||
| import com.datastax.oss.driver.api.core.servererrors.CoordinatorException; | ||
| import com.datastax.oss.driver.api.core.servererrors.FunctionFailureException; | ||
| import com.datastax.oss.driver.api.core.servererrors.OverloadedException; | ||
| import com.datastax.oss.driver.api.core.servererrors.ProtocolError; | ||
| import com.datastax.oss.driver.api.core.servererrors.QueryValidationException; | ||
| import com.datastax.oss.driver.api.core.servererrors.ReadFailureException; | ||
| import com.datastax.oss.driver.api.core.servererrors.ReadTimeoutException; | ||
| import com.datastax.oss.driver.api.core.servererrors.ServerError; | ||
| import com.datastax.oss.driver.api.core.servererrors.TruncateException; | ||
| import com.datastax.oss.driver.api.core.servererrors.WriteFailureException; | ||
| import com.datastax.oss.driver.api.core.servererrors.WriteType; | ||
| import com.datastax.oss.driver.api.core.session.Request; | ||
| import edu.umd.cs.findbugs.annotations.NonNull; | ||
|
|
||
| /** | ||
| * Defines the behavior to adopt when a request fails. | ||
| * | ||
| * <p>For each request, the driver gets a "query plan" (a list of coordinators to try) from the | ||
| * {@link LoadBalancingPolicy}, and tries each node in sequence. This policy is invoked if the | ||
| * request to that node fails. | ||
| * | ||
| * <p>The methods of this interface are invoked on I/O threads, therefore <b>implementations should | ||
| * never block</b>. In particular, don't call {@link Thread#sleep(long)} to retry after a delay: | ||
| * this would prevent asynchronous processing of other requests, and very negatively impact | ||
| * throughput. If the application needs to back off and retry later, this should be implemented in | ||
| * client code, not in this policy. | ||
| */ | ||
| public interface BackoffRetryPolicy extends AutoCloseable { | ||
| /** | ||
| * Whether to retry when the server replied with a {@code READ_TIMEOUT} error; this indicates a | ||
| * <b>server-side</b> timeout during a read query, i.e. some replicas did not reply to the | ||
| * coordinator in time. | ||
| * | ||
| * @param request the request that timed out. | ||
| * @param cl the requested consistency level. | ||
| * @param blockFor the minimum number of replica acknowledgements/responses that were required to | ||
| * fulfill the operation. | ||
| * @param received the number of replica that had acknowledged/responded to the operation before | ||
| * it failed. | ||
| * @param dataPresent whether the actual data was amongst the received replica responses. See | ||
| * {@link ReadTimeoutException#wasDataPresent()}. | ||
| * @param retryCount how many times the retry policy has been invoked already for this request | ||
| * (not counting the current invocation). | ||
| */ | ||
| int onReadTimeoutBackoffMs( | ||
| @NonNull Request request, | ||
| @NonNull ConsistencyLevel cl, | ||
| int blockFor, | ||
| int received, | ||
| boolean dataPresent, | ||
| int retryCount, | ||
| RetryVerdict verdict); | ||
|
|
||
| /** | ||
| * Whether to retry when the server replied with a {@code WRITE_TIMEOUT} error; this indicates a | ||
| * <b>server-side</b> timeout during a write query, i.e. some replicas did not reply to the | ||
| * coordinator in time. | ||
| * | ||
| * <p>Note that this method will only be invoked for {@link Request#isIdempotent()} idempotent} | ||
| * requests: when a write times out, it is impossible to determine with 100% certainty whether the | ||
| * mutation was applied or not, so the write is never safe to retry; the driver will rethrow the | ||
| * error directly, without invoking the retry policy. | ||
| * | ||
| * @param request the request that timed out. | ||
| * @param cl the requested consistency level. | ||
| * @param writeType the type of the write for which the timeout was raised. | ||
| * @param blockFor the minimum number of replica acknowledgements/responses that were required to | ||
| * fulfill the operation. | ||
| * @param received the number of replica that had acknowledged/responded to the operation before | ||
| * it failed. | ||
| * @param retryCount how many times the retry policy has been invoked already for this request | ||
| * (not counting the current invocation). | ||
| */ | ||
| int onWriteTimeoutBackoffMs( | ||
| @NonNull Request request, | ||
| @NonNull ConsistencyLevel cl, | ||
| @NonNull WriteType writeType, | ||
| int blockFor, | ||
| int received, | ||
| int retryCount, | ||
| RetryVerdict verdict); | ||
|
|
||
| /** | ||
| * Whether to retry when the server replied with an {@code UNAVAILABLE} error; this indicates that | ||
| * the coordinator determined that there were not enough replicas alive to perform a query with | ||
| * the requested consistency level. | ||
| * | ||
| * @param request the request that timed out. | ||
| * @param cl the requested consistency level. | ||
| * @param required the number of replica acknowledgements/responses required to perform the | ||
| * operation (with its required consistency level). | ||
| * @param alive the number of replicas that were known to be alive by the coordinator node when it | ||
| * tried to execute the operation. | ||
| * @param retryCount how many times the retry policy has been invoked already for this request | ||
| * (not counting the current invocation). | ||
| */ | ||
| int onUnavailableBackoffMs( | ||
| @NonNull Request request, | ||
| @NonNull ConsistencyLevel cl, | ||
| int required, | ||
| int alive, | ||
| int retryCount, | ||
| RetryVerdict verdict); | ||
|
|
||
| /** | ||
| * Whether to retry when a request was aborted before we could get a response from the server. | ||
| * | ||
| * <p>This can happen in two cases: if the connection was closed due to an external event (this | ||
| * will manifest as a {@link ClosedConnectionException}, or {@link HeartbeatException} for a | ||
| * heartbeat failure); or if there was an unexpected error while decoding the response (this can | ||
| * only be a driver bug). | ||
| * | ||
| * <p>Note that this method will only be invoked for {@linkplain Request#isIdempotent() | ||
| * idempotent} requests: when execution was aborted before getting a response, it is impossible to | ||
| * determine with 100% certainty whether a mutation was applied or not, so a write is never safe | ||
| * to retry; the driver will rethrow the error directly, without invoking the retry policy. | ||
| * | ||
| * @param request the request that was aborted. | ||
| * @param error the error. | ||
| * @param retryCount how many times the retry policy has been invoked already for this request | ||
| * (not counting the current invocation). | ||
| */ | ||
| int onRequestAbortedBackoffMs( | ||
| @NonNull Request request, @NonNull Throwable error, int retryCount, RetryVerdict verdict); | ||
|
|
||
| /** | ||
| * Whether to retry when the server replied with a recoverable error (other than {@code | ||
| * READ_TIMEOUT}, {@code WRITE_TIMEOUT} or {@code UNAVAILABLE}). | ||
| * | ||
| * <p>This can happen for the following errors: {@link OverloadedException}, {@link ServerError}, | ||
| * {@link TruncateException}, {@link ReadFailureException}, {@link WriteFailureException}. | ||
| * | ||
| * <p>The following errors are handled internally by the driver, and therefore will <b>never</b> | ||
| * be encountered in this method: | ||
| * | ||
| * <ul> | ||
| * <li>{@link BootstrappingException}: always retried on the next node; | ||
| * <li>{@link QueryValidationException} (and its subclasses), {@link FunctionFailureException} | ||
| * and {@link ProtocolError}: always rethrown. | ||
| * </ul> | ||
| * | ||
| * <p>Note that this method will only be invoked for {@link Request#isIdempotent()} idempotent} | ||
| * requests: when execution was aborted before getting a response, it is impossible to determine | ||
| * with 100% certainty whether a mutation was applied or not, so a write is never safe to retry; | ||
| * the driver will rethrow the error directly, without invoking the retry policy. | ||
| * | ||
| * @param request the request that failed. | ||
| * @param error the error. | ||
| * @param retryCount how many times the retry policy has been invoked already for this request | ||
| * (not counting the current invocation). | ||
| */ | ||
| int onErrorResponseBackoff( | ||
| @NonNull Request request, | ||
| @NonNull CoordinatorException error, | ||
| int retryCount, | ||
| RetryVerdict verdict); | ||
|
|
||
| /** Called when the cluster that this policy is associated with closes. */ | ||
| @Override | ||
| void close(); | ||
| } |
32 changes: 32 additions & 0 deletions
32
core/src/main/java/com/datastax/oss/driver/api/core/retry/BackoffRetryVerdict.java
This file contains 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,32 @@ | ||
| /* | ||
| * 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 com.datastax.oss.driver.api.core.retry; | ||
|
|
||
| import java.time.Duration; | ||
|
|
||
| /** | ||
| * The verdict returned by a {@link RetryPolicy} determining what to do when a request failed. A | ||
| * verdict contains a {@link RetryDecision} indicating if a retry should be attempted at all and | ||
| * where, with what delay, and a method that allows the original request to be modified before the | ||
| * retry. | ||
| */ | ||
| public interface BackoffRetryVerdict extends RetryVerdict { | ||
|
|
||
| /** @return a delay that request needs to take before retrying. */ | ||
| Duration getRetryBackoff(); | ||
| } |
This file contains 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
This file contains 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.
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.
Descriptions here look incorrect