mirror of
https://github.com/milvus-io/milvus.git
synced 2026-07-21 02:05:41 +00:00
issue: #47420 ## What this PR does Project-wide migration of raw `fmt.Errorf` / `errors.New` in function bodies onto the `merr` framework, plus the Sys-vs-Input error classification and the machinery it drives (retriability, fine-grained metrics, segcore unification), plus the convention docs and a linter that keeps it from regressing. Scope: storage, proxy, coordinators (root/data/query), query node, data node, `pkg/util` & `internal/util`, expression parser, message queue, streaming, and misc packages. Bare raw-error usages went from ~3000 to a ~340 allowlist (package-level sentinels / build-tag / test sites). --- ## How to review this PR It is large but the vast majority is mechanical. Changes fall into three tiers; spend review budget on Part 2 and Part 3. ### Part 1 — Mechanical standardization (low risk, verify by rule) Each converted call follows one of a small fixed set of rules. To review, check that each site obeys the matching rule rather than reading every line: | Pattern | Rule | |---|---| | `fmt.Errorf("...")` originating a new error | → `merr.WrapErrXxxMsg("...")` with a code matching the failure's meaning | | Adding context to an existing typed error | → `merr.Wrap(err, "...")` / `merr.Wrapf(...)` — **preserves** the inner code (never `WrapErr*Err`, which overwrites it) | | Errors inside the streaming subsystem | → `status.New*` factories (StreamingError), **not** merr — this is the component-internal dialect (see `docs/dev/error_handling_guide.md`) | | Low-level / control-flow signal caught by `errors.Is` | → kept as a package-level `errors.New` sentinel (lowercase, same-package) | Conventions are documented in `docs/dev/error_handling_guide.md` (how-to) and `docs/dev/error_sentinel_convention.md` (rules + audit). A `gocritic`/`ruleguard` rule (`rawmerrerror`, in `rules.go`) enforces "no raw `return errors.New/fmt.Errorf`" under `make verifiers`. ### Part 2 — Behavior changes (review these closely) These are the sites where the wire contract or runtime behavior changes, not just the source text. Listed by category; representative locations given, full set in the diff. **A. gRPC wire-code shifts: `UnexpectedError(1)/Code 65535` → typed code.** Where a handler previously returned a raw error (collapsed to `Code=65535` on the wire), it now returns a typed merr, so the client sees a real code. The most common shift is to `IllegalArgument(5)/Code 1100` (ParameterInvalid). Touch points include datanode task handlers (CreateTask/Query/Drop), proxy Upsert, querynode GetMetrics, datacoord CreateIndex, httpserver query-response builder, and typeutil schema validation. One code refinement: an index-param validation moved `1100` → `1101` (ParameterMissing). **Client/SDK assertions and any code that switched on `Code=65535` for these paths must be re-checked** (the go_client e2e assertions were already aligned in this PR). **B. Prometheus `status` label contract change (externally visible).** The proxy metric's coarse `fail` / `rejected` values are split into `fail_input` / `fail_system` and `rejected_user` / `rejected_system` (in `requestutil.ParseMetricLabel`; auth/privilege rejections count as `rejected_user`), so dashboards can attribute a failure to caller vs operator. **Dashboards/alerts querying `status="fail"` must migrate to `status=~"fail_.*"`, and `status="rejected"` to `status=~"rejected_.*"`.** The in-repo Grafana dashboard is already migrated; external dashboards built on the old values silently go empty after upgrade. This is the one change that requires an ops-side migration. **C. Retriability semantics.** - C1: `merr.Status(err)` now forces `Retriable=false` when the error is an `InputError` — a malformed request can never succeed on blind retry, so clients never get the self-contradictory "your input is wrong but you may retry". - C2: `retry.Do` short-circuits an `InputError` (non-retriable) — **but only when the caller did not pass a `RetryErr` predicate**. The check is an `if c.isRetryErr != nil { ... } else if InputError { ... }` *mutually exclusive* branch (`pkg/util/retry/retry.go`): an explicit `RetryErr` takes precedence and bypasses the InputError abort. `retry.Handle` deliberately does **not** apply the InputError abort (its callers signal abort via `shouldRetry=false`). Four flusher startup callsites that must retry through transient "not ready" errors were given explicit `RetryErr` escape hatches. **D. segcore (C++→Go) error classification.** A single shared Go-side table (`pkg/util/merr/segcore.go`) maps each segcore code to a merr sentinel + InputError/signal category, replacing scattered hand-written `if errorCode == ...` switches in the cgo wrappers. **Wire `Code` values change for every segcore pass-through error, not just the remapped ones.** Named sentinels remap (C++ `2003` → merr `2001`, `2033` → `2002`, Folly/Knowhere codes likewise); **all remaining pass-through codes (`2004`–`2043`, previously surfaced to clients as raw C++ enum values) now serialize as `2000`** (`ErrSegcore`), with the original C++ code preserved in the `Reason` text (`segcoreCode=...`); unknown/future codes collapse to `2000` as well (pinned by the `wire_code_projection` test). Transient segcore classes (object storage / file IO / OOM / mmap / FieldNotLoaded — 11 codes) now report `Retriable=true`. **Any client switching on raw segcore codes in the `2004`–`2043` range must be re-checked**; the in-Reason code remains available for diagnostics. Signal codes (PretendFinished / FollyCancel) are recognized centrally. `errors.Is`-based control flow on these (e.g. scheduler skip/retry) is preserved. **E. InputError classification (25 sentinels + dynamic marks).** 25 sentinels in `errors.go` carry `WithErrorType(InputError)` (the Collection / ResourceGroup / Database families, `ErrIndexDuplicate`, `ErrParameterInvalid`, `ErrPrivilegeNotAuthenticated`, `ErrImportFailed`, `ErrQueryPlan`, ...), plus dynamic marks for the 8 segcore input codes (ExprInvalid, DimNotMatch, MetricTypeInvalid, FieldIDInvalid, ...) and `WrapErrAsInputError`. The widest blast radius is `ErrParameterInvalid` (1100): ~2335 `WrapErrParameterInvalid*` callsites now classify as input / non-retriable. Because of C1/C2 this changes retriability for any path that returns these. **The audit to confirm no transient path was mis-marked is the single most important review item** (see Part 3). One reverse correction: storage field-stats parsing moved from `ErrParameterInvalid` (input) to `ErrDataIntegrity` — a corrupted stored stat is data corruption, not user input. ### Part 3 — Known risks & traps (called out proactively) 1. **`merr.Wrap` vs `WrapErr*Err` (code-masking).** `WrapErr*Err` builds a `wrappedMilvusError{sentinel: ErrServiceInternal}` whose `code()` returns the *outer* sentinel — it overwrites the inner typed code and hides the `errors.Is` chain. This is intentional (use it to *deliberately* downgrade), but it was a recurring conversion defect; the rule "add context with `merr.Wrap`, downgrade with `WrapErr*Err`" is enforced by convention and reviewed across the diff. 2. **InputError × `retry.Do` blast radius.** Marking a sentinel `InputError` makes any `retry.Do(...)` without a `RetryErr` predicate stop retrying it. Reviewers should sanity-check that no transient use of the 19 newly-marked sentinels (especially `ErrParameterInvalid`) sits inside a retry loop that needed to keep spinning. The known flusher cases were handled (see C2). 3. **The ~340 raw-error allowlist.** What remains as bare `errors.New` is, by design: package-level sentinels (caught by `errors.Is`), `//go:build test` sites, and out-of-band trees (`cmd/`, `tests/`, codegen, walimpls). The linter only bans the *direct-return* form; assignment-then-return escapes and the full no-exceptions ban are deferred to an AST-based linter (Tier 2, documented). 4. **segcore C++ second step deferred.** This PR unifies classification on the Go side; splitting the dual-semantic C++ codes at the source is a follow-up. --- ## Validation - `make verifiers`: Go side clean (gofmt + static-check across modules, including the new `rawmerrerror` rule with a 0-hit baseline repo-wide). - `make test-go`: passing; the one real regression introduced (a datanode `invalid_task_type` assertion shifting `1` → `5` from a ParameterInvalid conversion) was fixed in-tree. - go_client e2e CreateIndex assertions aligned to the new merr messages. --------- Signed-off-by: zhenshan.cao <zhenshan.cao@zilliz.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
290 lines
8.7 KiB
Go
290 lines
8.7 KiB
Go
package datacoord
|
|
|
|
import (
|
|
"context"
|
|
"math"
|
|
|
|
"github.com/samber/lo"
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/milvus-io/milvus-proto/go-api/v3/milvuspb"
|
|
"github.com/milvus-io/milvus/internal/datacoord/allocator"
|
|
"github.com/milvus-io/milvus/internal/datacoord/session"
|
|
"github.com/milvus-io/milvus/internal/types"
|
|
"github.com/milvus-io/milvus/internal/util/sessionutil"
|
|
"github.com/milvus-io/milvus/pkg/v3/common"
|
|
"github.com/milvus-io/milvus/pkg/v3/log"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/merr"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/metricsinfo"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/paramtable"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/typeutil"
|
|
)
|
|
|
|
const (
|
|
// Fallback memory for pooling DataNode (returns 0 from GetMetrics)
|
|
defaultPoolingDataNodeMemory = 32 * 1024 * 1024 * 1024 // 32GB
|
|
)
|
|
|
|
// CollectionTopology captures memory constraints for a collection
|
|
type CollectionTopology struct {
|
|
CollectionID int64
|
|
NumReplicas int
|
|
NumShards int
|
|
IsStandaloneMode bool
|
|
IsPooling bool
|
|
|
|
QueryNodeMemory map[int64]uint64
|
|
DataNodeMemory map[int64]uint64
|
|
}
|
|
|
|
// CollectionTopologyQuerier queries collection topology including replicas and memory info
|
|
type CollectionTopologyQuerier interface {
|
|
GetCollectionTopology(ctx context.Context, collectionID int64) (*CollectionTopology, error)
|
|
}
|
|
|
|
type forceMergeCompactionPolicy struct {
|
|
meta *meta
|
|
allocator allocator.Allocator
|
|
handler Handler
|
|
topologyQuerier CollectionTopologyQuerier
|
|
}
|
|
|
|
func newForceMergeCompactionPolicy(meta *meta, allocator allocator.Allocator, handler Handler) *forceMergeCompactionPolicy {
|
|
return &forceMergeCompactionPolicy{
|
|
meta: meta,
|
|
allocator: allocator,
|
|
handler: handler,
|
|
topologyQuerier: nil,
|
|
}
|
|
}
|
|
|
|
func (policy *forceMergeCompactionPolicy) SetTopologyQuerier(querier CollectionTopologyQuerier) {
|
|
policy.topologyQuerier = querier
|
|
}
|
|
|
|
func (policy *forceMergeCompactionPolicy) triggerOneCollection(
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
targetSize int64,
|
|
) ([]CompactionView, int64, error) {
|
|
log := log.Ctx(ctx).With(
|
|
zap.Int64("collectionID", collectionID),
|
|
zap.Int64("targetSize", targetSize))
|
|
if policy.meta.isCollectionCompactionBlocked(collectionID) {
|
|
log.Info("skip force merge compaction for collection due to unloaded protected snapshot RefIndex",
|
|
zap.Int64("collectionID", collectionID))
|
|
return nil, 0, nil
|
|
}
|
|
collection, err := policy.handler.GetCollection(ctx, collectionID)
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
triggerID, err := policy.allocator.AllocID(ctx)
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
collectionTTL, err := common.GetCollectionTTLFromMap(collection.Properties)
|
|
if err != nil {
|
|
log.Warn("failed to get collection ttl, use default", zap.Error(err))
|
|
collectionTTL = 0
|
|
}
|
|
|
|
// Convert targetSize from MB to bytes (per design doc: targetSize is in MB)
|
|
// Handle overflow: when targetSize is very large (e.g., max_int64 for auto-calculate mode)
|
|
var targetSizeBytes int64
|
|
if targetSize > math.MaxInt64/(1024*1024) {
|
|
targetSizeBytes = math.MaxInt64
|
|
} else {
|
|
targetSizeBytes = targetSize * 1024 * 1024
|
|
}
|
|
|
|
configMaxSize := getExpectedSegmentSize(policy.meta, collectionID, collection.Schema)
|
|
if targetSizeBytes < configMaxSize {
|
|
return nil, 0, merr.WrapErrParameterInvalidMsg("targetSize %d MB should be greater than or equal to configMaxSize %d MB", targetSize, configMaxSize/(1024*1024))
|
|
}
|
|
|
|
segments := policy.meta.SelectSegments(ctx, WithCollection(collectionID), SegmentFilterFunc(func(segment *SegmentInfo) bool {
|
|
return isNormalManualCompactionCandidate(policy.meta, segment)
|
|
}))
|
|
|
|
if len(segments) == 0 {
|
|
log.Info("no eligible segments for force merge")
|
|
return nil, 0, nil
|
|
}
|
|
|
|
topology, err := policy.topologyQuerier.GetCollectionTopology(ctx, collectionID)
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
topology.NumShards = len(collection.VChannelNames)
|
|
|
|
views := []CompactionView{}
|
|
for label, groups := range groupByPartitionChannel(GetViewsByInfo(segments...)) {
|
|
view := &ForceMergeSegmentView{
|
|
label: label,
|
|
segments: groups,
|
|
triggerID: triggerID,
|
|
collectionTTL: collectionTTL,
|
|
|
|
configMaxSize: float64(configMaxSize),
|
|
expectedTargetSize: float64(targetSizeBytes),
|
|
topology: topology,
|
|
}
|
|
views = append(views, view)
|
|
}
|
|
|
|
log.Info("force merge triggered", zap.Int("viewCount", len(views)))
|
|
return views, triggerID, nil
|
|
}
|
|
|
|
func groupByPartitionChannel(segments []*SegmentView) map[*CompactionGroupLabel][]*SegmentView {
|
|
result := make(map[*CompactionGroupLabel][]*SegmentView)
|
|
|
|
for _, seg := range segments {
|
|
label := seg.label
|
|
key := label.Key()
|
|
|
|
var foundLabel *CompactionGroupLabel
|
|
for l := range result {
|
|
if l.Key() == key {
|
|
foundLabel = l
|
|
break
|
|
}
|
|
}
|
|
if foundLabel == nil {
|
|
foundLabel = label
|
|
}
|
|
|
|
result[foundLabel] = append(result[foundLabel], seg)
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
type metricsNodeMemoryQuerier struct {
|
|
nodeManager session.NodeManager
|
|
mixCoord types.MixCoord
|
|
session sessionutil.SessionInterface
|
|
}
|
|
|
|
func newMetricsNodeMemoryQuerier(nodeManager session.NodeManager, mixCoord types.MixCoord, session sessionutil.SessionInterface) *metricsNodeMemoryQuerier {
|
|
return &metricsNodeMemoryQuerier{
|
|
nodeManager: nodeManager,
|
|
mixCoord: mixCoord,
|
|
session: session,
|
|
}
|
|
}
|
|
|
|
var _ CollectionTopologyQuerier = (*metricsNodeMemoryQuerier)(nil)
|
|
|
|
func (q *metricsNodeMemoryQuerier) GetCollectionTopology(ctx context.Context, collectionID int64) (*CollectionTopology, error) {
|
|
log := log.Ctx(ctx).With(zap.Int64("collectionID", collectionID))
|
|
if q.mixCoord == nil {
|
|
return nil, merr.WrapErrServiceInternalMsg("mixCoord not available for topology query")
|
|
}
|
|
|
|
// 1. Get replica information
|
|
replicasResp, err := q.mixCoord.GetReplicas(ctx, &milvuspb.GetReplicasRequest{
|
|
CollectionID: collectionID,
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
numReplicas := len(replicasResp.GetReplicas())
|
|
|
|
// 2. Get QueryNode metrics for memory info
|
|
req, err := metricsinfo.ConstructRequestByMetricType(metricsinfo.SystemInfoMetrics)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Get QueryNode sessions from etcd to filter out embedded nodes
|
|
sessions, _, err := q.session.GetSessions(ctx, typeutil.QueryNodeRole)
|
|
if err != nil {
|
|
log.Warn("failed to get QueryNode sessions", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
|
|
// Build set of embedded QueryNode IDs to exclude
|
|
embeddedNodeIDs := make(map[int64]struct{})
|
|
for _, sess := range sessions {
|
|
// Check if this is an embedded QueryNode in streaming node
|
|
if labels := sess.ServerLabels; labels != nil {
|
|
if labels[sessionutil.LabelStreamingNodeEmbeddedQueryNode] == "1" {
|
|
embeddedNodeIDs[sess.ServerID] = struct{}{}
|
|
}
|
|
}
|
|
}
|
|
|
|
log.Info("excluding embedded QueryNode", zap.Int64s("nodeIDs", lo.Keys(embeddedNodeIDs)))
|
|
rsp, err := q.mixCoord.GetQcMetrics(ctx, req)
|
|
if err = merr.CheckRPCCall(rsp, err); err != nil {
|
|
return nil, err
|
|
}
|
|
topology := &metricsinfo.QueryCoordTopology{}
|
|
if err := metricsinfo.UnmarshalTopology(rsp.GetResponse(), topology); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Build QueryNode memory map: nodeID → memory size (exclude embedded nodes)
|
|
queryNodeMemory := make(map[int64]uint64)
|
|
for _, node := range topology.Cluster.ConnectedNodes {
|
|
if _, ok := embeddedNodeIDs[node.ID]; ok {
|
|
continue
|
|
}
|
|
queryNodeMemory[node.ID] = node.HardwareInfos.Memory
|
|
}
|
|
|
|
// 3. Get DataNode memory info
|
|
dataNodeMemory := make(map[int64]uint64)
|
|
isPooling := false
|
|
nodes := q.nodeManager.GetClientIDs()
|
|
for _, nodeID := range nodes {
|
|
cli, err := q.nodeManager.GetClient(nodeID)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
|
|
resp, err := cli.GetMetrics(ctx, req)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
|
|
var infos metricsinfo.DataNodeInfos
|
|
if err := metricsinfo.UnmarshalComponentInfos(resp.GetResponse(), &infos); err != nil {
|
|
continue
|
|
}
|
|
|
|
if infos.HardwareInfos.Memory > 0 {
|
|
dataNodeMemory[nodeID] = infos.HardwareInfos.Memory
|
|
} else {
|
|
// Pooling DataNode returns 0 from GetMetrics
|
|
// Use default fallback: 32GB
|
|
isPooling = true
|
|
log.Warn("DataNode returned 0 memory (pooling mode?), using default",
|
|
zap.Int64("nodeID", nodeID),
|
|
zap.Uint64("defaultMemory", defaultPoolingDataNodeMemory))
|
|
dataNodeMemory[nodeID] = defaultPoolingDataNodeMemory
|
|
}
|
|
}
|
|
|
|
isStandaloneMode := paramtable.GetRole() == typeutil.StandaloneRole
|
|
log.Info("Collection topology",
|
|
zap.Int64("collectionID", collectionID),
|
|
zap.Int("numReplicas", numReplicas),
|
|
zap.Any("querynodes", queryNodeMemory),
|
|
zap.Any("datanodes", dataNodeMemory),
|
|
zap.Bool("isStandaloneMode", isStandaloneMode),
|
|
zap.Bool("isPooling", isPooling))
|
|
|
|
return &CollectionTopology{
|
|
CollectionID: collectionID,
|
|
NumReplicas: numReplicas,
|
|
QueryNodeMemory: queryNodeMemory,
|
|
DataNodeMemory: dataNodeMemory,
|
|
IsStandaloneMode: isStandaloneMode,
|
|
IsPooling: isPooling,
|
|
}, nil
|
|
}
|