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>
661 lines
23 KiB
Go
661 lines
23 KiB
Go
// 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 compactor
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"runtime/debug"
|
|
"time"
|
|
|
|
"github.com/apache/arrow/go/v17/arrow/array"
|
|
"github.com/samber/lo"
|
|
"go.opentelemetry.io/otel"
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/milvus-io/milvus-proto/go-api/v3/schemapb"
|
|
"github.com/milvus-io/milvus/internal/allocator"
|
|
"github.com/milvus-io/milvus/internal/compaction"
|
|
"github.com/milvus-io/milvus/internal/flushcommon/io"
|
|
"github.com/milvus-io/milvus/internal/metastore/kv/binlog"
|
|
"github.com/milvus-io/milvus/internal/storage"
|
|
"github.com/milvus-io/milvus/internal/storagev2/packed"
|
|
"github.com/milvus-io/milvus/pkg/v3/common"
|
|
"github.com/milvus-io/milvus/pkg/v3/log"
|
|
"github.com/milvus-io/milvus/pkg/v3/metrics"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/datapb"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/indexpb"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/funcutil"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/merr"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/paramtable"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/timerecord"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/typeutil"
|
|
)
|
|
|
|
type sortCompactionTask struct {
|
|
binlogIO io.BinlogIO
|
|
cm storage.ChunkManager
|
|
currentTime time.Time
|
|
|
|
plan *datapb.CompactionPlan
|
|
|
|
ctx context.Context
|
|
cancel context.CancelFunc
|
|
|
|
collectionID int64
|
|
partitionID int64
|
|
segmentID int64
|
|
insertLogs []*datapb.FieldBinlog
|
|
storageVersion int64
|
|
segmentStorageVersion int64
|
|
manifest string
|
|
useLoonFFI bool
|
|
|
|
ttlFieldID int64
|
|
|
|
done chan struct{}
|
|
tr *timerecord.TimeRecorder
|
|
|
|
compactionParams compaction.Params
|
|
sortByFieldIDs []int64
|
|
|
|
// lobContext holds LOB compaction strategy decisions for TEXT columns
|
|
lobContext *compaction.LOBCompactionContext
|
|
}
|
|
|
|
var _ Compactor = (*sortCompactionTask)(nil)
|
|
|
|
func NewSortCompactionTask(
|
|
ctx context.Context,
|
|
cm storage.ChunkManager,
|
|
plan *datapb.CompactionPlan,
|
|
compactionParams compaction.Params,
|
|
sortByFieldIDs []int64,
|
|
) *sortCompactionTask {
|
|
ctx1, cancel := context.WithCancel(ctx)
|
|
return &sortCompactionTask{
|
|
ctx: ctx1,
|
|
cancel: cancel,
|
|
binlogIO: io.NewBinlogIO(cm),
|
|
cm: cm,
|
|
plan: plan,
|
|
tr: timerecord.NewTimeRecorder("sort compaction"),
|
|
currentTime: time.Now(),
|
|
done: make(chan struct{}, 1),
|
|
compactionParams: compactionParams,
|
|
sortByFieldIDs: sortByFieldIDs,
|
|
}
|
|
}
|
|
|
|
// preCompact examines whether it's a valid compaction plan, and initializes the collectionID and partitionID
|
|
func (t *sortCompactionTask) preCompact() error {
|
|
if ok := funcutil.CheckCtxValid(t.ctx); !ok {
|
|
return t.ctx.Err()
|
|
}
|
|
|
|
if len(t.plan.GetSegmentBinlogs()) != 1 {
|
|
// The plan is produced by datacoord, so a malformed plan is an internal
|
|
// protocol violation, not user input.
|
|
return merr.WrapErrServiceInternalMsg("sort compaction should handle exactly one segment, but got %d segments, planID = %d",
|
|
len(t.plan.GetSegmentBinlogs()), t.GetPlanID())
|
|
}
|
|
|
|
segment := t.plan.GetSegmentBinlogs()[0]
|
|
t.collectionID = segment.GetCollectionID()
|
|
t.partitionID = segment.GetPartitionID()
|
|
t.segmentID = segment.GetSegmentID()
|
|
|
|
if err := binlog.DecompressBinLogWithRootPath(t.compactionParams.StorageConfig.GetRootPath(),
|
|
storage.InsertBinlog, t.collectionID, t.partitionID,
|
|
t.segmentID, segment.GetFieldBinlogs()); err != nil {
|
|
log.Ctx(t.ctx).Warn("Decompress insert binlog error", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
if err := binlog.DecompressBinLogWithRootPath(t.compactionParams.StorageConfig.GetRootPath(),
|
|
storage.DeleteBinlog, t.collectionID, t.partitionID,
|
|
t.segmentID, segment.GetDeltalogs()); err != nil {
|
|
log.Ctx(t.ctx).Warn("Decompress delta binlog error", zap.Error(err))
|
|
return err
|
|
}
|
|
|
|
t.insertLogs = segment.GetFieldBinlogs()
|
|
t.storageVersion = t.compactionParams.StorageVersion
|
|
t.segmentStorageVersion = segment.GetStorageVersion()
|
|
t.manifest = segment.GetManifest()
|
|
t.useLoonFFI = t.compactionParams.UseLoonFFI
|
|
t.ttlFieldID = getTTLFieldID(t.plan.GetSchema())
|
|
|
|
log.Ctx(t.ctx).Info("preCompaction analyze",
|
|
zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64("collectionID", t.collectionID),
|
|
zap.Int64("partitionID", t.partitionID),
|
|
zap.Int64("segmentID", t.segmentID),
|
|
zap.Int64("storageVersion", t.storageVersion),
|
|
zap.Bool("useLoonFFI", t.useLoonFFI),
|
|
zap.Any("compactionParams", t.compactionParams),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (t *sortCompactionTask) sortSegment(ctx context.Context) (*datapb.CompactionPlanResult, error) {
|
|
log := log.Ctx(ctx).With(
|
|
zap.Int64("planID", t.plan.GetPlanID()),
|
|
zap.Int64("collectionID", t.collectionID),
|
|
zap.Int64("partitionID", t.partitionID),
|
|
zap.Int64("segmentID", t.segmentID),
|
|
)
|
|
sortStartTime := time.Now()
|
|
numRows := t.plan.GetTotalRows()
|
|
pkField, err := typeutil.GetPrimaryFieldSchema(t.plan.GetSchema())
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
alloc := allocator.NewLocalAllocator(t.plan.GetPreAllocatedLogIDs().GetBegin(), t.plan.GetPreAllocatedLogIDs().GetEnd())
|
|
targetSegmentID := t.plan.GetPreAllocatedSegmentIDs().GetBegin()
|
|
|
|
phaseStart := time.Now()
|
|
|
|
writerSchema := t.plan.GetSchema()
|
|
|
|
srw, err := storage.NewBinlogRecordWriter(ctx,
|
|
t.collectionID,
|
|
t.partitionID,
|
|
targetSegmentID,
|
|
writerSchema,
|
|
alloc,
|
|
t.compactionParams.BinLogMaxSize,
|
|
numRows,
|
|
storage.WithUploader(func(ctx context.Context, kvs map[string][]byte) error {
|
|
return t.binlogIO.Upload(ctx, kvs)
|
|
}),
|
|
storage.WithVersion(t.storageVersion),
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig),
|
|
storage.WithUseLoonFFI(t.useLoonFFI),
|
|
)
|
|
if err != nil {
|
|
log.Warn("sort segment wrong, unable to init segment writer",
|
|
zap.Int64("planID", t.plan.GetPlanID()), zap.Error(err))
|
|
return nil, err
|
|
}
|
|
initWriterCost := time.Since(phaseStart)
|
|
|
|
phaseStart = time.Now()
|
|
deletePKs, err := compaction.ComposeDeleteFromDeltalogs(ctx, pkField.DataType, t.plan.SegmentBinlogs[0],
|
|
storage.WithDownloader(t.binlogIO.Download),
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig))
|
|
if err != nil {
|
|
log.Warn("load deletePKs failed", zap.Error(err))
|
|
srw.Close()
|
|
return nil, err
|
|
}
|
|
loadDeltaCost := time.Since(phaseStart)
|
|
hasTTLField := t.ttlFieldID >= common.StartOfUserFieldID
|
|
|
|
entityFilter := compaction.NewEntityFilter(deletePKs, t.plan.GetCollectionTtl(), t.currentTime, t.plan.GetSegmentBinlogs()[0].GetCommitTimestamp())
|
|
var predicate func(r storage.Record, ri, i int) bool
|
|
switch pkField.DataType {
|
|
case schemapb.DataType_Int64:
|
|
predicate = func(r storage.Record, ri, i int) bool {
|
|
pk := r.Column(pkField.FieldID).(*array.Int64).Value(i)
|
|
ts := r.Column(common.TimeStampField).(*array.Int64).Value(i)
|
|
expireTs := int64(-1)
|
|
if hasTTLField {
|
|
col := r.Column(t.ttlFieldID).(*array.Int64)
|
|
if col.IsValid(i) {
|
|
expireTs = col.Value(i)
|
|
}
|
|
}
|
|
return !entityFilter.Filtered(pk, uint64(ts), expireTs)
|
|
}
|
|
case schemapb.DataType_VarChar:
|
|
predicate = func(r storage.Record, ri, i int) bool {
|
|
pk := r.Column(pkField.FieldID).(*array.String).Value(i)
|
|
ts := r.Column(common.TimeStampField).(*array.Int64).Value(i)
|
|
expireTs := int64(-1)
|
|
if hasTTLField {
|
|
col := r.Column(t.ttlFieldID).(*array.Int64)
|
|
if col.IsValid(i) {
|
|
expireTs = col.Value(i)
|
|
}
|
|
}
|
|
return !entityFilter.Filtered(pk, uint64(ts), expireTs)
|
|
}
|
|
default:
|
|
log.Warn("sort task only support int64 and varchar pk field")
|
|
}
|
|
|
|
phaseStart = time.Now()
|
|
rr, existingFields, err := newCompactionSegmentRecordReader(ctx, t.plan.GetSegmentBinlogs()[0], t.plan.Schema, t.compactionParams.StorageConfig,
|
|
storage.WithVersion(t.segmentStorageVersion),
|
|
storage.WithDownloader(t.binlogIO.Download),
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig),
|
|
storage.WithCollectionID(t.collectionID),
|
|
)
|
|
if err != nil {
|
|
log.Warn("error creating insert binlog reader", zap.Error(err))
|
|
srw.Close()
|
|
return nil, err
|
|
}
|
|
materializer, err := NewRecordMaterializer(writerSchema, writerSchema.GetFunctions(), existingFields)
|
|
if err != nil {
|
|
log.Warn("error creating record materializer", zap.Error(err))
|
|
rr.Close()
|
|
srw.Close()
|
|
return nil, err
|
|
}
|
|
rr = newMaterializedRecordReader(rr, materializer)
|
|
defer rr.Close()
|
|
initReaderCost := time.Since(phaseStart)
|
|
|
|
rr = wrapReaderWithTimestampOverwrite(rr, t.plan.GetSegmentBinlogs()[0].GetCommitTimestamp())
|
|
rrs := []storage.RecordReader{rr}
|
|
numValidRows, sortTimings, err := storage.Sort(t.compactionParams.BinLogMaxSize, writerSchema, rrs, srw, predicate, t.sortByFieldIDs)
|
|
if err != nil {
|
|
log.Warn("sort failed", zap.Error(err))
|
|
srw.Close()
|
|
return nil, err
|
|
}
|
|
if sortTimings == nil {
|
|
sortTimings = &storage.SortTimings{}
|
|
}
|
|
|
|
if t.lobContext != nil && t.lobContext.HasReuseAllFields() {
|
|
t.lobContext.SetSegmentRowStats(t.segmentID, numRows, numRows-int64(numValidRows))
|
|
}
|
|
|
|
phaseStart = time.Now()
|
|
if err := srw.Close(); err != nil {
|
|
return nil, err
|
|
}
|
|
flushCost := time.Since(phaseStart)
|
|
|
|
phaseStart = time.Now()
|
|
binlogs, stats, bm25stats, manifest, expirQuantiles := srw.GetLogs()
|
|
|
|
// For V3 segments, bloom filter and BM25 stats are already written to
|
|
// basePath/_stats/ and registered in the manifest by writeStatsV3()
|
|
// during PackedManifestRecordWriter.Close(). stats and bm25stats will
|
|
// be nil; only the manifest carries stats information.
|
|
if manifest != "" {
|
|
stats = nil
|
|
bm25stats = nil
|
|
}
|
|
|
|
insertLogs := storage.SortFieldBinlogs(binlogs)
|
|
if err := binlog.CompressFieldBinlogs(insertLogs); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var statsLogs []*datapb.FieldBinlog
|
|
if stats != nil {
|
|
statsLogs = []*datapb.FieldBinlog{stats}
|
|
if err := binlog.CompressFieldBinlogs(statsLogs); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
var bm25StatsLogs []*datapb.FieldBinlog
|
|
if len(bm25stats) > 0 {
|
|
bm25StatsLogs = lo.Values(bm25stats)
|
|
if err := binlog.CompressFieldBinlogs(bm25StatsLogs); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
compressCost := time.Since(phaseStart)
|
|
|
|
debug.FreeOSMemory()
|
|
|
|
if numValidRows != int(numRows)-entityFilter.GetDeletedCount()-entityFilter.GetExpiredCount() {
|
|
log.Warn("unexpected row count after sort compaction",
|
|
zap.Int64("target segmentID", targetSegmentID),
|
|
zap.Int64("old rows", numRows),
|
|
zap.Int("valid rows", numValidRows),
|
|
zap.Int("deleted rows", entityFilter.GetDeletedCount()),
|
|
zap.Int("expired rows", entityFilter.GetExpiredCount()))
|
|
return nil, merr.WrapErrServiceInternal("unexpected row count")
|
|
}
|
|
|
|
log.Info("sort segment end",
|
|
zap.Int64("target segmentID", targetSegmentID),
|
|
zap.Int64("old rows", numRows),
|
|
zap.Int("valid rows", numValidRows),
|
|
zap.Int("deleted rows", entityFilter.GetDeletedCount()),
|
|
zap.Int("expired rows", entityFilter.GetExpiredCount()),
|
|
zap.Int("deltaLogCount", len(t.plan.SegmentBinlogs[0].GetDeltalogs())),
|
|
zap.Int("deletePKCount", len(deletePKs)),
|
|
zap.Bool("useManifest", t.manifest != ""),
|
|
zap.Duration("initWriterCost", initWriterCost),
|
|
zap.Duration("loadDeltaCost", loadDeltaCost),
|
|
zap.Duration("initReaderCost", initReaderCost),
|
|
zap.Int("sortBatches", sortTimings.NumBatches),
|
|
zap.Duration("sortReadCost", sortTimings.ReadCost),
|
|
zap.Duration("sortSortCost", sortTimings.SortCost),
|
|
zap.Duration("sortWriteCost", sortTimings.WriteCost),
|
|
zap.Duration("flushCost", flushCost),
|
|
zap.Duration("compressCost", compressCost),
|
|
zap.Duration("total elapse", time.Since(sortStartTime)))
|
|
|
|
nodeID := fmt.Sprint(paramtable.GetNodeID())
|
|
compType := t.plan.GetType().String()
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "init_writer").Observe(float64(initWriterCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "load_delta").Observe(float64(loadDeltaCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "init_reader").Observe(float64(initReaderCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "sort_read").Observe(float64(sortTimings.ReadCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "sort_sort").Observe(float64(sortTimings.SortCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "sort_write").Observe(float64(sortTimings.WriteCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "flush").Observe(float64(flushCost.Milliseconds()))
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "compress").Observe(float64(compressCost.Milliseconds()))
|
|
|
|
isNamespaceSorted := t.plan.GetSchema().GetEnableNamespace()
|
|
isSorted := !isNamespaceSorted
|
|
res := []*datapb.CompactionSegment{
|
|
{
|
|
PlanID: t.GetPlanID(),
|
|
SegmentID: targetSegmentID,
|
|
NumOfRows: int64(numValidRows),
|
|
InsertLogs: insertLogs,
|
|
Field2StatslogPaths: statsLogs,
|
|
Bm25Logs: bm25StatsLogs,
|
|
Channel: t.GetChannelName(),
|
|
IsSorted: isSorted,
|
|
IsSortedByNamespace: isNamespaceSorted,
|
|
StorageVersion: t.storageVersion,
|
|
Manifest: manifest,
|
|
ExpirQuantiles: expirQuantiles,
|
|
},
|
|
}
|
|
planResult := &datapb.CompactionPlanResult{
|
|
State: datapb.CompactionTaskState_completed,
|
|
PlanID: t.GetPlanID(),
|
|
Channel: t.GetChannelName(),
|
|
Segments: res,
|
|
Type: t.plan.GetType(),
|
|
}
|
|
return planResult, nil
|
|
}
|
|
|
|
func (t *sortCompactionTask) Compact() (*datapb.CompactionPlanResult, error) {
|
|
if !funcutil.CheckCtxValid(t.ctx) {
|
|
return nil, t.ctx.Err()
|
|
}
|
|
ctx, span := otel.Tracer(typeutil.DataNodeRole).Start(t.ctx, fmt.Sprintf("MixCompact-%d", t.GetPlanID()))
|
|
defer span.End()
|
|
if err := t.preCompact(); err != nil {
|
|
log.Warn("failed to preCompact", zap.Error(err))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
|
|
// init LOB compaction context for TEXT columns (if any)
|
|
if err := t.initLOBCompactionContext(ctx); err != nil {
|
|
log.Ctx(ctx).Warn("failed to init LOB compaction context", zap.Error(err))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
|
|
compactStart := time.Now()
|
|
|
|
log := log.Ctx(ctx).With(zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64("collectionID", t.collectionID),
|
|
zap.Int64("partitionID", t.partitionID),
|
|
zap.Int64("segmentID", t.segmentID),
|
|
zap.Int64("totalRows", t.plan.GetTotalRows()),
|
|
zap.Int64("slotUsage", t.plan.GetSlotUsage()))
|
|
|
|
log.Info("compact start")
|
|
|
|
stepStart := time.Now()
|
|
res, err := t.sortSegment(ctx)
|
|
if err != nil {
|
|
log.Warn("failed to sort segment",
|
|
zap.Error(err))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
sortSegmentCost := time.Since(stepStart)
|
|
targetSegemntID := res.GetSegments()[0].GetSegmentID()
|
|
insertLogs := res.GetSegments()[0].GetInsertLogs()
|
|
if len(insertLogs) == 0 || res.GetSegments()[0].GetNumOfRows() == 0 {
|
|
log.Info("compact done, but target segment is zero num rows",
|
|
zap.Int64("targetSegmentID", targetSegemntID),
|
|
zap.Duration("sortSegmentCost", sortSegmentCost),
|
|
zap.Duration("compact cost", time.Since(compactStart)))
|
|
return res, nil
|
|
}
|
|
|
|
// apply LOB compaction: merge LOB file references to output manifest (REUSE_ALL)
|
|
if err := t.applyLOBCompaction(ctx, res.GetSegments()); err != nil {
|
|
log.Warn("failed to apply LOB compaction", zap.Error(err))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
|
|
stepStart = time.Now()
|
|
for _, resultSegment := range res.GetSegments() {
|
|
textStatsLogs, err := t.createTextIndex(ctx,
|
|
t.collectionID, t.partitionID, targetSegemntID, t.GetPlanID(),
|
|
resultSegment)
|
|
if err != nil {
|
|
log.Warn("failed to create text indexes", zap.Int64("targetSegmentID", targetSegemntID),
|
|
zap.Error(err))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
// For V3 segments, register text index stats in manifest.
|
|
// TextStatsLogs already carries full object keys for mixed-version compatibility;
|
|
// AddStatsToManifest stores the manifest-relative representation at commit time.
|
|
if resultSegment.GetManifest() != "" && len(textStatsLogs) > 0 {
|
|
statEntries := packed.TextIndexStatEntries(textStatsLogs, t.plan.GetCurrentScalarIndexVersion())
|
|
newManifest, mErr := packed.AddStatsToManifest(
|
|
resultSegment.GetManifest(), t.compactionParams.StorageConfig, statEntries)
|
|
if mErr != nil {
|
|
log.Warn("failed to add text index stats to manifest",
|
|
zap.Int64("targetSegmentID", targetSegemntID), zap.Error(mErr))
|
|
return &datapb.CompactionPlanResult{
|
|
PlanID: t.GetPlanID(),
|
|
State: datapb.CompactionTaskState_failed,
|
|
}, nil
|
|
}
|
|
resultSegment.Manifest = newManifest
|
|
// Dual-write: V3 segments store text index stats in both manifest and segment metadata.
|
|
// Manifest is the source of truth at load time; metadata acts as a placeholder so that
|
|
// needDoTextIndex() in stats_inspector.go won't trigger a redundant TextIndexJob.
|
|
}
|
|
resultSegment.TextStatsLogs = textStatsLogs
|
|
}
|
|
createTextIndexCost := time.Since(stepStart)
|
|
|
|
totalCost := time.Since(compactStart)
|
|
log.Info("compact done", zap.Int64("targetSegmentID", targetSegemntID),
|
|
zap.Duration("sortSegmentCost", sortSegmentCost),
|
|
zap.Duration("createTextIndexCost", createTextIndexCost),
|
|
zap.Duration("compact cost", totalCost))
|
|
|
|
nodeID := fmt.Sprint(paramtable.GetNodeID())
|
|
compType := t.plan.GetType().String()
|
|
metrics.DataNodeCompactionStageLatency.WithLabelValues(nodeID, compType, "create_text_index").Observe(float64(createTextIndexCost.Milliseconds()))
|
|
metrics.DataNodeCompactionLatency.WithLabelValues(nodeID, compType).Observe(float64(totalCost.Milliseconds()))
|
|
return res, nil
|
|
}
|
|
|
|
func (t *sortCompactionTask) Complete() {
|
|
t.done <- struct{}{}
|
|
}
|
|
|
|
func (t *sortCompactionTask) Stop() {
|
|
t.cancel()
|
|
<-t.done
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetPlanID() typeutil.UniqueID {
|
|
return t.plan.GetPlanID()
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetChannelName() string {
|
|
return t.plan.GetChannel()
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetCompactionType() datapb.CompactionType {
|
|
return datapb.CompactionType_SortCompaction
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetCollection() typeutil.UniqueID {
|
|
return t.collectionID
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetSlotUsage() int64 {
|
|
return t.plan.GetSlotUsage()
|
|
}
|
|
|
|
func (t *sortCompactionTask) GetStorageConfig() *indexpb.StorageConfig {
|
|
return t.compactionParams.StorageConfig
|
|
}
|
|
|
|
func (t *sortCompactionTask) createTextIndex(ctx context.Context,
|
|
collectionID int64,
|
|
partitionID int64,
|
|
segmentID int64,
|
|
taskID int64,
|
|
segment *datapb.CompactionSegment,
|
|
) (map[int64]*datapb.TextIndexStats, error) {
|
|
return createTextIndex(ctx, t.cm, t.plan, t.compactionParams, t.storageVersion, collectionID, partitionID, segmentID, taskID, segment)
|
|
}
|
|
|
|
// initLOBCompactionContext initializes the LOB compaction context for TEXT columns.
|
|
// For sort compaction, data is reordered but not redistributed, so TEXT columns
|
|
// use REUSE_ALL strategy (LOB references remain valid after reordering).
|
|
// The LOB file references need to be copied to the output segment's manifest.
|
|
func (t *sortCompactionTask) initLOBCompactionContext(ctx context.Context) error {
|
|
// check if there are TEXT fields in schema
|
|
textFieldIDs := compaction.GetTEXTFieldIDsFromSchema(t.plan.GetSchema())
|
|
if len(textFieldIDs) == 0 {
|
|
return nil // no TEXT fields, nothing to do
|
|
}
|
|
|
|
// only apply for manifest-based storage (storage v2/v3)
|
|
if t.manifest == "" {
|
|
return nil // no manifest-based segment, nothing to do
|
|
}
|
|
|
|
log := log.Ctx(ctx).With(
|
|
zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64("segmentID", t.segmentID),
|
|
zap.Int64s("textFieldIDs", textFieldIDs),
|
|
)
|
|
log.Info("initializing LOB compaction context for TEXT columns (sort compaction)")
|
|
|
|
// collect LOB files from source manifest
|
|
sourceManifests := map[int64]string{t.segmentID: t.manifest}
|
|
lobFilesBySegment, err := compaction.CollectLobFilesFromManifests(sourceManifests, t.compactionParams.StorageConfig)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// check if there are any LOB files
|
|
hasLobFiles := false
|
|
for _, files := range lobFilesBySegment {
|
|
if len(files) > 0 {
|
|
hasLobFiles = true
|
|
break
|
|
}
|
|
}
|
|
if !hasLobFiles {
|
|
log.Info("no LOB files found in source segment")
|
|
return nil
|
|
}
|
|
|
|
// create LOB compaction context
|
|
t.lobContext = compaction.NewLOBCompactionContext()
|
|
for segID, files := range lobFilesBySegment {
|
|
t.lobContext.AddSegmentLobFiles(segID, files)
|
|
}
|
|
|
|
// set compaction type - sort compaction forces REUSE_ALL
|
|
// sort compaction always has 1 source segment and 1 output segment
|
|
t.lobContext.SetCompactionType(datapb.CompactionType_SortCompaction, 1, 1)
|
|
|
|
// compute strategies (will use forced REUSE_ALL for all TEXT fields)
|
|
t.lobContext.ComputeStrategies(textFieldIDs, t.compactionParams.LOBHoleRatioThreshold)
|
|
|
|
// log strategy decisions
|
|
for fieldID, decision := range t.lobContext.Decisions {
|
|
log.Info("LOB compaction strategy decided",
|
|
zap.Int64("fieldID", fieldID),
|
|
zap.String("strategy", "REUSE_ALL"),
|
|
zap.Bool("isForced", t.lobContext.IsForced),
|
|
zap.Float64("holeRatio", decision.OverallHoleRatio),
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// applyLOBCompaction merges LOB file references from source segment to output segment manifests.
|
|
// Sort compaction uses REUSE_ALL strategy — LOB files are unchanged, only references need copying.
|
|
// SetSegmentRowStats is called to update valid_rows in case deleted rows were dropped during sort.
|
|
func (t *sortCompactionTask) applyLOBCompaction(ctx context.Context, outputSegments []*datapb.CompactionSegment) error {
|
|
if t.lobContext == nil {
|
|
return nil
|
|
}
|
|
|
|
if !t.lobContext.HasReuseAllFields() {
|
|
return nil
|
|
}
|
|
|
|
outputManifests := make(map[int64]string)
|
|
for _, seg := range outputSegments {
|
|
if seg.GetManifest() != "" {
|
|
outputManifests[seg.GetSegmentID()] = seg.GetManifest()
|
|
}
|
|
}
|
|
|
|
if len(outputManifests) == 0 {
|
|
return nil
|
|
}
|
|
|
|
updatedManifests, err := compaction.ApplyLobCompactionToManifests(t.lobContext, outputManifests, t.compactionParams.StorageConfig)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, seg := range outputSegments {
|
|
if newManifest, ok := updatedManifests[seg.GetSegmentID()]; ok {
|
|
seg.Manifest = newManifest
|
|
}
|
|
}
|
|
|
|
log.Ctx(ctx).Info("sort compaction: LOB file references merged to output manifest",
|
|
zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int("outputSegmentCount", len(outputManifests)),
|
|
)
|
|
|
|
return nil
|
|
}
|