961e841bd7
errs.Class should not contain "error" in the name, since that causes a
lot of stutter in the error logs. As an example a log line could end up
looking like:
ERROR node stats service error: satellitedbs error: node stats database error: no rows
Whereas something like:
ERROR nodestats service: satellitedbs: nodestatsdb: no rows
Would contain all the necessary information without the stutter.
Change-Id: I7b7cb7e592ebab4bcfadc1eef11122584d2b20e0
94 lines
2.4 KiB
Go
94 lines
2.4 KiB
Go
// Copyright (C) 2020 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package expireddeletion
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/spacemonkeygo/monkit/v3"
|
|
"github.com/zeebo/errs"
|
|
"go.uber.org/zap"
|
|
|
|
"storj.io/common/sync2"
|
|
"storj.io/storj/satellite/metabase"
|
|
"storj.io/storj/satellite/metainfo"
|
|
)
|
|
|
|
var (
|
|
// Error defines the expireddeletion chore errors class.
|
|
Error = errs.Class("expired deletion")
|
|
mon = monkit.Package()
|
|
)
|
|
|
|
// Config contains configurable values for expired segment cleanup.
|
|
type Config struct {
|
|
Interval time.Duration `help:"the time between each attempt to go through the db and clean up expired segments" releaseDefault:"24h" devDefault:"10s"`
|
|
Enabled bool `help:"set if expired segment cleanup is enabled or not" releaseDefault:"true" devDefault:"true"`
|
|
ListLimit int `help:"how many expired objects to query in a batch" default:"100"`
|
|
}
|
|
|
|
// Chore implements the expired segment cleanup chore.
|
|
//
|
|
// architecture: Chore
|
|
type Chore struct {
|
|
log *zap.Logger
|
|
config Config
|
|
metabase metainfo.MetabaseDB
|
|
|
|
nowFn func() time.Time
|
|
Loop *sync2.Cycle
|
|
}
|
|
|
|
// NewChore creates a new instance of the expireddeletion chore.
|
|
func NewChore(log *zap.Logger, config Config, metabase metainfo.MetabaseDB) *Chore {
|
|
return &Chore{
|
|
log: log,
|
|
config: config,
|
|
metabase: metabase,
|
|
|
|
nowFn: time.Now,
|
|
Loop: sync2.NewCycle(config.Interval),
|
|
}
|
|
}
|
|
|
|
// Run starts the expireddeletion loop service.
|
|
func (chore *Chore) Run(ctx context.Context) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
|
|
if !chore.config.Enabled {
|
|
return nil
|
|
}
|
|
|
|
return chore.Loop.Run(ctx, chore.deleteExpiredObjects)
|
|
}
|
|
|
|
// Close stops the expireddeletion chore.
|
|
func (chore *Chore) Close() error {
|
|
chore.Loop.Close()
|
|
return nil
|
|
}
|
|
|
|
// SetNow allows tests to have the server act as if the current time is whatever they want.
|
|
func (chore *Chore) SetNow(nowFn func() time.Time) {
|
|
chore.nowFn = nowFn
|
|
}
|
|
|
|
func (chore *Chore) deleteExpiredObjects(ctx context.Context) (err error) {
|
|
defer mon.Task()(&ctx)(&err)
|
|
chore.log.Debug("deleting expired objects")
|
|
|
|
// TODO log error instead of crashing core until we will be sure
|
|
// that queries for deleting expired objects are stable
|
|
err = chore.metabase.DeleteExpiredObjects(ctx, metabase.DeleteExpiredObjects{
|
|
ExpiredBefore: chore.nowFn(),
|
|
BatchSize: chore.config.ListLimit,
|
|
})
|
|
if err != nil {
|
|
chore.log.Error("deleting expired objects failed", zap.Error(err))
|
|
}
|
|
|
|
return nil
|
|
}
|