expireddeletion

Documentation

Overview

Package expireddeletion contains the functions needed to run expired segment deletion

The expireddeletion.expiredDeleter implements the metainfo loop Observer interface allowing us to subscribe to the loop to get information for every segment in the metainfo database.

The expireddeletion chore will subscribe the deleter to the metainfo loop and delete any expired segments from metainfo.

Index

• Variables
• type Chore
  • func NewChore(log *zap.Logger, config Config, metabase metainfo.MetabaseDB) *Chore
  • func (chore *Chore) Close() error
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) SetNow(nowFn func() time.Time)
• type Config

Variables

var (
	// Error defines the expireddeletion chore errors class.
	Error = errs.Class("expired deletion")
)

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore implements the expired segment cleanup chore.

architecture: Chore

func NewChore

func NewChore(log *zap.Logger, config Config, metabase metainfo.MetabaseDB) *Chore

NewChore creates a new instance of the expireddeletion chore.

func (*Chore) Close

func (chore *Chore) Close() error

Close stops the expireddeletion chore.

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run starts the expireddeletion loop service.

func (*Chore) SetNow

func (chore *Chore) SetNow(nowFn func() time.Time)

SetNow allows tests to have the server act as if the current time is whatever they want.

type Config

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"`
}

Config contains configurable values for expired segment cleanup.