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
fix: reduce the probability of RESOURCE_EXHAUSTED errors during tests #734
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
da8b666
fix: reduce the probability of RESOURCE_EXHAUSTED errors during tests
olavloite 85ca679
fix: use default retry settings
olavloite 167ae14
chore: run formatter
olavloite c8fef88
Merge branch 'master' into reduce-resource-exhausted-errors
olavloite 918d4af
Merge branch 'master' into reduce-resource-exhausted-errors
olavloite 76bcbec
fix: only retry RESOURCE_EXHAUSTED when throttling requests
olavloite File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
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
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -26,6 +26,8 @@ | |||||||||||||
import com.google.api.gax.core.GaxProperties; | ||||||||||||||
import com.google.api.gax.grpc.GaxGrpcProperties; | ||||||||||||||
import com.google.api.gax.grpc.GrpcCallContext; | ||||||||||||||
import com.google.api.gax.grpc.GrpcCallSettings; | ||||||||||||||
import com.google.api.gax.grpc.GrpcStubCallableFactory; | ||||||||||||||
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider; | ||||||||||||||
import com.google.api.gax.longrunning.OperationFuture; | ||||||||||||||
import com.google.api.gax.retrying.ResultRetryAlgorithm; | ||||||||||||||
|
@@ -35,6 +37,7 @@ | |||||||||||||
import com.google.api.gax.rpc.ApiCallContext; | ||||||||||||||
import com.google.api.gax.rpc.ApiClientHeaderProvider; | ||||||||||||||
import com.google.api.gax.rpc.ApiException; | ||||||||||||||
import com.google.api.gax.rpc.ClientContext; | ||||||||||||||
import com.google.api.gax.rpc.HeaderProvider; | ||||||||||||||
import com.google.api.gax.rpc.InstantiatingWatchdogProvider; | ||||||||||||||
import com.google.api.gax.rpc.OperationCallable; | ||||||||||||||
|
@@ -43,6 +46,8 @@ | |||||||||||||
import com.google.api.gax.rpc.StatusCode; | ||||||||||||||
import com.google.api.gax.rpc.StreamController; | ||||||||||||||
import com.google.api.gax.rpc.TransportChannelProvider; | ||||||||||||||
import com.google.api.gax.rpc.UnaryCallSettings; | ||||||||||||||
import com.google.api.gax.rpc.UnaryCallable; | ||||||||||||||
import com.google.api.gax.rpc.UnavailableException; | ||||||||||||||
import com.google.api.gax.rpc.WatchdogProvider; | ||||||||||||||
import com.google.api.pathtemplate.PathTemplate; | ||||||||||||||
|
@@ -58,7 +63,7 @@ | |||||||||||||
import com.google.cloud.spanner.SpannerOptions.CallCredentialsProvider; | ||||||||||||||
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub; | ||||||||||||||
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings; | ||||||||||||||
import com.google.cloud.spanner.admin.database.v1.stub.GrpcDatabaseAdminStub; | ||||||||||||||
import com.google.cloud.spanner.admin.database.v1.stub.GrpcDatabaseAdminCallableFactory; | ||||||||||||||
import com.google.cloud.spanner.admin.instance.v1.stub.GrpcInstanceAdminStub; | ||||||||||||||
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub; | ||||||||||||||
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings; | ||||||||||||||
|
@@ -70,6 +75,7 @@ | |||||||||||||
import com.google.common.base.MoreObjects; | ||||||||||||||
import com.google.common.base.Preconditions; | ||||||||||||||
import com.google.common.collect.ImmutableList; | ||||||||||||||
import com.google.common.collect.ImmutableSet; | ||||||||||||||
import com.google.common.util.concurrent.RateLimiter; | ||||||||||||||
import com.google.common.util.concurrent.ThreadFactoryBuilder; | ||||||||||||||
import com.google.iam.v1.GetIamPolicyRequest; | ||||||||||||||
|
@@ -155,6 +161,7 @@ | |||||||||||||
import java.util.LinkedList; | ||||||||||||||
import java.util.List; | ||||||||||||||
import java.util.Map; | ||||||||||||||
import java.util.Set; | ||||||||||||||
import java.util.concurrent.Callable; | ||||||||||||||
import java.util.concurrent.CancellationException; | ||||||||||||||
import java.util.concurrent.ConcurrentHashMap; | ||||||||||||||
|
@@ -428,7 +435,37 @@ public GapicSpannerRpc(final SpannerOptions options) { | |||||||||||||
.setCredentialsProvider(credentialsProvider) | ||||||||||||||
.setStreamWatchdogProvider(watchdogProvider) | ||||||||||||||
.build(); | ||||||||||||||
this.databaseAdminStub = GrpcDatabaseAdminStub.create(this.databaseAdminStubSettings); | ||||||||||||||
GrpcStubCallableFactory factory = | ||||||||||||||
new GrpcDatabaseAdminCallableFactory() { | ||||||||||||||
@Override | ||||||||||||||
public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable( | ||||||||||||||
GrpcCallSettings<RequestT, ResponseT> grpcCallSettings, | ||||||||||||||
UnaryCallSettings<RequestT, ResponseT> callSettings, | ||||||||||||||
ClientContext clientContext) { | ||||||||||||||
// Make GetOperation retry on RESOURCE_EXHAUSTED to prevent polling operations from | ||||||||||||||
// failing with an Administrative requests limit exceeded error. | ||||||||||||||
if (grpcCallSettings | ||||||||||||||
.getMethodDescriptor() | ||||||||||||||
.getFullMethodName() | ||||||||||||||
.equals("google.longrunning.Operations/GetOperation")) { | ||||||||||||||
Set<StatusCode.Code> codes = | ||||||||||||||
ImmutableSet.<StatusCode.Code>builderWithExpectedSize( | ||||||||||||||
callSettings.getRetryableCodes().size() + 1) | ||||||||||||||
.addAll(callSettings.getRetryableCodes()) | ||||||||||||||
.add(StatusCode.Code.RESOURCE_EXHAUSTED) | ||||||||||||||
.build(); | ||||||||||||||
callSettings = | ||||||||||||||
callSettings | ||||||||||||||
.toBuilder() | ||||||||||||||
.setRetryableCodes(codes) | ||||||||||||||
.build(); | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
} | ||||||||||||||
return super.createUnaryCallable(grpcCallSettings, callSettings, clientContext); | ||||||||||||||
} | ||||||||||||||
}; | ||||||||||||||
this.databaseAdminStub = | ||||||||||||||
new GrpcDatabaseAdminStubWithCustomCallableFactory( | ||||||||||||||
databaseAdminStubSettings, ClientContext.create(databaseAdminStubSettings), factory); | ||||||||||||||
|
||||||||||||||
// Check whether the SPANNER_EMULATOR_HOST env var has been set, and if so, if the emulator is | ||||||||||||||
// actually running. | ||||||||||||||
|
@@ -487,9 +524,9 @@ private static void checkEmulatorConnection( | |||||||||||||
|
||||||||||||||
private static final RetrySettings ADMIN_REQUESTS_LIMIT_EXCEEDED_RETRY_SETTINGS = | ||||||||||||||
RetrySettings.newBuilder() | ||||||||||||||
.setInitialRetryDelay(Duration.ofSeconds(2L)) | ||||||||||||||
.setRetryDelayMultiplier(1.5) | ||||||||||||||
.setMaxRetryDelay(Duration.ofSeconds(15L)) | ||||||||||||||
.setInitialRetryDelay(Duration.ofSeconds(5L)) | ||||||||||||||
.setRetryDelayMultiplier(2.0) | ||||||||||||||
.setMaxRetryDelay(Duration.ofSeconds(60L)) | ||||||||||||||
.setMaxAttempts(10) | ||||||||||||||
.build(); | ||||||||||||||
|
||||||||||||||
|
@@ -1004,6 +1041,11 @@ public OperationFuture<Empty, UpdateDatabaseDdlMetadata> call() throws Exception | |||||||||||||
throw newSpannerException(e); | ||||||||||||||
} catch (ExecutionException e) { | ||||||||||||||
Throwable t = e.getCause(); | ||||||||||||||
SpannerException se = SpannerExceptionFactory.asSpannerException(t); | ||||||||||||||
if (se instanceof AdminRequestsPerMinuteExceededException) { | ||||||||||||||
// Propagate this to trigger a retry. | ||||||||||||||
throw se; | ||||||||||||||
} | ||||||||||||||
if (t instanceof AlreadyExistsException) { | ||||||||||||||
String operationName = | ||||||||||||||
OPERATION_NAME_TEMPLATE.instantiate( | ||||||||||||||
|
37 changes: 37 additions & 0 deletions
37
.../java/com/google/cloud/spanner/spi/v1/GrpcDatabaseAdminStubWithCustomCallableFactory.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,37 @@ | ||
/* | ||
* Copyright 2020 Google LLC | ||
* | ||
* Licensed 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.google.cloud.spanner.spi.v1; | ||
|
||
import com.google.api.gax.grpc.GrpcStubCallableFactory; | ||
import com.google.api.gax.rpc.ClientContext; | ||
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings; | ||
import com.google.cloud.spanner.admin.database.v1.stub.GrpcDatabaseAdminStub; | ||
import java.io.IOException; | ||
|
||
/** | ||
* Wrapper around {@link GrpcDatabaseAdminStub} to make the constructor available inside this | ||
* package. | ||
*/ | ||
class GrpcDatabaseAdminStubWithCustomCallableFactory extends GrpcDatabaseAdminStub { | ||
GrpcDatabaseAdminStubWithCustomCallableFactory( | ||
DatabaseAdminStubSettings settings, | ||
ClientContext clientContext, | ||
GrpcStubCallableFactory callableFactory) | ||
throws IOException { | ||
super(settings, clientContext, callableFactory); | ||
} | ||
} |
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.
It would be preferable if this could be changed in the generated code, but I don't know whether that is possible considering this comes from the generic
com.google.longrunning.stub.OperationsStub
.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.
It seems we would need this only for fixing the tests (correct me if I am wrong). If that is the case, changing production behaviour to fix those might not be the best path forward. Could we inject different behaviour in test only.
On another note, do we still need this change now that the tests seem to be working as expected?
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've updated the PR to only change this behavior if
SpannerOptions#setAutoThrottleAdministrativeRequests
has been set. This means that it will only be enabled for (integration) tests.