// Licensed to the LF AI & Data foundation under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you 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 grpcquerycoordclient import ( "context" "fmt" "sync" "time" grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware" grpc_retry "github.com/grpc-ecosystem/go-grpc-middleware/retry" grpc_opentracing "github.com/grpc-ecosystem/go-grpc-middleware/tracing/opentracing" "github.com/milvus-io/milvus/internal/util/retry" "github.com/milvus-io/milvus/internal/util/sessionutil" "github.com/milvus-io/milvus/internal/util/trace" "github.com/milvus-io/milvus/internal/util/typeutil" "go.uber.org/zap" "google.golang.org/grpc" "google.golang.org/grpc/codes" "github.com/milvus-io/milvus/internal/log" "github.com/milvus-io/milvus/internal/proto/commonpb" "github.com/milvus-io/milvus/internal/proto/internalpb" "github.com/milvus-io/milvus/internal/proto/milvuspb" "github.com/milvus-io/milvus/internal/proto/querypb" ) // Client is the grpc client of QueryCoord. type Client struct { ctx context.Context cancel context.CancelFunc grpcClient querypb.QueryCoordClient conn *grpc.ClientConn grpcClientMtx sync.RWMutex sess *sessionutil.Session addr string getGrpcClient func() (querypb.QueryCoordClient, error) } func (c *Client) setGetGrpcClientFunc() { c.getGrpcClient = c.getGrpcClientFunc } func (c *Client) getGrpcClientFunc() (querypb.QueryCoordClient, error) { c.grpcClientMtx.RLock() if c.grpcClient != nil { defer c.grpcClientMtx.RUnlock() return c.grpcClient, nil } c.grpcClientMtx.RUnlock() c.grpcClientMtx.Lock() defer c.grpcClientMtx.Unlock() if c.grpcClient != nil { return c.grpcClient, nil } // FIXME(dragondriver): how to handle error here? // if we return nil here, then we should check if client is nil outside, err := c.connect(retry.Attempts(20)) if err != nil { return nil, err } return c.grpcClient, nil } func (c *Client) resetConnection() { c.grpcClientMtx.Lock() defer c.grpcClientMtx.Unlock() if c.conn != nil { _ = c.conn.Close() } c.conn = nil c.grpcClient = nil } func getQueryCoordAddress(sess *sessionutil.Session) (string, error) { key := typeutil.QueryCoordRole msess, _, err := sess.GetSessions(key) if err != nil { log.Debug("QueryCoordClient GetSessions failed", zap.Error(err)) return "", err } ms, ok := msess[key] if !ok { log.Debug("QueryCoordClient msess key not existed", zap.Any("key", key)) return "", fmt.Errorf("number of querycoord is incorrect, %d", len(msess)) } return ms.Address, nil } // NewClient creates a client for QueryCoord grpc call. func NewClient(ctx context.Context, metaRoot string, etcdEndpoints []string) (*Client, error) { sess := sessionutil.NewSession(ctx, metaRoot, etcdEndpoints) if sess == nil { err := fmt.Errorf("new session error, maybe can not connect to etcd") log.Debug("QueryCoordClient NewClient failed", zap.Error(err)) return nil, err } ctx, cancel := context.WithCancel(ctx) client := &Client{ ctx: ctx, cancel: cancel, sess: sess, } client.setGetGrpcClientFunc() return client, nil } // Init initializes QueryCoord's grpc client. func (c *Client) Init() error { Params.Init() return nil } func (c *Client) connect(retryOptions ...retry.Option) error { var err error connectQueryCoordAddressFn := func() error { c.addr, err = getQueryCoordAddress(c.sess) if err != nil { log.Debug("QueryCoordClient getQueryCoordAddress failed", zap.Error(err)) return err } opts := trace.GetInterceptorOpts() log.Debug("QueryCoordClient try reconnect ", zap.String("address", c.addr)) ctx, cancel := context.WithTimeout(c.ctx, 15*time.Second) defer cancel() conn, err := grpc.DialContext(ctx, c.addr, grpc.WithInsecure(), grpc.WithBlock(), grpc.WithDefaultCallOptions( grpc.MaxCallRecvMsgSize(Params.ClientMaxRecvSize), grpc.MaxCallSendMsgSize(Params.ClientMaxSendSize)), grpc.WithUnaryInterceptor( grpc_middleware.ChainUnaryClient( grpc_retry.UnaryClientInterceptor( grpc_retry.WithMax(3), grpc_retry.WithCodes(codes.Aborted, codes.Unavailable), ), grpc_opentracing.UnaryClientInterceptor(opts...), )), grpc.WithStreamInterceptor( grpc_middleware.ChainStreamClient( grpc_retry.StreamClientInterceptor( grpc_retry.WithMax(3), grpc_retry.WithCodes(codes.Aborted, codes.Unavailable), ), grpc_opentracing.StreamClientInterceptor(opts...), )), ) if err != nil { return err } if c.conn != nil { _ = c.conn.Close() } c.conn = conn return nil } err = retry.Do(c.ctx, connectQueryCoordAddressFn, retryOptions...) if err != nil { log.Debug("QueryCoordClient try reconnect failed", zap.Error(err)) return err } log.Debug("QueryCoordClient try reconnect success") c.grpcClient = querypb.NewQueryCoordClient(c.conn) return nil } func (c *Client) recall(caller func() (interface{}, error)) (interface{}, error) { ret, err := caller() if err == nil { return ret, nil } log.Debug("QueryCoord Client grpc error", zap.Error(err)) c.resetConnection() ret, err = caller() if err == nil { return ret, nil } return ret, err } // Start starts QueryCoord's client service. But it does nothing here. func (c *Client) Start() error { return nil } // Stop stops QueryCoord's grpc client server. func (c *Client) Stop() error { c.cancel() c.grpcClientMtx.Lock() defer c.grpcClientMtx.Unlock() if c.conn != nil { return c.conn.Close() } return nil } // Register dummy func (c *Client) Register() error { return nil } // GetComponentStates gets the component states of QueryCoord. func (c *Client) GetComponentStates(ctx context.Context) (*internalpb.ComponentStates, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetComponentStates(ctx, &internalpb.GetComponentStatesRequest{}) }) if err != nil || ret == nil { return nil, err } return ret.(*internalpb.ComponentStates), err } // GetTimeTickChannel gets the time tick channel of QueryCoord. func (c *Client) GetTimeTickChannel(ctx context.Context) (*milvuspb.StringResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetTimeTickChannel(ctx, &internalpb.GetTimeTickChannelRequest{}) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.StringResponse), err } // GetStatisticsChannel gets the statistics channel of QueryCoord. func (c *Client) GetStatisticsChannel(ctx context.Context) (*milvuspb.StringResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetStatisticsChannel(ctx, &internalpb.GetStatisticsChannelRequest{}) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.StringResponse), err } // ShowCollections shows the collections in the QueryCoord. func (c *Client) ShowCollections(ctx context.Context, req *querypb.ShowCollectionsRequest) (*querypb.ShowCollectionsResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.ShowCollections(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*querypb.ShowCollectionsResponse), err } func (c *Client) LoadCollection(ctx context.Context, req *querypb.LoadCollectionRequest) (*commonpb.Status, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.LoadCollection(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) ReleaseCollection(ctx context.Context, req *querypb.ReleaseCollectionRequest) (*commonpb.Status, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.ReleaseCollection(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) ShowPartitions(ctx context.Context, req *querypb.ShowPartitionsRequest) (*querypb.ShowPartitionsResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.ShowPartitions(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*querypb.ShowPartitionsResponse), err } func (c *Client) LoadPartitions(ctx context.Context, req *querypb.LoadPartitionsRequest) (*commonpb.Status, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.LoadPartitions(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) ReleasePartitions(ctx context.Context, req *querypb.ReleasePartitionsRequest) (*commonpb.Status, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.ReleasePartitions(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) CreateQueryChannel(ctx context.Context, req *querypb.CreateQueryChannelRequest) (*querypb.CreateQueryChannelResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.CreateQueryChannel(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*querypb.CreateQueryChannelResponse), err } func (c *Client) GetPartitionStates(ctx context.Context, req *querypb.GetPartitionStatesRequest) (*querypb.GetPartitionStatesResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetPartitionStates(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*querypb.GetPartitionStatesResponse), err } func (c *Client) GetSegmentInfo(ctx context.Context, req *querypb.GetSegmentInfoRequest) (*querypb.GetSegmentInfoResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetSegmentInfo(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*querypb.GetSegmentInfoResponse), err } func (c *Client) LoadBalance(ctx context.Context, req *querypb.LoadBalanceRequest) (*commonpb.Status, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.LoadBalance(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) GetMetrics(ctx context.Context, req *milvuspb.GetMetricsRequest) (*milvuspb.GetMetricsResponse, error) { ret, err := c.recall(func() (interface{}, error) { client, err := c.getGrpcClient() if err != nil { return nil, err } return client.GetMetrics(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.GetMetricsResponse), err }