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>
691 lines
21 KiB
Go
691 lines
21 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"
|
|
sio "io"
|
|
"math"
|
|
"path"
|
|
"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/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/metautil"
|
|
"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 mixCompactionTask struct {
|
|
binlogIO io.BinlogIO
|
|
currentTime time.Time
|
|
|
|
plan *datapb.CompactionPlan
|
|
|
|
ctx context.Context
|
|
cancel context.CancelFunc
|
|
|
|
collectionID int64
|
|
partitionID int64
|
|
targetSize int64
|
|
maxRows int64
|
|
|
|
bm25FieldIDs []int64
|
|
|
|
done chan struct{}
|
|
tr *timerecord.TimeRecorder
|
|
|
|
compactionParams compaction.Params
|
|
sortByFieldIDs []int64
|
|
|
|
ttlFieldID int64
|
|
|
|
// lobContext holds LOB compaction strategy decisions for TEXT columns
|
|
lobContext *compaction.LOBCompactionContext
|
|
|
|
// estimatedOutputSegmentCount is the estimated number of output segments
|
|
// computed during preCompact, used for LOB compaction strategy decision
|
|
estimatedOutputSegmentCount int64
|
|
}
|
|
|
|
var _ Compactor = (*mixCompactionTask)(nil)
|
|
|
|
func NewMixCompactionTask(
|
|
ctx context.Context,
|
|
binlogIO io.BinlogIO,
|
|
plan *datapb.CompactionPlan,
|
|
compactionParams compaction.Params,
|
|
sortByFieldIDs []int64,
|
|
) *mixCompactionTask {
|
|
ctx1, cancel := context.WithCancel(ctx)
|
|
return &mixCompactionTask{
|
|
ctx: ctx1,
|
|
cancel: cancel,
|
|
binlogIO: binlogIO,
|
|
plan: plan,
|
|
tr: timerecord.NewTimeRecorder("mergeSplit compaction"),
|
|
currentTime: time.Now(),
|
|
done: make(chan struct{}, 1),
|
|
compactionParams: compactionParams,
|
|
sortByFieldIDs: sortByFieldIDs,
|
|
}
|
|
}
|
|
|
|
// preCompact exams whether its a valid compaction plan, and init the collectionID and partitionID
|
|
func (t *mixCompactionTask) 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("compaction plan is illegal, there's no segments in compaction plan, planID = %d", t.GetPlanID())
|
|
}
|
|
|
|
if t.plan.GetMaxSize() == 0 {
|
|
return merr.WrapErrServiceInternalMsg("compaction plan is illegal, empty maxSize, planID = %d", t.GetPlanID())
|
|
}
|
|
|
|
t.collectionID = t.plan.GetSegmentBinlogs()[0].GetCollectionID()
|
|
t.partitionID = t.plan.GetSegmentBinlogs()[0].GetPartitionID()
|
|
t.targetSize = t.plan.GetMaxSize()
|
|
t.bm25FieldIDs = GetBM25FieldIDs(t.plan.GetSchema())
|
|
t.ttlFieldID = getTTLFieldID(t.plan.GetSchema())
|
|
currSize := int64(0)
|
|
for _, segmentBinlog := range t.plan.GetSegmentBinlogs() {
|
|
for i, fieldBinlog := range segmentBinlog.GetFieldBinlogs() {
|
|
for _, binlog := range fieldBinlog.GetBinlogs() {
|
|
// numRows just need to add entries num of ONE field.
|
|
if i == 0 {
|
|
t.maxRows += binlog.GetEntriesNum()
|
|
}
|
|
|
|
// MemorySize might be incorrectly
|
|
currSize += binlog.GetMemorySize()
|
|
}
|
|
}
|
|
}
|
|
|
|
t.estimatedOutputSegmentCount = int64(math.Ceil(float64(currSize) / float64(t.targetSize)))
|
|
log.Info("preCompaction analyze",
|
|
zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64("inputSize", currSize),
|
|
zap.Int64("targetSize", t.targetSize),
|
|
zap.Int("inputSegmentCount", len(t.plan.GetSegmentBinlogs())),
|
|
zap.Int64("estimatedOutputSegmentCount", t.estimatedOutputSegmentCount),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (t *mixCompactionTask) mergeSplit(
|
|
ctx context.Context,
|
|
) ([]*datapb.CompactionSegment, error) {
|
|
_ = t.tr.RecordSpan()
|
|
|
|
ctx, span := otel.Tracer(typeutil.DataNodeRole).Start(ctx, "MergeSplit")
|
|
defer span.End()
|
|
|
|
log := log.With(zap.Int64("planID", t.GetPlanID()))
|
|
|
|
if err := t.initLOBCompactionContext(ctx); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
segIDAlloc := allocator.NewLocalAllocator(t.plan.GetPreAllocatedSegmentIDs().GetBegin(), t.plan.GetPreAllocatedSegmentIDs().GetEnd())
|
|
logIDAlloc := allocator.NewLocalAllocator(t.plan.GetPreAllocatedLogIDs().GetBegin(), t.plan.GetPreAllocatedLogIDs().GetEnd())
|
|
compAlloc := NewCompactionAllocator(segIDAlloc, logIDAlloc)
|
|
|
|
writerSchema := t.plan.GetSchema()
|
|
|
|
// build writer options
|
|
writerOpts := []storage.RwOption{
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig),
|
|
storage.WithUseLoonFFI(t.compactionParams.UseLoonFFI),
|
|
}
|
|
|
|
// add TEXT column configs for REWRITE_ALL mode
|
|
if t.lobContext != nil && t.lobContext.ShouldRewriteAnyField() {
|
|
// LOB base path at partition level: {root}/insert_log/{coll}/{part}
|
|
lobBasePath := path.Join(t.compactionParams.StorageConfig.GetRootPath(),
|
|
common.SegmentInsertLogPath, metautil.JoinIDPath(t.collectionID, t.partitionID))
|
|
textColumnConfigs := t.lobContext.GetTextColumnConfigs(
|
|
lobBasePath,
|
|
t.compactionParams.TextInlineThreshold,
|
|
t.compactionParams.TextMaxLobFileBytes,
|
|
t.compactionParams.TextFlushThresholdBytes,
|
|
)
|
|
if len(textColumnConfigs) > 0 {
|
|
writerOpts = append(writerOpts, storage.WithTextColumnConfigs(textColumnConfigs))
|
|
log.Info("TEXT column REWRITE_ALL mode enabled",
|
|
zap.Int("rewriteFieldCount", len(textColumnConfigs)),
|
|
)
|
|
}
|
|
}
|
|
|
|
mWriter, err := NewMultiSegmentWriter(ctx,
|
|
t.binlogIO, compAlloc, t.plan.GetMaxSize(), writerSchema,
|
|
t.compactionParams, t.maxRows, t.partitionID, t.collectionID, t.GetChannelName(), 4096,
|
|
writerOpts...,
|
|
)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
deletedRowCount := int64(0)
|
|
expiredRowCount := int64(0)
|
|
|
|
pkField, err := typeutil.GetPrimaryFieldSchema(t.plan.GetSchema())
|
|
if err != nil {
|
|
log.Warn("failed to get pk field from schema")
|
|
return nil, err
|
|
}
|
|
|
|
for _, seg := range t.plan.GetSegmentBinlogs() {
|
|
del, exp, err := t.writeSegment(ctx, seg, mWriter, pkField, writerSchema)
|
|
if err != nil {
|
|
mWriter.Close()
|
|
return nil, err
|
|
}
|
|
deletedRowCount += del
|
|
expiredRowCount += exp
|
|
}
|
|
if err := mWriter.Close(); err != nil {
|
|
log.Warn("compact wrong, failed to finish writer", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
res := mWriter.GetCompactionSegments()
|
|
if len(res) == 0 {
|
|
// append an empty segment
|
|
id, err := segIDAlloc.AllocOne()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
res = append(res, &datapb.CompactionSegment{
|
|
SegmentID: id,
|
|
NumOfRows: 0,
|
|
Channel: t.GetChannelName(),
|
|
})
|
|
}
|
|
|
|
totalElapse := t.tr.RecordSpan()
|
|
log.Info("compact mergeSplit end",
|
|
zap.Int64("deleted row count", deletedRowCount),
|
|
zap.Int64("expired entities", expiredRowCount),
|
|
zap.Duration("total elapse", totalElapse))
|
|
|
|
return res, nil
|
|
}
|
|
|
|
func (t *mixCompactionTask) writeSegment(ctx context.Context,
|
|
seg *datapb.CompactionSegmentBinlogs,
|
|
mWriter *MultiSegmentWriter, pkField *schemapb.FieldSchema,
|
|
writerSchema *schemapb.CollectionSchema,
|
|
) (deletedRowCount, expiredRowCount int64, err error) {
|
|
delta, err := compaction.ComposeDeleteFromDeltalogs(ctx, pkField.DataType, seg,
|
|
storage.WithDownloader(t.binlogIO.Download),
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig))
|
|
if err != nil {
|
|
log.Warn("compact wrong, fail to merge deltalogs", zap.Error(err))
|
|
return
|
|
}
|
|
entityFilter := compaction.NewEntityFilter(delta, t.plan.GetCollectionTtl(), t.currentTime, seg.GetCommitTimestamp())
|
|
|
|
reader, existingFields, err := newCompactionSegmentRecordReader(ctx, seg, t.plan.GetSchema(), t.compactionParams.StorageConfig,
|
|
storage.WithCollectionID(t.collectionID),
|
|
storage.WithDownloader(t.binlogIO.Download),
|
|
storage.WithVersion(seg.GetStorageVersion()),
|
|
storage.WithStorageConfig(t.compactionParams.StorageConfig),
|
|
)
|
|
if err != nil {
|
|
log.Warn("compact wrong, failed to new insert binlogs reader", zap.Error(err))
|
|
return
|
|
}
|
|
defer reader.Close()
|
|
|
|
materializer, err := NewRecordMaterializer(writerSchema, writerSchema.GetFunctions(), existingFields)
|
|
if err != nil {
|
|
log.Warn("compact wrong, failed to init record materializer", zap.Error(err))
|
|
return
|
|
}
|
|
defer materializer.Close()
|
|
|
|
hasTTLField := t.ttlFieldID >= common.StartOfUserFieldID
|
|
var totalRowsRead int64
|
|
|
|
for {
|
|
var r storage.Record
|
|
r, err = reader.Next()
|
|
if err != nil {
|
|
if err == sio.EOF {
|
|
err = nil
|
|
break
|
|
} else {
|
|
log.Warn("compact wrong, failed to iter through data", zap.Error(err))
|
|
return
|
|
}
|
|
}
|
|
|
|
baseRecord := r
|
|
r, err = materializer.Wrap(baseRecord)
|
|
if err != nil {
|
|
baseRecord.Release()
|
|
log.Warn("compact wrong, failed to materialize record", zap.Error(err))
|
|
return
|
|
}
|
|
|
|
totalRowsRead += int64(r.Len())
|
|
|
|
var (
|
|
pkArray = r.Column(pkField.FieldID)
|
|
tsArray = r.Column(common.TimeStampField).(*array.Int64)
|
|
ttlArr *array.Int64
|
|
|
|
sliceStart = -1
|
|
rb *storage.RecordBuilder
|
|
)
|
|
|
|
if hasTTLField {
|
|
ttlArr = r.Column(t.ttlFieldID).(*array.Int64)
|
|
}
|
|
|
|
for i := range r.Len() {
|
|
// Filtering deleted entities
|
|
var pk any
|
|
switch pkField.DataType {
|
|
case schemapb.DataType_Int64:
|
|
pk = pkArray.(*array.Int64).Value(i)
|
|
case schemapb.DataType_VarChar:
|
|
pk = pkArray.(*array.String).Value(i)
|
|
default:
|
|
panic("invalid data type")
|
|
}
|
|
ts := typeutil.Timestamp(tsArray.Value(i))
|
|
expireTs := int64(-1)
|
|
if hasTTLField {
|
|
if ttlArr.IsValid(i) {
|
|
expireTs = ttlArr.Value(i)
|
|
}
|
|
}
|
|
if entityFilter.Filtered(pk, ts, expireTs) {
|
|
if rb == nil {
|
|
rb = storage.NewRecordBuilder(writerSchema)
|
|
}
|
|
if sliceStart != -1 {
|
|
rb.Append(r, sliceStart, i)
|
|
}
|
|
sliceStart = -1
|
|
continue
|
|
}
|
|
|
|
if sliceStart == -1 {
|
|
sliceStart = i
|
|
}
|
|
}
|
|
|
|
if rb != nil {
|
|
if sliceStart != -1 {
|
|
rb.Append(r, sliceStart, r.Len())
|
|
}
|
|
if rb.GetRowNum() > 0 {
|
|
err := func() error {
|
|
rec := rb.Build()
|
|
defer rec.Release()
|
|
out := overwriteRecordTimestamps(rec, seg.GetCommitTimestamp())
|
|
if out != rec {
|
|
defer out.Release()
|
|
}
|
|
return mWriter.Write(out)
|
|
}()
|
|
if err != nil {
|
|
releaseWrappedRecord(r, baseRecord)
|
|
return 0, 0, err
|
|
}
|
|
}
|
|
} else {
|
|
out := overwriteRecordTimestamps(r, seg.GetCommitTimestamp())
|
|
err := mWriter.Write(out)
|
|
if out != r {
|
|
out.Release()
|
|
}
|
|
if err != nil {
|
|
releaseWrappedRecord(r, baseRecord)
|
|
return 0, 0, err
|
|
}
|
|
}
|
|
releaseWrappedRecord(r, baseRecord)
|
|
}
|
|
|
|
deltalogDeleteEntriesCount := len(delta)
|
|
deletedRowCount = int64(entityFilter.GetDeletedCount())
|
|
expiredRowCount = int64(entityFilter.GetExpiredCount())
|
|
|
|
// track segment row statistics for LOB compaction in REUSE_ALL mode
|
|
// this is used to update LOB file valid_rows based on per-segment deletion ratio
|
|
if t.lobContext != nil && t.lobContext.HasReuseAllFields() {
|
|
totalDeleted := deletedRowCount + expiredRowCount
|
|
t.lobContext.SetSegmentRowStats(seg.GetSegmentID(), totalRowsRead, totalDeleted)
|
|
}
|
|
|
|
metrics.DataNodeCompactionDeleteCount.WithLabelValues(fmt.Sprint(t.collectionID)).Add(float64(deltalogDeleteEntriesCount))
|
|
metrics.DataNodeCompactionMissingDeleteCount.WithLabelValues(fmt.Sprint(t.collectionID)).Add(float64(entityFilter.GetMissingDeleteCount()))
|
|
|
|
return
|
|
}
|
|
|
|
func (t *mixCompactionTask) Compact() (*datapb.CompactionPlanResult, error) {
|
|
durInQueue := t.tr.RecordSpan()
|
|
ctx, span := otel.Tracer(typeutil.DataNodeRole).Start(t.ctx, fmt.Sprintf("MixCompact-%d", t.GetPlanID()))
|
|
defer span.End()
|
|
compactStart := time.Now()
|
|
|
|
log.Info("compact start", zap.Any("compactionParams", t.compactionParams),
|
|
zap.Any("plan", t.plan))
|
|
|
|
if err := t.preCompact(); err != nil {
|
|
log.Warn("compact wrong, failed to preCompact", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
|
|
log := log.Ctx(ctx).With(zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64("collectionID", t.collectionID),
|
|
zap.Int64("partitionID", t.partitionID))
|
|
|
|
ctxTimeout, cancelAll := context.WithCancel(ctx)
|
|
defer cancelAll()
|
|
|
|
log.Info("compact start")
|
|
// Decompress compaction binlogs first
|
|
if err := binlog.DecompressCompactionBinlogsWithRootPath(t.compactionParams.StorageConfig.GetRootPath(), t.plan.SegmentBinlogs); err != nil {
|
|
log.Warn("compact wrong, fail to decompress compaction binlogs", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
// Unable to deal with all empty segments cases, so return error
|
|
isEmpty := lo.EveryBy(lo.FlatMap(t.plan.GetSegmentBinlogs(), func(seg *datapb.CompactionSegmentBinlogs, _ int) []*datapb.FieldBinlog {
|
|
return seg.GetFieldBinlogs()
|
|
}), func(field *datapb.FieldBinlog) bool {
|
|
return len(field.GetBinlogs()) == 0
|
|
})
|
|
|
|
if isEmpty {
|
|
log.Warn("compact wrong, all segments' binlogs are empty")
|
|
return nil, merr.WrapErrServiceInternalMsg("illegal compaction plan")
|
|
}
|
|
|
|
sortMergeAppicable := t.compactionParams.UseMergeSort
|
|
if sortMergeAppicable {
|
|
for _, segment := range t.plan.GetSegmentBinlogs() {
|
|
if !segment.GetIsSorted() && !segment.GetIsSortedByNamespace() {
|
|
sortMergeAppicable = false
|
|
break
|
|
}
|
|
}
|
|
|
|
if len(t.plan.GetSegmentBinlogs()) > t.compactionParams.MaxSegmentMergeSort {
|
|
// sort merge is not applicable if there is only one segment or too many segments
|
|
sortMergeAppicable = false
|
|
}
|
|
}
|
|
|
|
var res []*datapb.CompactionSegment
|
|
var err error
|
|
if sortMergeAppicable {
|
|
log.Info("compact by merge sort")
|
|
res, err = mergeSortMultipleSegments(ctxTimeout, t.plan, t.collectionID, t.partitionID, t.maxRows, t.binlogIO,
|
|
t.plan.GetSegmentBinlogs(), t.tr, t.currentTime, t.plan.GetCollectionTtl(), t.compactionParams, t.sortByFieldIDs)
|
|
if err != nil {
|
|
log.Warn("compact wrong, fail to merge sort segments", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
} else {
|
|
res, err = t.mergeSplit(ctxTimeout)
|
|
if err != nil {
|
|
log.Warn("compact wrong, failed to mergeSplit", zap.Error(err))
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
log.Info("compact done", zap.Duration("compact elapse", time.Since(compactStart)), zap.Any("res", res))
|
|
|
|
metrics.DataNodeCompactionLatency.WithLabelValues(paramtable.GetStringNodeID(), t.plan.GetType().String()).Observe(float64(t.tr.ElapseSpan().Milliseconds()))
|
|
metrics.DataNodeCompactionLatencyInQueue.WithLabelValues(paramtable.GetStringNodeID()).Observe(float64(durInQueue.Milliseconds()))
|
|
|
|
// apply LOB compaction for TEXT columns (REUSE_ALL mode)
|
|
if err := t.applyLOBCompaction(ctx, res); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
planResult := &datapb.CompactionPlanResult{
|
|
State: datapb.CompactionTaskState_completed,
|
|
PlanID: t.GetPlanID(),
|
|
Channel: t.GetChannelName(),
|
|
Segments: res,
|
|
Type: t.plan.GetType(),
|
|
}
|
|
return planResult, nil
|
|
}
|
|
|
|
func (t *mixCompactionTask) Complete() {
|
|
t.done <- struct{}{}
|
|
}
|
|
|
|
func (t *mixCompactionTask) Stop() {
|
|
t.cancel()
|
|
<-t.done
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetPlanID() typeutil.UniqueID {
|
|
return t.plan.GetPlanID()
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetChannelName() string {
|
|
return t.plan.GetChannel()
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetCompactionType() datapb.CompactionType {
|
|
return t.plan.GetType()
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetCollection() typeutil.UniqueID {
|
|
return t.plan.GetSegmentBinlogs()[0].GetCollectionID()
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetSlotUsage() int64 {
|
|
return t.plan.GetSlotUsage()
|
|
}
|
|
|
|
func (t *mixCompactionTask) GetStorageConfig() *indexpb.StorageConfig {
|
|
return t.compactionParams.StorageConfig
|
|
}
|
|
|
|
func GetBM25FieldIDs(coll *schemapb.CollectionSchema) []int64 {
|
|
return lo.FilterMap(coll.GetFunctions(), func(function *schemapb.FunctionSchema, _ int) (int64, bool) {
|
|
if function.GetType() == schemapb.FunctionType_BM25 {
|
|
return function.GetOutputFieldIds()[0], true
|
|
}
|
|
return 0, false
|
|
})
|
|
}
|
|
|
|
// applyLOBCompaction handles TEXT column LOB file merging for REUSE_ALL strategy.
|
|
// this is called after compaction completes to update output manifests with merged LOB file references.
|
|
// it uses t.lobContext which was initialized by initLOBCompactionContext before compaction.
|
|
//
|
|
// This function handles two scenarios:
|
|
// - REUSE_ALL: all TEXT fields reuse existing LOB files, merge LOB file references
|
|
// - REWRITE_ALL: all TEXT fields are rewritten, LOB files handled by segment writer
|
|
//
|
|
// NOTE: SetSegmentRowStats() must be called during compaction iteration to track deleted rows per segment.
|
|
func (t *mixCompactionTask) applyLOBCompaction(ctx context.Context, outputSegments []*datapb.CompactionSegment) error {
|
|
if t.lobContext == nil {
|
|
return nil
|
|
}
|
|
|
|
log := log.Ctx(ctx).With(zap.Int64("planID", t.GetPlanID()))
|
|
|
|
if !t.lobContext.HasReuseAllFields() {
|
|
log.Info("all TEXT fields use REWRITE_ALL, no LOB file merging needed")
|
|
return nil
|
|
}
|
|
|
|
// merge LOB file references for REUSE_ALL fields to output manifests
|
|
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
|
|
}
|
|
|
|
// update output segments with new manifest paths (version changed after LOB commit)
|
|
for _, seg := range outputSegments {
|
|
if newManifest, ok := updatedManifests[seg.GetSegmentID()]; ok {
|
|
seg.Manifest = newManifest
|
|
}
|
|
}
|
|
|
|
reuseAllFieldIDs := t.lobContext.GetReuseAllFieldIDs()
|
|
rewriteAllFieldIDs := t.lobContext.GetRewriteAllFieldIDs()
|
|
log.Info("LOB file references merged to output manifests",
|
|
zap.Int("outputSegmentCount", len(outputManifests)),
|
|
zap.Int64s("reuseAllFieldIDs", reuseAllFieldIDs),
|
|
zap.Int64s("rewriteAllFieldIDs", rewriteAllFieldIDs),
|
|
zap.Any("updatedManifests", updatedManifests),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
// initLOBCompactionContext initializes the LOB compaction context for TEXT columns.
|
|
// this is called before compaction starts to determine REUSE_ALL vs REWRITE_ALL strategy.
|
|
func (t *mixCompactionTask) 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)
|
|
hasManifest := false
|
|
for _, seg := range t.plan.GetSegmentBinlogs() {
|
|
if seg.GetManifest() != "" {
|
|
hasManifest = true
|
|
break
|
|
}
|
|
}
|
|
if !hasManifest {
|
|
return nil // no manifest-based segments, nothing to do
|
|
}
|
|
|
|
log := log.Ctx(ctx).With(
|
|
zap.Int64("planID", t.GetPlanID()),
|
|
zap.Int64s("textFieldIDs", textFieldIDs),
|
|
)
|
|
log.Info("initializing LOB compaction context for TEXT columns")
|
|
|
|
// collect source segment manifests
|
|
sourceManifests := make(map[int64]string)
|
|
for _, seg := range t.plan.GetSegmentBinlogs() {
|
|
if seg.GetManifest() != "" {
|
|
sourceManifests[seg.GetSegmentID()] = seg.GetManifest()
|
|
}
|
|
}
|
|
|
|
// collect LOB files from source manifests
|
|
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 segments")
|
|
return nil
|
|
}
|
|
|
|
// create LOB compaction context and compute strategies
|
|
t.lobContext = compaction.NewLOBCompactionContext()
|
|
for segID, files := range lobFilesBySegment {
|
|
t.lobContext.AddSegmentLobFiles(segID, files)
|
|
}
|
|
|
|
// set compaction type to check for forced strategy
|
|
// for mix compaction:
|
|
// - if 1 segment splits into N segments: force REWRITE_ALL
|
|
// - otherwise: compute strategy based on hole ratio
|
|
sourceSegmentCount := len(t.plan.GetSegmentBinlogs())
|
|
targetSegmentCount := int(t.estimatedOutputSegmentCount)
|
|
t.lobContext.SetCompactionType(datapb.CompactionType_MixCompaction, sourceSegmentCount, targetSegmentCount)
|
|
|
|
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", func() string {
|
|
if decision.Strategy == compaction.LOBStrategyReuseAll {
|
|
return "REUSE_ALL"
|
|
}
|
|
return "REWRITE_ALL"
|
|
}()),
|
|
zap.Bool("isForced", t.lobContext.IsForced),
|
|
zap.Int("sourceSegmentCount", sourceSegmentCount),
|
|
zap.Int("targetSegmentCount", targetSegmentCount),
|
|
zap.Float64("holeRatio", decision.OverallHoleRatio),
|
|
zap.Int64("validRows", decision.TotalValidRows),
|
|
zap.Int64("totalRows", decision.TotalRows),
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|