feat: Affinity keys cleanup. Allow setting keys lifetime #174
Conversation
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
mohanli-ml
reviewed
May 7, 2024
| @@ -169,12 +170,18 @@ public static class GcpChannelPoolOptions { | |||
| private final int concurrentStreamsLowWatermark; | |||
| // Use round-robin channel selection for affinity binding calls. | |||
| private final boolean useRoundRobinOnBind; | |||
| // How long to keep an affinity key after its last use. | |||
There was a problem hiding this comment.
Nit: my intuition of the term "lifetime" starts when the affinity key creates, not when the affinity key last time used. Maybe change to "lifetime" to "staleTime"?
There was a problem hiding this comment.
I plan to introduce another option like refreshKeyLifetimeOnUse which will default to true but could be turned to false in which case the affinityKeyLifetime will be counted since key creation. So, I'll keep it as affinityKeyLifetime.
mohanli-ml
reviewed
May 7, 2024
| @@ -279,6 +298,37 @@ public Builder setUseRoundRobinOnBind(boolean enabled) { | |||
| this.useRoundRobinOnBind = enabled; | |||
| return this; | |||
| } | |||
|
|
|||
| /** | |||
| * How long to keep an affinity key after its last use. Zero value means keeping keys forever. | |||
There was a problem hiding this comment.
Nit: how about initialize the value as Duration.ofSeconds(long.MAX_VALUE)?
There was a problem hiding this comment.
- We still need to treat zero value somehow. Removing key immediately is not an option. So we either restrict zero value or treat it as it is currently -- disabling keys removal.
- With maxvalue as a default we'll either create an unnecessary timer that will never fire or add a check (as it is now for zero) to not schedule a removal task.
mohanli-ml
approved these changes
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
New config options for channel pool:
With these options we can set time-to-live (since last use) for affinity keys and how often cleanup procedure should run.
Example use case: if we know Cloud Spanner session is valid for ~1h, then we can set up automatic cleanup of old keys (sessions) from the affinity map.