-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(spanner): add shared endpoint cooldowns for location-aware rerouting #12845
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
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
ea55529
feat(spanner): add shared endpoint cooldowns for location-aware rerou…
rahul2393 2598291
retry unavailable errors on different replica
rahul2393 2463cbf
address comments
rahul2393 7c4bb2e
add EWMA support for stale_reads
rahul2393 1b00d27
support for strong reads
rahul2393 da00277
fix tests
rahul2393 b74b453
add more test for R/W shape
rahul2393 e94496f
more test assertions
rahul2393 85d55c6
fix keep alives
rahul2393 1d893d5
address comments
rahul2393 7811ab0
fix comment
rahul2393 4912eac
speed up tests
rahul2393 26286c0
remove per-request exclusion
rahul2393 944d965
remove unused code
rahul2393 e8bc94a
address comments
rahul2393 eb6a455
Merge branch 'main' into endpoint-cooldown-re
rahul2393 38e76f3
Merge branch 'main' into endpoint-cooldown-re
rahul2393 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
224 changes: 224 additions & 0 deletions
224
...-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/EndpointLatencyRegistry.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,224 @@ | ||
| /* | ||
| * 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 com.google.common.base.Ticker; | ||
| import com.google.common.cache.Cache; | ||
| import com.google.common.cache.CacheBuilder; | ||
| import java.time.Duration; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** Shared process-local latency scores for routed Spanner endpoints. */ | ||
| final class EndpointLatencyRegistry { | ||
| private static final String GLOBAL_SCOPE = "__global__"; | ||
|
|
||
| static final Duration DEFAULT_ERROR_PENALTY = Duration.ofSeconds(10); | ||
| static final Duration DEFAULT_RTT = Duration.ofMillis(10); | ||
| static final double DEFAULT_PENALTY_VALUE = 1_000_000.0; | ||
| @VisibleForTesting static final Duration TRACKER_EXPIRE_AFTER_ACCESS = Duration.ofMinutes(10); | ||
| @VisibleForTesting static final long MAX_TRACKERS = 100_000L; | ||
|
|
||
| private static volatile Cache<TrackerKey, LatencyTracker> TRACKERS = | ||
| newTrackerCache(Ticker.systemTicker()); | ||
|
|
||
| private EndpointLatencyRegistry() {} | ||
|
|
||
| static boolean hasScore( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress) { | ||
| TrackerKey trackerKey = | ||
| trackerKey(databaseScope, operationUid, preferLeader, endpointLabelOrAddress); | ||
| return trackerKey != null && TRACKERS.getIfPresent(trackerKey) != null; | ||
| } | ||
|
|
||
| static double getSelectionCost( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress) { | ||
| return getSelectionCost( | ||
| databaseScope, operationUid, preferLeader, null, endpointLabelOrAddress); | ||
| } | ||
|
|
||
| static double getSelectionCost( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| @javax.annotation.Nullable ChannelEndpoint endpoint, | ||
| String endpointLabelOrAddress) { | ||
| TrackerKey trackerKey = | ||
| trackerKey(databaseScope, operationUid, preferLeader, endpointLabelOrAddress); | ||
| if (trackerKey == null) { | ||
| return Double.MAX_VALUE; | ||
| } | ||
| double activeRequests = endpoint == null ? 0.0 : endpoint.getActiveRequestCount(); | ||
| LatencyTracker tracker = TRACKERS.getIfPresent(trackerKey); | ||
| if (tracker != null) { | ||
| return tracker.getScore() * (activeRequests + 1.0); | ||
| } | ||
| if (activeRequests > 0.0) { | ||
| return DEFAULT_PENALTY_VALUE + activeRequests; | ||
| } | ||
| return defaultRttMicros() * (activeRequests + 1.0); | ||
| } | ||
|
|
||
| static void recordLatency( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress, | ||
| Duration latency) { | ||
| TrackerKey trackerKey = | ||
| trackerKey(databaseScope, operationUid, preferLeader, endpointLabelOrAddress); | ||
| if (trackerKey == null || latency == null) { | ||
| return; | ||
| } | ||
| getOrCreateTracker(trackerKey).update(latency); | ||
| } | ||
|
|
||
| static void recordError( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress) { | ||
| recordError( | ||
| databaseScope, operationUid, preferLeader, endpointLabelOrAddress, DEFAULT_ERROR_PENALTY); | ||
| } | ||
|
|
||
| static void recordError( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress, | ||
| Duration penalty) { | ||
| TrackerKey trackerKey = | ||
| trackerKey(databaseScope, operationUid, preferLeader, endpointLabelOrAddress); | ||
| if (trackerKey == null || penalty == null) { | ||
| return; | ||
| } | ||
| getOrCreateTracker(trackerKey).recordError(penalty); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static void clear() { | ||
| TRACKERS.invalidateAll(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static void useTrackerTicker(Ticker ticker) { | ||
| TRACKERS = newTrackerCache(ticker); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static String normalizeAddress(String endpointLabelOrAddress) { | ||
| if (endpointLabelOrAddress == null || endpointLabelOrAddress.isEmpty()) { | ||
| return null; | ||
| } | ||
| return endpointLabelOrAddress; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static TrackerKey trackerKey( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| String endpointLabelOrAddress) { | ||
| return trackerKey(databaseScope, operationUid, false, endpointLabelOrAddress); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static TrackerKey trackerKey( | ||
| @javax.annotation.Nullable String databaseScope, | ||
| long operationUid, | ||
| boolean preferLeader, | ||
| String endpointLabelOrAddress) { | ||
| String address = normalizeAddress(endpointLabelOrAddress); | ||
| if (operationUid <= 0 || address == null) { | ||
| return null; | ||
| } | ||
| return new TrackerKey(normalizeScope(databaseScope), operationUid, preferLeader, address); | ||
| } | ||
|
|
||
| private static long defaultRttMicros() { | ||
| return DEFAULT_RTT.toNanos() / 1_000L; | ||
| } | ||
|
|
||
| private static String normalizeScope(@javax.annotation.Nullable String databaseScope) { | ||
| return (databaseScope == null || databaseScope.isEmpty()) ? GLOBAL_SCOPE : databaseScope; | ||
| } | ||
|
|
||
| private static LatencyTracker getOrCreateTracker(TrackerKey trackerKey) { | ||
| try { | ||
| return TRACKERS.get(trackerKey, EwmaLatencyTracker::new); | ||
| } catch (ExecutionException e) { | ||
| throw new IllegalStateException("Failed to create latency tracker", e); | ||
| } | ||
| } | ||
|
|
||
| private static Cache<TrackerKey, LatencyTracker> newTrackerCache(Ticker ticker) { | ||
| return CacheBuilder.newBuilder() | ||
| .maximumSize(MAX_TRACKERS) | ||
| .expireAfterAccess(TRACKER_EXPIRE_AFTER_ACCESS.toNanos(), TimeUnit.NANOSECONDS) | ||
| .ticker(ticker) | ||
| .build(); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static final class TrackerKey { | ||
| private final String databaseScope; | ||
| private final long operationUid; | ||
| private final boolean preferLeader; | ||
| private final String address; | ||
|
|
||
| private TrackerKey( | ||
| String databaseScope, long operationUid, boolean preferLeader, String address) { | ||
| this.databaseScope = databaseScope; | ||
| this.operationUid = operationUid; | ||
| this.preferLeader = preferLeader; | ||
| this.address = address; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object other) { | ||
| if (this == other) { | ||
| return true; | ||
| } | ||
| if (!(other instanceof TrackerKey)) { | ||
| return false; | ||
| } | ||
| TrackerKey that = (TrackerKey) other; | ||
| return operationUid == that.operationUid | ||
| && preferLeader == that.preferLeader | ||
| && Objects.equals(databaseScope, that.databaseScope) | ||
| && Objects.equals(address, that.address); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(databaseScope, operationUid, preferLeader, address); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return databaseScope + ":" + operationUid + ":" + preferLeader + "@" + 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
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.
Uh oh!
There was an error while loading. Please reload this page.