snapshot of https://github.com/grpc/grpc-go.git (master, 2026-09-15; blobs > 131072B omitted)
Some checks failed
codecov / upload (push) Failing after 13m59s
CodeQL / Analyze (push) Failing after 1s
Testing / vet-proto (push) Failing after 1s
Testing / tests (arm, latest) (push) Waiting to run
Testing / extras (latest) (push) Failing after 1s
Testing / static checks (latest-1) (push) Failing after 1s
Testing / tests (-race, latest) (push) Failing after 1s
Testing / tests (i386, latest) (push) Failing after 1s
Testing / tests (latest) (push) Failing after 1s
Testing / tests (latest-1) (push) Failing after 1s
Lock Threads / lock (push) Failing after 1s
govulncheck / govulncheck (.) (push) Failing after 1s
govulncheck / govulncheck (./cmd/protoc-gen-go-grpc) (push) Failing after 1s
govulncheck / govulncheck (./gcp/observability) (push) Failing after 1s
govulncheck / govulncheck (./security/advancedtls) (push) Failing after 1s
govulncheck / govulncheck (./stats/opencensus) (push) Failing after 1s
Stale bot / stale (push) Failing after 1s
Some checks failed
codecov / upload (push) Failing after 13m59s
CodeQL / Analyze (push) Failing after 1s
Testing / vet-proto (push) Failing after 1s
Testing / tests (arm, latest) (push) Waiting to run
Testing / extras (latest) (push) Failing after 1s
Testing / static checks (latest-1) (push) Failing after 1s
Testing / tests (-race, latest) (push) Failing after 1s
Testing / tests (i386, latest) (push) Failing after 1s
Testing / tests (latest) (push) Failing after 1s
Testing / tests (latest-1) (push) Failing after 1s
Lock Threads / lock (push) Failing after 1s
govulncheck / govulncheck (.) (push) Failing after 1s
govulncheck / govulncheck (./cmd/protoc-gen-go-grpc) (push) Failing after 1s
govulncheck / govulncheck (./gcp/observability) (push) Failing after 1s
govulncheck / govulncheck (./security/advancedtls) (push) Failing after 1s
govulncheck / govulncheck (./stats/opencensus) (push) Failing after 1s
Stale bot / stale (push) Failing after 1s
This commit is contained in:
34
balancer/weightedtarget/logging.go
Normal file
34
balancer/weightedtarget/logging.go
Normal file
@@ -0,0 +1,34 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2020 gRPC authors.
|
||||
*
|
||||
* 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 weightedtarget
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"google.golang.org/grpc/grpclog"
|
||||
internalgrpclog "google.golang.org/grpc/internal/grpclog"
|
||||
)
|
||||
|
||||
const prefix = "[weighted-target-lb %p] "
|
||||
|
||||
var logger = grpclog.Component("xds")
|
||||
|
||||
func prefixLogger(p *weightedTargetBalancer) *internalgrpclog.PrefixLogger {
|
||||
return internalgrpclog.NewPrefixLogger(logger, fmt.Sprintf(prefix, p))
|
||||
}
|
||||
318
balancer/weightedtarget/weightedaggregator/aggregator.go
Normal file
318
balancer/weightedtarget/weightedaggregator/aggregator.go
Normal file
@@ -0,0 +1,318 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2020 gRPC authors.
|
||||
*
|
||||
* 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 weightedaggregator implements state aggregator for weighted_target
|
||||
// balancer.
|
||||
//
|
||||
// This is a separate package so it can be shared by weighted_target and eds.
|
||||
// The eds balancer will be refactored to use weighted_target directly. After
|
||||
// that, all functions and structs in this package can be moved to package
|
||||
// weightedtarget and unexported.
|
||||
package weightedaggregator
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"sync"
|
||||
|
||||
"google.golang.org/grpc/balancer"
|
||||
"google.golang.org/grpc/balancer/base"
|
||||
"google.golang.org/grpc/connectivity"
|
||||
"google.golang.org/grpc/internal/grpclog"
|
||||
"google.golang.org/grpc/internal/wrr"
|
||||
)
|
||||
|
||||
type weightedPickerState struct {
|
||||
weight uint32
|
||||
state balancer.State
|
||||
// stateToAggregate is the connectivity state used only for state
|
||||
// aggregation. It could be different from state.ConnectivityState. For
|
||||
// example when a sub-balancer transitions from TransientFailure to
|
||||
// connecting, state.ConnectivityState is Connecting, but stateToAggregate
|
||||
// is still TransientFailure.
|
||||
stateToAggregate connectivity.State
|
||||
}
|
||||
|
||||
func (s *weightedPickerState) String() string {
|
||||
return fmt.Sprintf("weight:%v,picker:%p,state:%v,stateToAggregate:%v", s.weight, s.state.Picker, s.state.ConnectivityState, s.stateToAggregate)
|
||||
}
|
||||
|
||||
// Aggregator is the weighted balancer state aggregator.
|
||||
type Aggregator struct {
|
||||
cc balancer.ClientConn
|
||||
logger *grpclog.PrefixLogger
|
||||
newWRR func() wrr.WRR
|
||||
|
||||
csEvltr *balancer.ConnectivityStateEvaluator
|
||||
|
||||
mu sync.Mutex
|
||||
// If started is false, no updates should be sent to the parent cc. A closed
|
||||
// sub-balancer could still send pickers to this aggregator. This makes sure
|
||||
// that no updates will be forwarded to parent when the whole balancer group
|
||||
// and states aggregator is closed.
|
||||
started bool
|
||||
// All balancer IDs exist as keys in this map, even if balancer group is not
|
||||
// started.
|
||||
//
|
||||
// If an ID is not in map, it's either removed or never added.
|
||||
idToPickerState map[string]*weightedPickerState
|
||||
// Set when UpdateState call propagation is paused.
|
||||
pauseUpdateState bool
|
||||
// Set when UpdateState call propagation is paused and an UpdateState call
|
||||
// is suppressed.
|
||||
needUpdateStateOnResume bool
|
||||
}
|
||||
|
||||
// New creates a new weighted balancer state aggregator.
|
||||
func New(cc balancer.ClientConn, logger *grpclog.PrefixLogger, newWRR func() wrr.WRR) *Aggregator {
|
||||
return &Aggregator{
|
||||
cc: cc,
|
||||
logger: logger,
|
||||
newWRR: newWRR,
|
||||
csEvltr: &balancer.ConnectivityStateEvaluator{},
|
||||
idToPickerState: make(map[string]*weightedPickerState),
|
||||
}
|
||||
}
|
||||
|
||||
// Start starts the aggregator. It can be called after Stop to restart the
|
||||
// aggregator.
|
||||
func (wbsa *Aggregator) Start() {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.started = true
|
||||
}
|
||||
|
||||
// Stop stops the aggregator. When the aggregator is stopped, it won't call
|
||||
// parent ClientConn to update balancer state.
|
||||
func (wbsa *Aggregator) Stop() {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.started = false
|
||||
wbsa.clearStates()
|
||||
}
|
||||
|
||||
// Add adds a sub-balancer state with weight. It adds a place holder, and waits for
|
||||
// the real sub-balancer to update state.
|
||||
func (wbsa *Aggregator) Add(id string, weight uint32) {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.idToPickerState[id] = &weightedPickerState{
|
||||
weight: weight,
|
||||
// Start everything in CONNECTING, so if one of the sub-balancers
|
||||
// reports TransientFailure, the RPCs will still wait for the other
|
||||
// sub-balancers.
|
||||
state: balancer.State{
|
||||
ConnectivityState: connectivity.Connecting,
|
||||
Picker: base.NewErrPicker(balancer.ErrNoSubConnAvailable),
|
||||
},
|
||||
stateToAggregate: connectivity.Connecting,
|
||||
}
|
||||
wbsa.csEvltr.RecordTransition(connectivity.Shutdown, connectivity.Connecting)
|
||||
|
||||
wbsa.buildAndUpdateLocked()
|
||||
}
|
||||
|
||||
// Remove removes the sub-balancer state. Future updates from this sub-balancer,
|
||||
// if any, will be ignored.
|
||||
func (wbsa *Aggregator) Remove(id string) {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
if _, ok := wbsa.idToPickerState[id]; !ok {
|
||||
return
|
||||
}
|
||||
// Setting the state of the deleted sub-balancer to Shutdown will get csEvltr
|
||||
// to remove the previous state for any aggregated state evaluations.
|
||||
// transitions to and from connectivity.Shutdown are ignored by csEvltr.
|
||||
wbsa.csEvltr.RecordTransition(wbsa.idToPickerState[id].stateToAggregate, connectivity.Shutdown)
|
||||
// Remove id and picker from picker map. This also results in future updates
|
||||
// for this ID to be ignored.
|
||||
delete(wbsa.idToPickerState, id)
|
||||
wbsa.buildAndUpdateLocked()
|
||||
}
|
||||
|
||||
// UpdateWeight updates the weight for the given id. Note that this doesn't
|
||||
// trigger an update to the parent ClientConn. The caller should decide when
|
||||
// it's necessary, and call BuildAndUpdate.
|
||||
func (wbsa *Aggregator) UpdateWeight(id string, newWeight uint32) {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
pState, ok := wbsa.idToPickerState[id]
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
pState.weight = newWeight
|
||||
}
|
||||
|
||||
// PauseStateUpdates causes UpdateState calls to not propagate to the parent
|
||||
// ClientConn. The last state will be remembered and propagated when
|
||||
// ResumeStateUpdates is called.
|
||||
func (wbsa *Aggregator) PauseStateUpdates() {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.pauseUpdateState = true
|
||||
wbsa.needUpdateStateOnResume = false
|
||||
}
|
||||
|
||||
// ResumeStateUpdates will resume propagating UpdateState calls to the parent,
|
||||
// and call UpdateState on the parent if any UpdateState call was suppressed.
|
||||
func (wbsa *Aggregator) ResumeStateUpdates() {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.pauseUpdateState = false
|
||||
if wbsa.needUpdateStateOnResume {
|
||||
wbsa.cc.UpdateState(wbsa.build())
|
||||
}
|
||||
}
|
||||
|
||||
// NeedUpdateStateOnResume sets the UpdateStateOnResume bool to true, letting a
|
||||
// picker update be sent once ResumeStateUpdates is called.
|
||||
func (wbsa *Aggregator) NeedUpdateStateOnResume() {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
wbsa.needUpdateStateOnResume = true
|
||||
}
|
||||
|
||||
// UpdateState is called to report a balancer state change from sub-balancer.
|
||||
// It's usually called by the balancer group.
|
||||
//
|
||||
// It calls parent ClientConn's UpdateState with the new aggregated state.
|
||||
func (wbsa *Aggregator) UpdateState(id string, newState balancer.State) {
|
||||
wbsa.mu.Lock()
|
||||
defer wbsa.mu.Unlock()
|
||||
state, ok := wbsa.idToPickerState[id]
|
||||
if !ok {
|
||||
// All state starts with an entry in pickStateMap. If ID is not in map,
|
||||
// it's either removed, or never existed.
|
||||
return
|
||||
}
|
||||
|
||||
if !(state.state.ConnectivityState == connectivity.TransientFailure && newState.ConnectivityState == connectivity.Connecting) {
|
||||
// If old state is TransientFailure, and new state is Connecting, don't
|
||||
// update the state, to prevent the aggregated state from being always
|
||||
// CONNECTING. Otherwise, stateToAggregate is the same as
|
||||
// state.ConnectivityState.
|
||||
wbsa.csEvltr.RecordTransition(state.stateToAggregate, newState.ConnectivityState)
|
||||
state.stateToAggregate = newState.ConnectivityState
|
||||
}
|
||||
state.state = newState
|
||||
|
||||
wbsa.buildAndUpdateLocked()
|
||||
}
|
||||
|
||||
// clearState Reset everything to init state (Connecting) but keep the entry in
|
||||
// map (to keep the weight).
|
||||
//
|
||||
// Caller must hold wbsa.mu.
|
||||
func (wbsa *Aggregator) clearStates() {
|
||||
for _, pState := range wbsa.idToPickerState {
|
||||
pState.state = balancer.State{
|
||||
ConnectivityState: connectivity.Connecting,
|
||||
Picker: base.NewErrPicker(balancer.ErrNoSubConnAvailable),
|
||||
}
|
||||
pState.stateToAggregate = connectivity.Connecting
|
||||
}
|
||||
}
|
||||
|
||||
// buildAndUpdateLocked aggregates the connectivity states of the sub-balancers,
|
||||
// builds a new picker and sends an update to the parent ClientConn.
|
||||
//
|
||||
// Caller must hold wbsa.mu.
|
||||
func (wbsa *Aggregator) buildAndUpdateLocked() {
|
||||
if !wbsa.started {
|
||||
return
|
||||
}
|
||||
if wbsa.pauseUpdateState {
|
||||
// If updates are paused, do not call UpdateState, but remember that we
|
||||
// need to call it when they are resumed.
|
||||
wbsa.needUpdateStateOnResume = true
|
||||
return
|
||||
}
|
||||
|
||||
wbsa.cc.UpdateState(wbsa.build())
|
||||
}
|
||||
|
||||
// build combines sub-states into one.
|
||||
//
|
||||
// Caller must hold wbsa.mu.
|
||||
func (wbsa *Aggregator) build() balancer.State {
|
||||
wbsa.logger.Infof("Child pickers with config: %+v", wbsa.idToPickerState)
|
||||
|
||||
if len(wbsa.idToPickerState) == 0 {
|
||||
// This is the case when all sub-balancers are removed.
|
||||
return balancer.State{
|
||||
ConnectivityState: connectivity.TransientFailure,
|
||||
Picker: base.NewErrPicker(errors.New("weighted-target: no targets to pick from")),
|
||||
}
|
||||
}
|
||||
|
||||
// Make sure picker's return error is consistent with the aggregatedState.
|
||||
pickers := make([]weightedPickerState, 0, len(wbsa.idToPickerState))
|
||||
|
||||
switch aggState := wbsa.csEvltr.CurrentState(); aggState {
|
||||
case connectivity.Connecting:
|
||||
return balancer.State{
|
||||
ConnectivityState: aggState,
|
||||
Picker: base.NewErrPicker(balancer.ErrNoSubConnAvailable)}
|
||||
case connectivity.TransientFailure:
|
||||
// this means that all sub-balancers are now in TransientFailure.
|
||||
for _, ps := range wbsa.idToPickerState {
|
||||
pickers = append(pickers, *ps)
|
||||
}
|
||||
return balancer.State{
|
||||
ConnectivityState: aggState,
|
||||
Picker: newWeightedPickerGroup(pickers, wbsa.newWRR)}
|
||||
default:
|
||||
for _, ps := range wbsa.idToPickerState {
|
||||
if ps.stateToAggregate == connectivity.Ready {
|
||||
pickers = append(pickers, *ps)
|
||||
}
|
||||
}
|
||||
return balancer.State{
|
||||
ConnectivityState: aggState,
|
||||
Picker: newWeightedPickerGroup(pickers, wbsa.newWRR)}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
type weightedPickerGroup struct {
|
||||
w wrr.WRR
|
||||
}
|
||||
|
||||
// newWeightedPickerGroup takes pickers with weights, and groups them into one
|
||||
// picker.
|
||||
//
|
||||
// Note it only takes ready pickers. The map shouldn't contain non-ready
|
||||
// pickers.
|
||||
func newWeightedPickerGroup(readyWeightedPickers []weightedPickerState, newWRR func() wrr.WRR) *weightedPickerGroup {
|
||||
w := newWRR()
|
||||
for _, ps := range readyWeightedPickers {
|
||||
w.Add(ps.state.Picker, int64(ps.weight))
|
||||
}
|
||||
|
||||
return &weightedPickerGroup{
|
||||
w: w,
|
||||
}
|
||||
}
|
||||
|
||||
func (pg *weightedPickerGroup) Pick(info balancer.PickInfo) (balancer.PickResult, error) {
|
||||
p, ok := pg.w.Next().(balancer.Picker)
|
||||
if !ok {
|
||||
return balancer.PickResult{}, balancer.ErrNoSubConnAvailable
|
||||
}
|
||||
return p.Pick(info)
|
||||
}
|
||||
196
balancer/weightedtarget/weightedtarget.go
Normal file
196
balancer/weightedtarget/weightedtarget.go
Normal file
@@ -0,0 +1,196 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2020 gRPC authors.
|
||||
*
|
||||
* 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 weightedtarget implements the weighted_target balancer.
|
||||
//
|
||||
// All APIs in this package are experimental.
|
||||
package weightedtarget
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"google.golang.org/grpc/balancer"
|
||||
"google.golang.org/grpc/balancer/weightedtarget/weightedaggregator"
|
||||
"google.golang.org/grpc/internal/balancergroup"
|
||||
"google.golang.org/grpc/internal/grpclog"
|
||||
"google.golang.org/grpc/internal/hierarchy"
|
||||
"google.golang.org/grpc/internal/pretty"
|
||||
"google.golang.org/grpc/internal/wrr"
|
||||
"google.golang.org/grpc/resolver"
|
||||
"google.golang.org/grpc/serviceconfig"
|
||||
)
|
||||
|
||||
// Name is the name of the weighted_target balancer.
|
||||
const Name = "weighted_target_experimental"
|
||||
|
||||
// NewRandomWRR is the WRR constructor used to pick sub-pickers from
|
||||
// sub-balancers. It's to be modified in tests.
|
||||
var NewRandomWRR = wrr.NewRandom
|
||||
|
||||
func init() {
|
||||
balancer.Register(bb{})
|
||||
}
|
||||
|
||||
type bb struct{}
|
||||
|
||||
func (bb) Build(cc balancer.ClientConn, bOpts balancer.BuildOptions) balancer.Balancer {
|
||||
b := &weightedTargetBalancer{}
|
||||
b.logger = prefixLogger(b)
|
||||
b.stateAggregator = weightedaggregator.New(cc, b.logger, NewRandomWRR)
|
||||
b.stateAggregator.Start()
|
||||
b.bg = balancergroup.New(balancergroup.Options{
|
||||
CC: cc,
|
||||
BuildOpts: bOpts,
|
||||
StateAggregator: b.stateAggregator,
|
||||
Logger: b.logger,
|
||||
SubBalancerCloseTimeout: time.Duration(0), // Disable caching of removed child policies
|
||||
})
|
||||
b.logger.Infof("Created")
|
||||
return b
|
||||
}
|
||||
|
||||
func (bb) Name() string {
|
||||
return Name
|
||||
}
|
||||
|
||||
func (bb) ParseConfig(c json.RawMessage) (serviceconfig.LoadBalancingConfig, error) {
|
||||
return parseConfig(c)
|
||||
}
|
||||
|
||||
type weightedTargetBalancer struct {
|
||||
logger *grpclog.PrefixLogger
|
||||
|
||||
bg *balancergroup.BalancerGroup
|
||||
stateAggregator *weightedaggregator.Aggregator
|
||||
|
||||
targets map[string]Target
|
||||
}
|
||||
|
||||
type localityKeyType string
|
||||
|
||||
const localityKey = localityKeyType("locality")
|
||||
|
||||
// LocalityFromResolverState returns the locality from the resolver.State
|
||||
// provided, or an empty string if not present.
|
||||
func LocalityFromResolverState(state resolver.State) string {
|
||||
locality, _ := state.Attributes.Value(localityKey).(string)
|
||||
return locality
|
||||
}
|
||||
|
||||
// UpdateClientConnState takes the new targets in balancer group,
|
||||
// creates/deletes sub-balancers and sends them update. addresses are split into
|
||||
// groups based on hierarchy path.
|
||||
func (b *weightedTargetBalancer) UpdateClientConnState(s balancer.ClientConnState) error {
|
||||
if b.logger.V(2) {
|
||||
b.logger.Infof("Received update from resolver, balancer config: %+v", pretty.ToJSON(s.BalancerConfig))
|
||||
}
|
||||
|
||||
newConfig, ok := s.BalancerConfig.(*LBConfig)
|
||||
if !ok {
|
||||
return fmt.Errorf("unexpected balancer config with type: %T", s.BalancerConfig)
|
||||
}
|
||||
endpointsSplit := hierarchy.Group(s.ResolverState.Endpoints)
|
||||
|
||||
b.stateAggregator.PauseStateUpdates()
|
||||
defer b.stateAggregator.ResumeStateUpdates()
|
||||
|
||||
// Remove sub-pickers and sub-balancers that are not in the new config.
|
||||
for name := range b.targets {
|
||||
if _, ok := newConfig.Targets[name]; !ok {
|
||||
b.stateAggregator.Remove(name)
|
||||
b.bg.Remove(name)
|
||||
}
|
||||
}
|
||||
|
||||
// For sub-balancers in the new config
|
||||
// - if it's new. add to balancer group,
|
||||
// - if it's old, but has a new weight, update weight in balancer group.
|
||||
//
|
||||
// For all sub-balancers, forward the address/balancer config update.
|
||||
for name, newT := range newConfig.Targets {
|
||||
oldT, ok := b.targets[name]
|
||||
if !ok {
|
||||
// If this is a new sub-balancer, add weights to the picker map.
|
||||
b.stateAggregator.Add(name, newT.Weight)
|
||||
// Then add to the balancer group.
|
||||
b.bg.Add(name, balancer.Get(newT.ChildPolicy.Name))
|
||||
// Not trigger a state/picker update. Wait for the new sub-balancer
|
||||
// to send its updates.
|
||||
} else if newT.ChildPolicy.Name != oldT.ChildPolicy.Name {
|
||||
// If the child policy name is different, remove from balancer group
|
||||
// and re-add.
|
||||
b.stateAggregator.Remove(name)
|
||||
b.bg.Remove(name)
|
||||
b.stateAggregator.Add(name, newT.Weight)
|
||||
b.bg.Add(name, balancer.Get(newT.ChildPolicy.Name))
|
||||
} else if newT.Weight != oldT.Weight {
|
||||
// If this is an existing sub-balancer, update weight if necessary.
|
||||
b.stateAggregator.UpdateWeight(name, newT.Weight)
|
||||
}
|
||||
|
||||
// Forwards all the update:
|
||||
// - addresses are from the map after splitting with hierarchy path,
|
||||
// - Top level service config and attributes are the same,
|
||||
// - Balancer config comes from the targets map.
|
||||
//
|
||||
// TODO: handle error? How to aggregate errors and return?
|
||||
_ = b.bg.UpdateClientConnState(name, balancer.ClientConnState{
|
||||
ResolverState: resolver.State{
|
||||
Endpoints: endpointsSplit[name],
|
||||
ServiceConfig: s.ResolverState.ServiceConfig,
|
||||
Attributes: s.ResolverState.Attributes.WithValue(localityKey, name),
|
||||
},
|
||||
BalancerConfig: newT.ChildPolicy.Config,
|
||||
})
|
||||
}
|
||||
|
||||
b.targets = newConfig.Targets
|
||||
|
||||
// If the targets length is zero, it means we have removed all child
|
||||
// policies from the balancer group and aggregator.
|
||||
// At the start of this UpdateClientConnState() operation, a call to
|
||||
// b.stateAggregator.ResumeStateUpdates() is deferred. Thus, setting the
|
||||
// needUpdateStateOnResume bool to true here will ensure a new picker is
|
||||
// built as part of that deferred function. Since there are now no child
|
||||
// policies, the aggregated connectivity state reported form the Aggregator
|
||||
// will be TRANSIENT_FAILURE.
|
||||
if len(b.targets) == 0 {
|
||||
b.stateAggregator.NeedUpdateStateOnResume()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (b *weightedTargetBalancer) ResolverError(err error) {
|
||||
b.bg.ResolverError(err)
|
||||
}
|
||||
|
||||
func (b *weightedTargetBalancer) UpdateSubConnState(sc balancer.SubConn, state balancer.SubConnState) {
|
||||
b.logger.Errorf("UpdateSubConnState(%v, %+v) called unexpectedly", sc, state)
|
||||
}
|
||||
|
||||
func (b *weightedTargetBalancer) Close() {
|
||||
b.stateAggregator.Stop()
|
||||
b.bg.Close()
|
||||
}
|
||||
|
||||
func (b *weightedTargetBalancer) ExitIdle() {
|
||||
b.bg.ExitIdle()
|
||||
}
|
||||
49
balancer/weightedtarget/weightedtarget_config.go
Normal file
49
balancer/weightedtarget/weightedtarget_config.go
Normal file
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2020 gRPC authors.
|
||||
*
|
||||
* 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 weightedtarget
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
|
||||
internalserviceconfig "google.golang.org/grpc/internal/serviceconfig"
|
||||
"google.golang.org/grpc/serviceconfig"
|
||||
)
|
||||
|
||||
// Target represents one target with the weight and the child policy.
|
||||
type Target struct {
|
||||
// Weight is the weight of the child policy.
|
||||
Weight uint32 `json:"weight,omitempty"`
|
||||
// ChildPolicy is the child policy and it's config.
|
||||
ChildPolicy *internalserviceconfig.BalancerConfig `json:"childPolicy,omitempty"`
|
||||
}
|
||||
|
||||
// LBConfig is the balancer config for weighted_target.
|
||||
type LBConfig struct {
|
||||
serviceconfig.LoadBalancingConfig `json:"-"`
|
||||
|
||||
Targets map[string]Target `json:"targets,omitempty"`
|
||||
}
|
||||
|
||||
func parseConfig(c json.RawMessage) (*LBConfig, error) {
|
||||
var cfg LBConfig
|
||||
if err := json.Unmarshal(c, &cfg); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &cfg, nil
|
||||
}
|
||||
104
balancer/weightedtarget/weightedtarget_config_test.go
Normal file
104
balancer/weightedtarget/weightedtarget_config_test.go
Normal file
@@ -0,0 +1,104 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2020 gRPC authors.
|
||||
*
|
||||
* 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 weightedtarget
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"google.golang.org/grpc/balancer"
|
||||
_ "google.golang.org/grpc/balancer/grpclb"
|
||||
"google.golang.org/grpc/balancer/roundrobin"
|
||||
internalserviceconfig "google.golang.org/grpc/internal/serviceconfig"
|
||||
)
|
||||
|
||||
const (
|
||||
testJSONConfig = `{
|
||||
"targets": {
|
||||
"cluster_1": {
|
||||
"weight": 75,
|
||||
"childPolicy": [{
|
||||
"grpclb": {
|
||||
"childPolicy": [{"pick_first":{}}],
|
||||
"targetName": "foo-service"
|
||||
}
|
||||
}]
|
||||
},
|
||||
"cluster_2": {
|
||||
"weight": 25,
|
||||
"childPolicy": [{"round_robin": ""}]
|
||||
}
|
||||
}
|
||||
}`
|
||||
)
|
||||
|
||||
var (
|
||||
grpclbConfigParser = balancer.Get("grpclb").(balancer.ConfigParser)
|
||||
grpclbConfigJSON = `{"childPolicy": [{"pick_first":{}}], "targetName": "foo-service"}`
|
||||
grpclbConfig, _ = grpclbConfigParser.ParseConfig([]byte(grpclbConfigJSON))
|
||||
)
|
||||
|
||||
func (s) TestParseConfig(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
js string
|
||||
want *LBConfig
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "empty json",
|
||||
js: "",
|
||||
want: nil,
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "OK",
|
||||
js: testJSONConfig,
|
||||
want: &LBConfig{
|
||||
Targets: map[string]Target{
|
||||
"cluster_1": {
|
||||
Weight: 75,
|
||||
ChildPolicy: &internalserviceconfig.BalancerConfig{
|
||||
Name: "grpclb",
|
||||
Config: grpclbConfig,
|
||||
},
|
||||
},
|
||||
"cluster_2": {
|
||||
Weight: 25,
|
||||
ChildPolicy: &internalserviceconfig.BalancerConfig{
|
||||
Name: roundrobin.Name,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := parseConfig([]byte(tt.js))
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Fatalf("parseConfig() error = %v, wantErr %v", err, tt.wantErr)
|
||||
}
|
||||
if !cmp.Equal(got, tt.want) {
|
||||
t.Errorf("parseConfig() got unexpected result, diff: %v", cmp.Diff(got, tt.want))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
1519
balancer/weightedtarget/weightedtarget_test.go
Normal file
1519
balancer/weightedtarget/weightedtarget_test.go
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user