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>
241 lines
8.8 KiB
Go
241 lines
8.8 KiB
Go
package datacoord
|
|
|
|
import (
|
|
"context"
|
|
"sync"
|
|
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/milvus-io/milvus/internal/metastore"
|
|
"github.com/milvus-io/milvus/pkg/v3/log"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/datapb"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/merr"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/timerecord"
|
|
)
|
|
|
|
const emptyPartitionStatsVersion = int64(0)
|
|
|
|
type partitionStatsMeta struct {
|
|
sync.RWMutex
|
|
ctx context.Context
|
|
catalog metastore.DataCoordCatalog
|
|
partitionStatsInfos map[string]map[int64]*partitionStatsInfo // channel -> partition -> PartitionStatsInfo
|
|
}
|
|
|
|
type partitionStatsInfo struct {
|
|
currentVersion int64
|
|
infos map[int64]*datapb.PartitionStatsInfo
|
|
}
|
|
|
|
func newPartitionStatsMeta(ctx context.Context, catalog metastore.DataCoordCatalog) (*partitionStatsMeta, error) {
|
|
psm := &partitionStatsMeta{
|
|
RWMutex: sync.RWMutex{},
|
|
ctx: ctx,
|
|
catalog: catalog,
|
|
partitionStatsInfos: make(map[string]map[int64]*partitionStatsInfo),
|
|
}
|
|
if err := psm.reloadFromKV(); err != nil {
|
|
return nil, err
|
|
}
|
|
return psm, nil
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) reloadFromKV() error {
|
|
record := timerecord.NewTimeRecorder("partitionStatsMeta-reloadFromKV")
|
|
|
|
partitionStatsInfos, err := psm.catalog.ListPartitionStatsInfos(psm.ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, info := range partitionStatsInfos {
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()]; !ok {
|
|
psm.partitionStatsInfos[info.GetVChannel()] = make(map[int64]*partitionStatsInfo)
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()]; !ok {
|
|
currentPartitionStatsVersion, err := psm.catalog.GetCurrentPartitionStatsVersion(psm.ctx, info.GetCollectionID(), info.GetPartitionID(), info.GetVChannel())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()] = &partitionStatsInfo{
|
|
currentVersion: currentPartitionStatsVersion,
|
|
infos: make(map[int64]*datapb.PartitionStatsInfo),
|
|
}
|
|
}
|
|
psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()].infos[info.GetVersion()] = info
|
|
}
|
|
log.Info("DataCoord partitionStatsMeta reloadFromKV done", zap.Duration("duration", record.ElapseSpan()))
|
|
return nil
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) ListAllPartitionStatsInfos() []*datapb.PartitionStatsInfo {
|
|
psm.RLock()
|
|
defer psm.RUnlock()
|
|
res := make([]*datapb.PartitionStatsInfo, 0)
|
|
for _, partitionStats := range psm.partitionStatsInfos {
|
|
for _, infos := range partitionStats {
|
|
for _, info := range infos.infos {
|
|
res = append(res, info)
|
|
}
|
|
}
|
|
}
|
|
return res
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) ListPartitionStatsInfos(collectionID int64, partitionID int64, vchannel string, filters ...func([]*datapb.PartitionStatsInfo) []*datapb.PartitionStatsInfo) []*datapb.PartitionStatsInfo {
|
|
psm.RLock()
|
|
defer psm.RUnlock()
|
|
res := make([]*datapb.PartitionStatsInfo, 0)
|
|
partitionStats, ok := psm.partitionStatsInfos[vchannel]
|
|
if !ok {
|
|
return res
|
|
}
|
|
infos, ok := partitionStats[partitionID]
|
|
if !ok {
|
|
return res
|
|
}
|
|
for _, info := range infos.infos {
|
|
res = append(res, info)
|
|
}
|
|
|
|
for _, filter := range filters {
|
|
res = filter(res)
|
|
}
|
|
return res
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) SavePartitionStatsInfo(info *datapb.PartitionStatsInfo) error {
|
|
psm.Lock()
|
|
defer psm.Unlock()
|
|
if err := psm.catalog.SavePartitionStatsInfo(context.TODO(), info); err != nil {
|
|
log.Ctx(context.TODO()).Error("meta update: update PartitionStatsInfo info fail", zap.Error(err))
|
|
return err
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()]; !ok {
|
|
psm.partitionStatsInfos[info.GetVChannel()] = make(map[int64]*partitionStatsInfo)
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()]; !ok {
|
|
psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()] = &partitionStatsInfo{
|
|
infos: make(map[int64]*datapb.PartitionStatsInfo),
|
|
}
|
|
}
|
|
|
|
psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()].infos[info.GetVersion()] = info
|
|
return nil
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) DropPartitionStatsInfo(ctx context.Context, info *datapb.PartitionStatsInfo) error {
|
|
psm.Lock()
|
|
defer psm.Unlock()
|
|
// if the dropping partitionStats is the current version, should update currentPartitionStats
|
|
currentVersion := psm.innerGetCurrentPartitionStatsVersion(info.GetCollectionID(), info.GetPartitionID(), info.GetVChannel())
|
|
if currentVersion == info.GetVersion() && currentVersion != emptyPartitionStatsVersion {
|
|
infos := psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()].infos
|
|
if len(infos) > 0 {
|
|
var maxVersion int64 = 0
|
|
for version := range infos {
|
|
if version > maxVersion && version < currentVersion {
|
|
maxVersion = version
|
|
}
|
|
}
|
|
err := psm.innerSaveCurrentPartitionStatsVersion(info.GetCollectionID(), info.GetPartitionID(), info.GetVChannel(), maxVersion)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
|
|
if err := psm.catalog.DropPartitionStatsInfo(ctx, info); err != nil {
|
|
log.Ctx(ctx).Error("meta update: drop PartitionStatsInfo info fail",
|
|
zap.Int64("collectionID", info.GetCollectionID()),
|
|
zap.Int64("partitionID", info.GetPartitionID()),
|
|
zap.String("vchannel", info.GetVChannel()),
|
|
zap.Int64("version", info.GetVersion()),
|
|
zap.Error(err))
|
|
return err
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()]; !ok {
|
|
return nil
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()]; !ok {
|
|
return nil
|
|
}
|
|
delete(psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()].infos, info.GetVersion())
|
|
if len(psm.partitionStatsInfos[info.GetVChannel()][info.GetPartitionID()].infos) == 0 {
|
|
delete(psm.partitionStatsInfos[info.GetVChannel()], info.GetPartitionID())
|
|
}
|
|
if len(psm.partitionStatsInfos[info.GetVChannel()]) == 0 {
|
|
delete(psm.partitionStatsInfos, info.GetVChannel())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) SaveCurrentPartitionStatsVersion(collectionID, partitionID int64, vChannel string, currentPartitionStatsVersion int64) error {
|
|
psm.Lock()
|
|
defer psm.Unlock()
|
|
return psm.innerSaveCurrentPartitionStatsVersion(collectionID, partitionID, vChannel, currentPartitionStatsVersion)
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) innerSaveCurrentPartitionStatsVersion(collectionID, partitionID int64, vChannel string, currentPartitionStatsVersion int64) error {
|
|
log.Ctx(context.TODO()).Info("update current partition stats version", zap.Int64("collectionID", collectionID),
|
|
zap.Int64("partitionID", partitionID),
|
|
zap.String("vChannel", vChannel), zap.Int64("currentPartitionStatsVersion", currentPartitionStatsVersion))
|
|
|
|
if _, ok := psm.partitionStatsInfos[vChannel]; !ok {
|
|
return merr.WrapErrClusteringCompactionMetaError("SaveCurrentPartitionStatsVersion",
|
|
merr.WrapErrServiceInternalMsg("update current partition stats version failed, there is no partition info exists with collID: %d, partID: %d, vChannel: %s", collectionID, partitionID, vChannel))
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[vChannel][partitionID]; !ok {
|
|
return merr.WrapErrClusteringCompactionMetaError("SaveCurrentPartitionStatsVersion",
|
|
merr.WrapErrServiceInternalMsg("update current partition stats version failed, there is no partition info exists with collID: %d, partID: %d, vChannel: %s", collectionID, partitionID, vChannel))
|
|
}
|
|
|
|
if err := psm.catalog.SaveCurrentPartitionStatsVersion(psm.ctx, collectionID, partitionID, vChannel, currentPartitionStatsVersion); err != nil {
|
|
return err
|
|
}
|
|
|
|
psm.partitionStatsInfos[vChannel][partitionID].currentVersion = currentPartitionStatsVersion
|
|
return nil
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) GetCurrentPartitionStatsVersion(collectionID, partitionID int64, vChannel string) int64 {
|
|
psm.RLock()
|
|
defer psm.RUnlock()
|
|
return psm.innerGetCurrentPartitionStatsVersion(collectionID, partitionID, vChannel)
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) innerGetCurrentPartitionStatsVersion(collectionID, partitionID int64, vChannel string) int64 {
|
|
if _, ok := psm.partitionStatsInfos[vChannel]; !ok {
|
|
return emptyPartitionStatsVersion
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[vChannel][partitionID]; !ok {
|
|
return emptyPartitionStatsVersion
|
|
}
|
|
return psm.partitionStatsInfos[vChannel][partitionID].currentVersion
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) GetPartitionStats(collectionID, partitionID int64, vChannel string, version int64) *datapb.PartitionStatsInfo {
|
|
psm.RLock()
|
|
defer psm.RUnlock()
|
|
|
|
if _, ok := psm.partitionStatsInfos[vChannel]; !ok {
|
|
return nil
|
|
}
|
|
if _, ok := psm.partitionStatsInfos[vChannel][partitionID]; !ok {
|
|
return nil
|
|
}
|
|
return psm.partitionStatsInfos[vChannel][partitionID].infos[version]
|
|
}
|
|
|
|
func (psm *partitionStatsMeta) GetChannelPartitionsStatsVersion(collectionID int64, vChannel string) map[int64]int64 {
|
|
psm.RLock()
|
|
defer psm.RUnlock()
|
|
|
|
result := make(map[int64]int64)
|
|
partitionsStats := psm.partitionStatsInfos[vChannel]
|
|
for partitionID, info := range partitionsStats {
|
|
result[partitionID] = info.currentVersion
|
|
}
|
|
|
|
return result
|
|
}
|