Multiendpoint #63
Merged
Multiendpoint #63
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
lasradoVinod
reviewed
Nov 3, 2023
grpcgcp/gcp_multiendpoint.go
Outdated
| var meKey contextMEKey | ||
|
|
||
| // NewMEContext returns a new Context that carries Multiendpoint name meName. | ||
| func NewMEContext(ctx context.Context, meName string) context.Context { |
There was a problem hiding this comment.
I think the function argument can just be called name. Since the package is called multiendpoint I don't think you need to preface all the variables with me.
There was a problem hiding this comment.
Yeah, I was worried that the name can be confused with an endpoint (although endpoints don't have a name and we never refer to an endpoint address and port as a name). Will change the name and doc comment.
| } | ||
|
|
||
| // SetEndpointAvailable updates the state of an endpoint. | ||
| func (me *multiEndpoint) SetEndpointAvailable(e string, avail bool) { |
There was a problem hiding this comment.
Maybe we can change the name to SetEndpointAvailability since you are taking in a boolean.
lasradoVinod
approved these changes
Nov 14, 2023
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.
The purposes of GcpMultiEndpoint are:
endpoint is completely unavailable.
A group of endpoints is called a [multiendpoint.MultiEndpoint] and is essentially a list of endpoints where priority is defined by the position in the list with the first endpoint having top priority. A MultiEndpoint tracks endpoints' availability. When a MultiEndpoint is picked for an RPC call, it picks the top priority endpoint that is currently available. More information on the [multiendpoint.MultiEndpoint].
GCPMultiEndpoint can have one or more MultiEndpoint identified by its name -- arbitrary string provided in the [GCPMultiEndpointOptions] when configuring MultiEndpoints. This name can be used to route an RPC call to this MultiEndpoint by using the [NewMEContext].
GCPMultiEndpoint uses [GCPMultiEndpointOptions] for initial configuration. An updated configuration can be provided at any time later using [UpdateMultiEndpoints].
Example:
Let's assume we have a service with read and write operations and the following backends:
Example configuration:
MultiEndpoint named "default" with endpoints:
service.example.com:443
service-fallback.example.com:443
MultiEndpoint named "read" with endpoints:
ro-service.example.com:443
service-fallback.example.com:443
service.example.com:443
With the configuration above GCPMultiEndpoint will use the "default" MultiEndpoint by default. It means that RPC calls by default will use the main endpoint and if it is not available then the read-write replica.
To offload some read calls to the read-only replica we can specify "read" MultiEndpoint in the context. Then these calls will use the read-only replica endpoint and if it is not available then the read-write replica and if it is also not available then the main endpoint.
GCPMultiEndpoint creates a [grpcgcp] connection pool for every unique endpoint. For the example above three connection pools will be created.
[GCPMultiEndpoint] implements [grpc.ClientConnInterface] and can be used as a [grpc.ClientConn] when creating gRPC clients.