Files
44335ad442 MM-68378: Fix empty error fields and spurious failures for OS/ES bulk deletes (#36264) (#36285)
* omit error_* fields if empty, add status code

* MM-68378: Add tests for 404-delete semantics in ES/OS indexing jobs

* MM-68378: Fix empty error fields and spurious failures for OS/ES bulk deletes

- Log resp.Status unconditionally in OnFailure so status-only failures
  (resp.Error nil, err nil) are always identifiable
- Downgrade per-item OnFailure log from Error to Warn; the job-level
  Error log already captures the aggregate failure
- Track real failures in a separate atomic counter shared between the
  OnFailure callback and the close closure; 404 deletes (document not
  found) are silently skipped and not counted
- Report num_failed from the real counter in close stats; retain
  stats_num_failed as the raw SDK count for reference

(cherry picked from commit 6a4781061c)

Co-authored-by: Jesse Hallam <[email protected]>
2026-04-27 13:00:53 -03:00

115 lines
3.7 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.enterprise for license information.
package opensearch
import (
"context"
"io"
"net/http"
"sync/atomic"
"time"
"github.com/mattermost/mattermost/server/v8/enterprise/elasticsearch/common"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchutil"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/shared/mlog"
"github.com/mattermost/mattermost/server/v8/channels/app"
)
type OpensearchIndexerInterfaceImpl struct {
Server *app.Server
bulkProcessor opensearchutil.BulkIndexer
}
func (esi *OpensearchIndexerInterfaceImpl) MakeWorker() model.Worker {
const workerName = "EnterpriseOpensearchIndexer"
// Initializing logger
logger := esi.Server.Jobs.Logger().With(mlog.String("worker_name", workerName))
// Creating the client
client, appErr := createClient(logger, esi.Server.Jobs.Config(), esi.Server.Platform().FileBackend(), true)
if appErr != nil {
logger.Error("Worker: Failed to Create Client", mlog.Err(appErr))
return nil
}
var realFailed atomic.Int64
return common.NewIndexerWorker(workerName, model.ElasticsearchSettingsOSBackend,
esi.Server.Jobs,
logger,
esi.Server.Platform().FileBackend(),
esi.Server.License,
func() error {
// Creating the bulk indexer from the client.
biCfg := opensearchutil.BulkIndexerConfig{
Client: client,
OnError: func(_ context.Context, err error) {
logger.Error("Error from opensearch bulk indexer", mlog.Err(err))
},
Timeout: time.Duration(*esi.Server.Jobs.Config().ElasticsearchSettings.RequestTimeoutSeconds) * time.Second,
NumWorkers: common.NumIndexWorkers(),
}
if *esi.Server.Jobs.Config().ElasticsearchSettings.Trace == "all" {
biCfg.DebugLogger = common.NewBulkIndexerLogger(logger, workerName)
}
var err error
esi.bulkProcessor, err = opensearchutil.NewBulkIndexer(biCfg)
return err
},
// Function to add an item in the bulk processor
func(indexName, indexOp, docID string, body io.ReadSeeker) error {
return esi.bulkProcessor.Add(context.Background(), opensearchutil.BulkIndexerItem{
Index: indexName,
Action: indexOp,
DocumentID: docID,
Body: body,
OnFailure: func(_ context.Context, item opensearchutil.BulkIndexerItem, resp opensearchapi.BulkRespItem, err error) {
if item.Action == "delete" && resp.Status == http.StatusNotFound {
return
}
realFailed.Add(1)
fields := []mlog.Field{
mlog.String("index", item.Index),
mlog.String("doc_id", item.DocumentID),
mlog.String("action", item.Action),
mlog.Int("status", resp.Status),
}
if resp.Error != nil {
fields = append(fields,
mlog.String("error_type", resp.Error.Type),
mlog.String("error_reason", resp.Error.Reason),
)
}
if err != nil {
fields = append(fields, mlog.Err(err))
}
logger.Warn("Bulk indexer: failed to index document", fields...)
},
})
},
// Closing the bulk processor and returning the number of failed items.
func() (int64, error) {
err := esi.bulkProcessor.Close(context.Background())
stats := esi.bulkProcessor.Stats()
fields := []mlog.Field{
mlog.Uint("num_indexed", stats.NumIndexed),
mlog.Int("num_failed", realFailed.Load()),
mlog.Uint("stats_num_failed", stats.NumFailed),
mlog.Uint("num_added", stats.NumAdded),
mlog.Uint("num_flushed", stats.NumFlushed),
}
if err != nil {
logger.Warn("Bulk indexer closed with error", append(fields, mlog.Err(err))...)
} else {
logger.Info("Bulk indexer closed", fields...)
}
return realFailed.Load(), err
})
}