// 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 grpcproxyclient import ( "context" "fmt" "time" "github.com/milvus-io/milvus-proto/go-api/commonpb" "github.com/milvus-io/milvus-proto/go-api/milvuspb" "github.com/milvus-io/milvus/internal/proto/internalpb" "github.com/milvus-io/milvus/internal/proto/proxypb" "github.com/milvus-io/milvus/internal/util/commonpbutil" "github.com/milvus-io/milvus/internal/util/funcutil" "github.com/milvus-io/milvus/internal/util/grpcclient" "github.com/milvus-io/milvus/internal/util/paramtable" "github.com/milvus-io/milvus/internal/util/typeutil" "google.golang.org/grpc" ) var Params *paramtable.ComponentParam = paramtable.Get() // Client is the grpc client for Proxy type Client struct { grpcClient grpcclient.GrpcClient[proxypb.ProxyClient] addr string } // NewClient creates a new client instance func NewClient(ctx context.Context, addr string) (*Client, error) { if addr == "" { return nil, fmt.Errorf("address is empty") } clientParams := &Params.ProxyGrpcClientCfg client := &Client{ addr: addr, grpcClient: &grpcclient.ClientBase[proxypb.ProxyClient]{ ClientMaxRecvSize: clientParams.ClientMaxRecvSize.GetAsInt(), ClientMaxSendSize: clientParams.ClientMaxSendSize.GetAsInt(), DialTimeout: clientParams.DialTimeout.GetAsDuration(time.Millisecond), KeepAliveTime: clientParams.KeepAliveTime.GetAsDuration(time.Millisecond), KeepAliveTimeout: clientParams.KeepAliveTimeout.GetAsDuration(time.Millisecond), RetryServiceNameConfig: "milvus.proto.proxy.Proxy", MaxAttempts: clientParams.MaxAttempts.GetAsInt(), InitialBackoff: float32(clientParams.InitialBackoff.GetAsFloat()), MaxBackoff: float32(clientParams.MaxBackoff.GetAsFloat()), BackoffMultiplier: float32(clientParams.BackoffMultiplier.GetAsFloat()), CompressionEnabled: clientParams.CompressionEnabled.GetAsBool(), }, } client.grpcClient.SetRole(typeutil.ProxyRole) client.grpcClient.SetGetAddrFunc(client.getAddr) client.grpcClient.SetNewGrpcClientFunc(client.newGrpcClient) return client, nil } // Init initializes Proxy's grpc client. func (c *Client) Init() error { return nil } func (c *Client) newGrpcClient(cc *grpc.ClientConn) proxypb.ProxyClient { return proxypb.NewProxyClient(cc) } func (c *Client) getAddr() (string, error) { return c.addr, nil } // Start dummy func (c *Client) Start() error { return nil } // Stop stops the client, closes the connection func (c *Client) Stop() error { return c.grpcClient.Close() } // Register dummy func (c *Client) Register() error { return nil } // GetComponentStates get the component state. func (c *Client) GetComponentStates(ctx context.Context) (*milvuspb.ComponentStates, error) { ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.GetComponentStates(ctx, &milvuspb.GetComponentStatesRequest{}) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.ComponentStates), err } // GetStatisticsChannel return the statistics channel in string func (c *Client) GetStatisticsChannel(ctx context.Context) (*milvuspb.StringResponse, error) { ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.GetStatisticsChannel(ctx, &internalpb.GetStatisticsChannelRequest{}) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.StringResponse), err } // InvalidateCollectionMetaCache invalidate collection meta cache func (c *Client) InvalidateCollectionMetaCache(ctx context.Context, req *proxypb.InvalidateCollMetaCacheRequest) (*commonpb.Status, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.InvalidateCollectionMetaCache(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) InvalidateCredentialCache(ctx context.Context, req *proxypb.InvalidateCredCacheRequest) (*commonpb.Status, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.InvalidateCredentialCache(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) UpdateCredentialCache(ctx context.Context, req *proxypb.UpdateCredCacheRequest) (*commonpb.Status, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.UpdateCredentialCache(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*commonpb.Status), err } func (c *Client) RefreshPolicyInfoCache(ctx context.Context, req *proxypb.RefreshPolicyInfoCacheRequest) (*commonpb.Status, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.RefreshPolicyInfoCache(ctx, req) }) if err != nil { return nil, err } return ret.(*commonpb.Status), err } // GetProxyMetrics gets the metrics of proxy, it's an internal interface which is different from GetMetrics interface, // because it only obtains the metrics of Proxy, not including the topological metrics of Query cluster and Data cluster. func (c *Client) GetProxyMetrics(ctx context.Context, req *milvuspb.GetMetricsRequest) (*milvuspb.GetMetricsResponse, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.GetProxyMetrics(ctx, req) }) if err != nil || ret == nil { return nil, err } return ret.(*milvuspb.GetMetricsResponse), err } // SetRates notifies Proxy to limit rates of requests. func (c *Client) SetRates(ctx context.Context, req *proxypb.SetRatesRequest) (*commonpb.Status, error) { req = typeutil.Clone(req) commonpbutil.UpdateMsgBase( req.GetBase(), commonpbutil.FillMsgBaseFromClient(paramtable.GetNodeID(), commonpbutil.WithTargetID(c.grpcClient.GetNodeID())), ) ret, err := c.grpcClient.ReCall(ctx, func(client proxypb.ProxyClient) (any, error) { if !funcutil.CheckCtxValid(ctx) { return nil, ctx.Err() } return client.SetRates(ctx, req) }) if err != nil { return nil, err } return ret.(*commonpb.Status), err }