API endpoints for the series deletion API using block storage #4370
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,325 @@ | ||
| package purger | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/md5" | ||
| "encoding/hex" | ||
| "encoding/json" | ||
| fmt "fmt" | ||
| "net/http" | ||
| "sort" | ||
| "strconv" | ||
| strings "strings" | ||
| "time" | ||
|
|
||
| "github.com/go-kit/kit/log" | ||
| "github.com/go-kit/kit/log/level" | ||
| "github.com/oklog/ulid" | ||
| "github.com/pkg/errors" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/prometheus/common/model" | ||
| "github.com/prometheus/prometheus/promql/parser" | ||
| "github.com/thanos-io/thanos/pkg/objstore" | ||
|
|
||
| "github.com/cortexproject/cortex/pkg/storage/bucket" | ||
| cortex_tsdb "github.com/cortexproject/cortex/pkg/storage/tsdb" | ||
| "github.com/cortexproject/cortex/pkg/tenant" | ||
| "github.com/cortexproject/cortex/pkg/util" | ||
| util_log "github.com/cortexproject/cortex/pkg/util/log" | ||
| ) | ||
|
|
||
| type BlocksPurgerAPI struct { | ||
| bucketClient objstore.Bucket | ||
| logger log.Logger | ||
| cfgProvider bucket.TenantConfigProvider | ||
| deleteRequestCancelPeriod time.Duration | ||
| } | ||
|
|
||
| func NewBlocksPurgerAPI(storageCfg cortex_tsdb.BlocksStorageConfig, cfgProvider bucket.TenantConfigProvider, logger log.Logger, reg prometheus.Registerer, cancellationPeriod time.Duration) (*BlocksPurgerAPI, error) { | ||
| bucketClient, err := createBucketClient(storageCfg, logger, reg) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return newBlocksPurgerAPI(bucketClient, cfgProvider, logger, cancellationPeriod), nil | ||
| } | ||
|
|
||
| func newBlocksPurgerAPI(bkt objstore.Bucket, cfgProvider bucket.TenantConfigProvider, logger log.Logger, cancellationPeriod time.Duration) *BlocksPurgerAPI { | ||
| return &BlocksPurgerAPI{ | ||
| bucketClient: bkt, | ||
| cfgProvider: cfgProvider, | ||
| logger: logger, | ||
| deleteRequestCancelPeriod: cancellationPeriod, | ||
| } | ||
| } | ||
|
|
||
| func createBucketClient(cfg cortex_tsdb.BlocksStorageConfig, logger log.Logger, reg prometheus.Registerer) (objstore.Bucket, error) { | ||
| bucketClient, err := bucket.NewClient(context.Background(), cfg.Bucket, "purger", logger, reg) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "create bucket client") | ||
| } | ||
|
|
||
| return bucketClient, nil | ||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) AddDeleteRequestHandler(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| userID, err := tenant.TenantID(ctx) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusUnauthorized) | ||
| return | ||
| } | ||
|
|
||
| params := r.URL.Query() | ||
| match := params["match[]"] | ||
| if len(match) == 0 { | ||
| http.Error(w, "selectors not set", http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| for i := range match { | ||
| _, err := parser.ParseMetricSelector(match[i]) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusBadRequest) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| startParam := params.Get("start") | ||
| startTime := int64(0) | ||
| if startParam != "" { | ||
| startTime, err = util.ParseTime(startParam) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusBadRequest) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| endParam := params.Get("end") | ||
| endTime := int64(model.Now()) | ||
|
|
||
| if endParam != "" { | ||
| endTime, err = util.ParseTime(endParam) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| if endTime > int64(model.Now()) { | ||
| http.Error(w, "deletes in future not allowed", http.StatusBadRequest) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| if startTime > endTime { | ||
| http.Error(w, "start time can't be greater than end time", http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| requestID := getTombstoneRequestID(startTime, endTime, match) | ||
|
|
||
| // Since the request id is based on a hash of the parameters, there is a possibility that a tombstone could already exist for it | ||
| // if the request was previously cancelled, we need to remove the cancelled tombstone before adding the pending one | ||
| if err := cortex_tsdb.RemoveCancelledStateIfExists(ctx, api.bucketClient, userID, api.cfgProvider, requestID); err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "removing cancelled tombstone state if it exists", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| prevT, err := cortex_tsdb.GetDeleteRequestByIDForUser(ctx, api.bucketClient, api.cfgProvider, userID, requestID) | ||
| if err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error getting delete request by id", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
| if prevT != nil { | ||
| http.Error(w, "delete request tombstone with same information already exists", http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| curTime := time.Now().Unix() * 1000 | ||
| t := cortex_tsdb.NewTombstone(userID, curTime, curTime, startTime, endTime, match, requestID, cortex_tsdb.StatePending) | ||
|
|
||
| if err = cortex_tsdb.WriteTombstoneFile(ctx, api.bucketClient, userID, api.cfgProvider, t); err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error adding delete request to the object store", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| w.WriteHeader(http.StatusNoContent) | ||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) GetAllDeleteRequestsHandler(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| userID, err := tenant.TenantID(ctx) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusUnauthorized) | ||
| return | ||
| } | ||
|
Comment on lines
+140
to
+144
There was a problem hiding this comment. Pretty common code, I think existing Cortex code uses |
||
|
|
||
| deleteRequests, err := cortex_tsdb.GetAllDeleteRequestsForUser(ctx, api.bucketClient, api.cfgProvider, userID) | ||
| if err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error getting delete requests from the block store", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| if err := json.NewEncoder(w).Encode(deleteRequests); err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error marshalling response", "err", err) | ||
| http.Error(w, fmt.Sprintf("Error marshalling response: %v", err), http.StatusInternalServerError) | ||
| } | ||
|
|
||
| w.WriteHeader(http.StatusOK) | ||
|
There was a problem hiding this comment. According to https://pkg.go.dev/net/http#ResponseWriter since you called However, I think we should set the content type and the status header ourselves for clarity. Also, I think the if block on line 155 is missing a return statement right? I would expect There was a problem hiding this comment. Makes sense, should be fixed now. |
||
|
|
||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) CancelDeleteRequestHandler(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| userID, err := tenant.TenantID(ctx) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusUnauthorized) | ||
| return | ||
| } | ||
|
|
||
| params := r.URL.Query() | ||
| requestID := params.Get("request_id") | ||
|
There was a problem hiding this comment. Shouldn't we do input validation here? What if |
||
|
|
||
| deleteRequest, err := cortex_tsdb.GetDeleteRequestByIDForUser(ctx, api.bucketClient, api.cfgProvider, userID, requestID) | ||
| if err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error getting delete request from the object store", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| if deleteRequest == nil { | ||
| http.Error(w, "could not find delete request with given id", http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| if deleteRequest.State == cortex_tsdb.StateCancelled { | ||
| http.Error(w, "the request has already been previously deleted", http.StatusBadRequest) | ||
|
There was a problem hiding this comment. In this case, shouldn't we return 202? Because it's already in cancelled state, which is what this API should do right? By the way, in our error messages to the user, we gotta use "cancel" and "delete" carefully. I think Here you actually mean "the series deletion request was cancelled previously" not "the series has already been deleted" right? There was a problem hiding this comment. Good point, thanks. |
||
| return | ||
| } | ||
|
|
||
| if deleteRequest.State == cortex_tsdb.StateProcessed { | ||
|
There was a problem hiding this comment. Do we need a "processing" state? Or we can rely on the There was a problem hiding this comment. Yes, we can use the |
||
| http.Error(w, "deletion of request which is already processed is not allowed", http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| currentTime := int64(time.Now().Unix() * 1000) | ||
| timeElapsed := float64(currentTime - deleteRequest.RequestCreatedAt) | ||
|
|
||
| if timeElapsed > float64(api.deleteRequestCancelPeriod.Milliseconds()) { | ||
| http.Error(w, fmt.Sprintf("deletion of request past the deadline of %s since its creation is not allowed", api.deleteRequestCancelPeriod.String()), http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| // create file with the cancelled state | ||
| _, err = cortex_tsdb.UpdateTombstoneState(ctx, api.bucketClient, api.cfgProvider, deleteRequest, cortex_tsdb.StateCancelled) | ||
| if err != nil { | ||
| level.Error(util_log.Logger).Log("msg", "error cancelling the delete request", "err", err) | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| w.WriteHeader(http.StatusNoContent) | ||
| } | ||
|
|
||
| // Calculates the tombstone file name based on a hash of the start time, end time and selectors | ||
| func getTombstoneRequestID(startTime int64, endTime int64, selectors []string) string { | ||
ilangofman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // First make a string of the tombstone info | ||
| var b strings.Builder | ||
| b.WriteString(strconv.FormatInt(startTime, 10)) | ||
| b.WriteString(",") | ||
| b.WriteString(strconv.FormatInt(endTime, 10)) | ||
|
|
||
| sort.Strings(selectors) | ||
|
There was a problem hiding this comment. Is hashing matchers the right way to create a "deletion ID"? For example I can have matcher like Is this intended that create deletion request de-duplication is a best effort? There was a problem hiding this comment. I've updated it so it parses the matchers and then create the hash based on the parsed matchers. So any logically equivalent deletion requests should now result in the same hash. The example you provided should be the same hash. Also split up matchers like |
||
| for _, s := range selectors { | ||
| b.WriteString(",") | ||
| b.WriteString(s) | ||
| } | ||
ilangofman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return getTombstoneHash(b.String()) | ||
| } | ||
|
|
||
| func getTombstoneHash(s string) string { | ||
| data := []byte(s) | ||
| md5Bytes := md5.Sum(data) | ||
| return hex.EncodeToString(md5Bytes[:]) | ||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) DeleteTenant(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| userID, err := tenant.TenantID(ctx) | ||
| if err != nil { | ||
| // When Cortex is running, it uses Auth Middleware for checking X-Scope-OrgID and injecting tenant into context. | ||
| // Auth Middleware sends http.StatusUnauthorized if X-Scope-OrgID is missing, so we do too here, for consistency. | ||
| http.Error(w, err.Error(), http.StatusUnauthorized) | ||
| return | ||
| } | ||
|
|
||
| err = cortex_tsdb.WriteTenantDeletionMark(r.Context(), api.bucketClient, userID, api.cfgProvider, cortex_tsdb.NewTenantDeletionMark(time.Now())) | ||
| if err != nil { | ||
| level.Error(api.logger).Log("msg", "failed to write tenant deletion mark", "user", userID, "err", err) | ||
|
|
||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| level.Info(api.logger).Log("msg", "tenant deletion mark in blocks storage created", "user", userID) | ||
|
|
||
| w.WriteHeader(http.StatusOK) | ||
| } | ||
|
|
||
| type DeleteTenantStatusResponse struct { | ||
| TenantID string `json:"tenant_id"` | ||
| BlocksDeleted bool `json:"blocks_deleted"` | ||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) DeleteTenantStatus(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| userID, err := tenant.TenantID(ctx) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusBadRequest) | ||
| return | ||
| } | ||
|
|
||
| result := DeleteTenantStatusResponse{} | ||
| result.TenantID = userID | ||
| result.BlocksDeleted, err = api.isBlocksForUserDeleted(ctx, userID) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| util.WriteJSONResponse(w, result) | ||
| } | ||
|
|
||
| func (api *BlocksPurgerAPI) isBlocksForUserDeleted(ctx context.Context, userID string) (bool, error) { | ||
| var errBlockFound = errors.New("block found") | ||
|
|
||
| userBucket := bucket.NewUserBucketClient(userID, api.bucketClient, api.cfgProvider) | ||
| err := userBucket.Iter(ctx, "", func(s string) error { | ||
| s = strings.TrimSuffix(s, "/") | ||
|
|
||
| _, err := ulid.Parse(s) | ||
| if err != nil { | ||
| // not block, keep looking | ||
| return nil | ||
| } | ||
|
|
||
| // Used as shortcut to stop iteration. | ||
| return errBlockFound | ||
| }) | ||
|
|
||
| if errors.Is(err, errBlockFound) { | ||
| return false, nil | ||
| } | ||
|
|
||
| if err != nil { | ||
| return false, err | ||
| } | ||
|
|
||
| // No blocks found, all good. | ||
| return true, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we will need to be careful to just propagate error back to caller; we might inadvertently expose some detail that should not be exposed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it to a message instead of propagating the error.