// 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 utils import ( "context" "fmt" "time" "github.com/blang/semver/v4" "golang.org/x/time/rate" "github.com/milvus-io/milvus/internal/querycoordv2/meta" "github.com/milvus-io/milvus/internal/querycoordv2/session" "github.com/milvus-io/milvus/internal/storagev2/packed" "github.com/milvus-io/milvus/pkg/v3/mlog" "github.com/milvus-io/milvus/pkg/v3/proto/querypb" "github.com/milvus-io/milvus/pkg/v3/util/merr" "github.com/milvus-io/milvus/pkg/v3/util/paramtable" ) func CheckNodeAvailable(nodeID int64, info *session.NodeInfo) error { if info == nil { return merr.WrapErrNodeOffline(nodeID) } return nil } // In a replica, a shard is available, if and only if: // 1. The leader is online // 2. All QueryNodes in the distribution are online // 3. The last heartbeat response time is within HeartbeatAvailableInterval for all QueryNodes(include leader) in the distribution // 4. All segments of the shard in target should be in the distribution // 5. The delegator has caught up with streaming data func CheckDelegatorDataReady(nodeMgr *session.NodeManager, targetMgr meta.TargetManagerInterface, leader *meta.LeaderView, scope int32) error { // Check whether leader is online info := nodeMgr.Get(leader.ID) if info == nil { err := merr.WrapErrNodeOffline(leader.ID) mlog.Info(context.TODO(), "leader is not available", mlog.Err(err)) return merr.Wrap(err, "leader not available") } // Check if delegator is still catching up with streaming data if leader.Status != nil && leader.Status.GetCatchingUpStreamingData() { mlog.RatedInfo(context.TODO(), rate.Limit(10), "leader is not available due to still catching up streaming data", mlog.String("channel", leader.Channel)) return merr.WrapErrChannelNotAvailable(leader.Channel, "still catching up streaming data") } segmentDist := targetMgr.GetSealedSegmentsByChannel(context.TODO(), leader.CollectionID, leader.Channel, scope) // Check whether segments are fully loaded for segmentID := range segmentDist { version, exist := leader.Segments[segmentID] if !exist { mlog.RatedInfo(context.TODO(), rate.Limit(10), "leader is not available due to lack of segment", mlog.Int64("segmentID", segmentID)) return merr.WrapErrSegmentLack(segmentID) } // Check whether segment's worker node is online info := nodeMgr.Get(version.GetNodeID()) if info == nil { err := merr.WrapErrNodeOffline(leader.ID) mlog.Info(context.TODO(), "leader is not available due to QueryNode unavailable", mlog.Int64("segmentID", segmentID), mlog.Err(err)) return err } } return nil } func CheckSegmentDataReady(ctx context.Context, collectionID int64, distManager *meta.DistributionManager, targetMgr meta.TargetManagerInterface, scope int32) error { // Check whether segments are fully loaded segmentDist := targetMgr.GetSealedSegmentsByCollection(ctx, collectionID, scope) distSegments := distManager.SegmentDistManager.GetByFilter(meta.WithCollectionID(collectionID)) distBySegmentID := make(map[int64][]*meta.Segment, len(distSegments)) for _, segment := range distSegments { distBySegmentID[segment.GetID()] = append(distBySegmentID[segment.GetID()], segment) } for segmentID, segmentInfo := range segmentDist { segments := distBySegmentID[segmentID] if len(segments) == 0 { mlog.RatedInfo(context.TODO(), rate.Limit(10), "segment is not available", mlog.Int64("segmentID", segmentID)) return merr.WrapErrSegmentLack(segmentID) } for _, segment := range segments { cmp, err := packed.CompareManifestPath(segment.ManifestPath, segmentInfo.GetManifestPath()) if err != nil { mlog.RatedWarn(context.TODO(), rate.Limit(10), "segment manifest path not comparable", mlog.Int64("segmentID", segmentID), mlog.String("distManifest", segment.ManifestPath), mlog.String("targetManifest", segmentInfo.GetManifestPath()), mlog.Err(err)) return err } if cmp < 0 { // dist manifest is older than target, segment data is not ready yet mlog.RatedInfo(context.TODO(), rate.Limit(10), "segment manifest is outdated", mlog.Int64("segmentID", segmentID), mlog.String("distManifest", segment.ManifestPath), mlog.String("targetManifest", segmentInfo.GetManifestPath())) return merr.WrapErrSegmentNotLoaded(segmentID) } // cmp >= 0: dist manifest is same or newer than target. // Still check DataVersion for storage v2 binlog changes that don't move the manifest. // Skip when the QueryNode did not report DataVersion (old node in mixed-version rollout). if segment.DataVersion != nil && *segment.DataVersion < segmentInfo.GetDataVersion() { mlog.RatedInfo(context.TODO(), rate.Limit(10), "segment data version is outdated", mlog.Int64("segmentID", segmentID), mlog.Int32("distDataVersion", *segment.DataVersion), mlog.Int32("targetDataVersion", segmentInfo.GetDataVersion())) return merr.WrapErrSegmentNotLoaded(segmentID) } } } return nil } func checkLoadStatus(ctx context.Context, m *meta.Meta, collectionID int64, withUnserviceableShards bool) error { percentage := m.CalculateLoadPercentage(ctx, collectionID) if percentage < 0 { err := merr.WrapErrCollectionNotLoaded(collectionID) mlog.Warn(ctx, "failed to GetShardLeaders", mlog.Err(err)) return err } // When the caller accepts unserviceable shards (e.g. proxy refreshing its // shard-leader cache during replica reconfig), skip the full-load gate so // the caller can route by the per-leader Serviceable flag instead. if withUnserviceableShards { return nil } collection := m.GetCollection(ctx, collectionID) if collection != nil && collection.GetStatus() == querypb.LoadStatus_Loaded { // when collection is loaded, regard collection as readable, set percentage == 100 percentage = 100 } if percentage < 100 { err := merr.WrapErrCollectionNotFullyLoaded(collectionID) msg := fmt.Sprintf("collection %v is not fully loaded", collectionID) mlog.Warn(ctx, msg) return err } return nil } func GetShardLeadersWithChannels( ctx context.Context, m *meta.Meta, dist *meta.DistributionManager, nodeMgr *session.NodeManager, collectionID int64, channels map[string]*meta.DmChannel, withUnserviceableShards bool, ) ([]*querypb.ShardLeadersList, error) { return GetShardLeadersWithChannelsAndReplicaFilter(ctx, m, dist, nodeMgr, collectionID, channels, withUnserviceableShards, nil) } func GetShardLeadersWithChannelsAndReplicaFilter( ctx context.Context, m *meta.Meta, dist *meta.DistributionManager, nodeMgr *session.NodeManager, collectionID int64, channels map[string]*meta.DmChannel, withUnserviceableShards bool, replicaFilter func(*meta.Replica) bool, ) ([]*querypb.ShardLeadersList, error) { ret := make([]*querypb.ShardLeadersList, 0) replicas := m.GetByCollection(ctx, collectionID) for _, channel := range channels { ids := make([]int64, 0, len(replicas)) addrs := make([]string, 0, len(replicas)) serviceable := make([]bool, 0, len(replicas)) for _, replica := range replicas { if replicaFilter != nil && !replicaFilter(replica) { continue } leader := dist.ChannelDistManager.GetShardLeader(channel.GetChannelName(), replica) if leader == nil || (!withUnserviceableShards && !leader.IsServiceable()) { mlog.RatedWarn(ctx, rate.Limit(1.0/60.0), "leader is not available in replica", mlog.String("channel", channel.GetChannelName()), mlog.Int64("replicaID", replica.GetID())) continue } info := nodeMgr.Get(leader.Node) if info != nil { ids = append(ids, info.ID()) addrs = append(addrs, info.Addr()) serviceable = append(serviceable, leader.IsServiceable()) } } if len(ids) == 0 && !withUnserviceableShards { err := merr.WrapErrChannelNotAvailable(channel.GetChannelName()) msg := fmt.Sprintf("channel %s is not available in any replica", channel.GetChannelName()) mlog.Warn(ctx, msg, mlog.Err(err)) return nil, err } ret = append(ret, &querypb.ShardLeadersList{ ChannelName: channel.GetChannelName(), NodeIds: ids, NodeAddrs: addrs, Serviceable: serviceable, }) } return ret, nil } func GetShardLeaders(ctx context.Context, m *meta.Meta, targetMgr meta.TargetManagerInterface, dist *meta.DistributionManager, nodeMgr *session.NodeManager, collectionID int64, withUnserviceableShards bool, ) ([]*querypb.ShardLeadersList, error) { return GetShardLeadersWithReplicaFilter(ctx, m, targetMgr, dist, nodeMgr, collectionID, withUnserviceableShards, nil) } func GetShardLeadersWithReplicaFilter(ctx context.Context, m *meta.Meta, targetMgr meta.TargetManagerInterface, dist *meta.DistributionManager, nodeMgr *session.NodeManager, collectionID int64, withUnserviceableShards bool, replicaFilter func(*meta.Replica) bool, ) ([]*querypb.ShardLeadersList, error) { if err := checkLoadStatus(ctx, m, collectionID, withUnserviceableShards); err != nil { return nil, err } channels := targetMgr.GetDmChannelsByCollection(ctx, collectionID, meta.CurrentTarget) if len(channels) == 0 { msg := "loaded collection do not found any channel in target, may be in recovery" err := merr.WrapErrCollectionOnRecovering(collectionID, msg) mlog.Warn(ctx, "failed to get channels", mlog.Err(err)) return nil, err } return GetShardLeadersWithChannelsAndReplicaFilter(ctx, m, dist, nodeMgr, collectionID, channels, withUnserviceableShards, replicaFilter) } // CheckCollectionsQueryable check all channels are watched and all segments are loaded for this collection func CheckCollectionsQueryable(ctx context.Context, m *meta.Meta, targetMgr meta.TargetManagerInterface, dist *meta.DistributionManager, nodeMgr *session.NodeManager) error { maxInterval := paramtable.Get().QueryCoordCfg.UpdateCollectionLoadStatusInterval.GetAsDuration(time.Minute) for _, coll := range m.GetAllCollections(ctx) { err := checkCollectionQueryable(ctx, m, targetMgr, dist, nodeMgr, coll) // the collection is not queryable, if meet following conditions: // 1. Some segments are not loaded // 2. Collection is not starting to release // 3. The load percentage has not been updated in the last 5 minutes. if err != nil && m.Exist(ctx, coll.CollectionID) && time.Since(coll.UpdatedAt) >= maxInterval { mlog.Warn(ctx, "collection not querable", mlog.Int64("collectionID", coll.CollectionID), mlog.Time("lastUpdated", coll.UpdatedAt), mlog.Duration("maxInterval", maxInterval), mlog.Err(err)) return err } } return nil } // checkCollectionQueryable check all channels are watched and all segments are loaded for this collection func checkCollectionQueryable(ctx context.Context, m *meta.Meta, targetMgr meta.TargetManagerInterface, dist *meta.DistributionManager, nodeMgr *session.NodeManager, coll *meta.Collection) error { collectionID := coll.GetCollectionID() if err := checkLoadStatus(ctx, m, collectionID, false); err != nil { return err } channels := targetMgr.GetDmChannelsByCollection(ctx, collectionID, meta.CurrentTarget) if len(channels) == 0 { msg := "loaded collection do not found any channel in target, may be in recovery" err := merr.WrapErrCollectionOnRecovering(collectionID, msg) mlog.Warn(ctx, "failed to get channels", mlog.Err(err)) return err } shardList, err := GetShardLeadersWithChannels(ctx, m, dist, nodeMgr, collectionID, channels, false) if err != nil { return err } if len(channels) != len(shardList) { return merr.WrapErrCollectionNotFullyLoaded(collectionID, "still have unwatched channels or loaded segments") } return nil } // GetChannelRWAndRONodesFor260 gets the RW and RO nodes of the channel. func GetChannelRWAndRONodesFor260(replica *meta.Replica, nodeManager *session.NodeManager) ([]int64, []int64) { rwNodes, roNodes := replica.GetRWSQNodes(), replica.GetROSQNodes() if rwQueryNodesLessThan260 := filterNodeLessThan260(replica.GetRWNodes(), nodeManager); len(rwQueryNodesLessThan260) > 0 { // Add rwNodes to roNodes to balance channels from querynode to streamingnode forcely. roNodes = append(roNodes, rwQueryNodesLessThan260...) mlog.Debug(context.TODO(), "find querynode need to balance channel to streamingnode", mlog.Int64s("rwQueryNodesLessThan260", rwQueryNodesLessThan260)) } roNodes = append(roNodes, replica.GetRONodes()...) return rwNodes, roNodes } // filterNodeLessThan260 filter the query nodes that version is less than 2.6.0 func filterNodeLessThan260(nodes []int64, nodeManager *session.NodeManager) []int64 { checker := semver.MustParseRange(">=2.6.0-dev") filteredNodes := make([]int64, 0) for _, nodeID := range nodes { if session := nodeManager.Get(nodeID); session != nil && checker(session.Version()) { continue } filteredNodes = append(filteredNodes, nodeID) } return filteredNodes }