-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(spanner): add shared endpoint cooldowns for location-aware rerouting #12832
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
Open
rahul2393
wants to merge
3
commits into
main
Choose a base branch
from
endpoint-cooldown-re
base: main
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
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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
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
152 changes: 152 additions & 0 deletions
152
...panner/src/main/java/com/google/cloud/spanner/spi/v1/EndpointOverloadCooldownTracker.java
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,152 @@ | ||
| /* | ||
| * Copyright 2026 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.common.annotations.VisibleForTesting; | ||
| import java.time.Clock; | ||
| import java.time.Duration; | ||
| import java.time.Instant; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.concurrent.ThreadLocalRandom; | ||
| import java.util.function.LongUnaryOperator; | ||
|
|
||
| /** | ||
| * Tracks short-lived endpoint cooldowns after routed {@code RESOURCE_EXHAUSTED} failures. | ||
| * | ||
| * <p>This allows later requests to try a different replica instead of immediately routing back to | ||
| * the same overloaded endpoint. | ||
| */ | ||
| final class EndpointOverloadCooldownTracker { | ||
|
|
||
| @VisibleForTesting static final Duration DEFAULT_INITIAL_COOLDOWN = Duration.ofSeconds(10); | ||
| @VisibleForTesting static final Duration DEFAULT_MAX_COOLDOWN = Duration.ofMinutes(1); | ||
| @VisibleForTesting static final Duration DEFAULT_RESET_AFTER = Duration.ofMinutes(10); | ||
|
|
||
| @VisibleForTesting | ||
| static final class CooldownState { | ||
| private final int consecutiveFailures; | ||
| private final Instant cooldownUntil; | ||
| private final Instant lastFailureAt; | ||
|
|
||
| private CooldownState(int consecutiveFailures, Instant cooldownUntil, Instant lastFailureAt) { | ||
| this.consecutiveFailures = consecutiveFailures; | ||
| this.cooldownUntil = cooldownUntil; | ||
| this.lastFailureAt = lastFailureAt; | ||
| } | ||
| } | ||
|
|
||
| private final ConcurrentHashMap<String, CooldownState> entries = new ConcurrentHashMap<>(); | ||
| private final Duration initialCooldown; | ||
| private final Duration maxCooldown; | ||
| private final Duration resetAfter; | ||
| private final Clock clock; | ||
| private final LongUnaryOperator randomLong; | ||
|
|
||
| EndpointOverloadCooldownTracker() { | ||
| this( | ||
| DEFAULT_INITIAL_COOLDOWN, | ||
| DEFAULT_MAX_COOLDOWN, | ||
| DEFAULT_RESET_AFTER, | ||
| Clock.systemUTC(), | ||
| bound -> ThreadLocalRandom.current().nextLong(bound)); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| EndpointOverloadCooldownTracker( | ||
| Duration initialCooldown, | ||
| Duration maxCooldown, | ||
| Duration resetAfter, | ||
| Clock clock, | ||
| LongUnaryOperator randomLong) { | ||
| Duration resolvedInitial = | ||
| (initialCooldown == null || initialCooldown.isZero() || initialCooldown.isNegative()) | ||
| ? DEFAULT_INITIAL_COOLDOWN | ||
| : initialCooldown; | ||
| Duration resolvedMax = | ||
| (maxCooldown == null || maxCooldown.isZero() || maxCooldown.isNegative()) | ||
| ? DEFAULT_MAX_COOLDOWN | ||
| : maxCooldown; | ||
| if (resolvedMax.compareTo(resolvedInitial) < 0) { | ||
| resolvedMax = resolvedInitial; | ||
| } | ||
| this.initialCooldown = resolvedInitial; | ||
| this.maxCooldown = resolvedMax; | ||
| this.resetAfter = | ||
| (resetAfter == null || resetAfter.isZero() || resetAfter.isNegative()) | ||
| ? DEFAULT_RESET_AFTER | ||
| : resetAfter; | ||
| this.clock = clock == null ? Clock.systemUTC() : clock; | ||
| this.randomLong = | ||
| randomLong == null ? bound -> ThreadLocalRandom.current().nextLong(bound) : randomLong; | ||
| } | ||
|
|
||
| boolean isCoolingDown(String address) { | ||
| if (address == null || address.isEmpty()) { | ||
| return false; | ||
| } | ||
| Instant now = clock.instant(); | ||
| CooldownState state = entries.get(address); | ||
| if (state == null) { | ||
| return false; | ||
| } | ||
| if (state.cooldownUntil.isAfter(now)) { | ||
| return true; | ||
| } | ||
| if (Duration.between(state.lastFailureAt, now).compareTo(resetAfter) < 0) { | ||
| return false; | ||
| } | ||
| entries.remove(address, state); | ||
| CooldownState current = entries.get(address); | ||
| return current != null && current.cooldownUntil.isAfter(now); | ||
| } | ||
|
|
||
| void recordFailure(String address) { | ||
| if (address == null || address.isEmpty()) { | ||
| return; | ||
| } | ||
| Instant now = clock.instant(); | ||
| entries.compute( | ||
| address, | ||
| (ignored, state) -> { | ||
| int consecutiveFailures = 1; | ||
| if (state != null | ||
| && Duration.between(state.lastFailureAt, now).compareTo(resetAfter) < 0) { | ||
| consecutiveFailures = state.consecutiveFailures + 1; | ||
| } | ||
| Duration cooldown = cooldownForFailures(consecutiveFailures); | ||
| return new CooldownState(consecutiveFailures, now.plus(cooldown), now); | ||
| }); | ||
| } | ||
|
|
||
| private Duration cooldownForFailures(int failures) { | ||
| Duration cooldown = initialCooldown; | ||
| for (int i = 1; i < failures; i++) { | ||
| if (cooldown.compareTo(maxCooldown.dividedBy(2)) > 0) { | ||
| cooldown = maxCooldown; | ||
| break; | ||
| } | ||
| cooldown = cooldown.multipliedBy(2); | ||
| } | ||
| long bound = Math.max(1L, cooldown.toMillis() + 1L); | ||
| return Duration.ofMillis(randomLong.applyAsLong(bound)); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| CooldownState getState(String address) { | ||
| return entries.get(address); | ||
| } | ||
| } |
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
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.
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.
Adding
RESOURCE_EXHAUSTEDto the default retryable codes for all streaming reads is a significant change that affects all users of the library, not just those using location-aware routing. While this enables the rerouting logic for overloaded replicas, it also means that anyRESOURCE_EXHAUSTEDerror (including those due to administrative quotas) will now be retried by the GAX layer. This might lead to increased latency and unnecessary retries for permanent quota issues. Consider if this can be scoped only to location-aware calls or if the implications for non-routed traffic are acceptable.References