pruner

Documentation

Index

• func Manifold(config ManifoldConfig) dependency.Manifold
• type Config
  • func (c *Config) Validate() error
• type Facade
• type Logger
• type ManifoldConfig
  • func (config ManifoldConfig) Validate() error
• type PrunerWorker
  • func New(conf Config) PrunerWorker
  • func (w *PrunerWorker) Catacomb() *catacomb.Catacomb
  • func (w *PrunerWorker) Config() *Config
  • func (w *PrunerWorker) Kill()
  • func (w *PrunerWorker) Wait() error
  • func (w *PrunerWorker) Work(getPrunerConfig func(*config.Config) (time.Duration, uint)) error

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a Manifold that encapsulates the statushistorypruner worker.

Types

type Config

type Config struct {
	Facade        Facade
	PruneInterval time.Duration
	Clock         clock.Clock
	Logger        Logger
}

Config holds all necessary attributes to start a pruner worker.

func (*Config) Validate

func (c *Config) Validate() error

Validate will err unless basic requirements for a valid config are met.

type Facade

type Facade interface {
	Prune(time.Duration, int) error
	WatchForModelConfigChanges() (watcher.NotifyWatcher, error)
	ModelConfig() (*config.Config, error)
}

Facade represents an API that implements status history pruning.

type Logger

type Logger interface {
	Infof(string, ...interface{})
}

Logger defines the methods used by the pruner worker for logging.

type ManifoldConfig

type ManifoldConfig struct {
	APICallerName string
	Clock         clock.Clock
	PruneInterval time.Duration
	NewWorker     func(Config) (worker.Worker, error)
	NewClient     func(base.APICaller) Facade
	Logger        Logger
}

ManifoldConfig describes the resources and configuration on which the statushistorypruner worker depends.

func (ManifoldConfig) Validate

func (config ManifoldConfig) Validate() error

Validate is called by start to check for bad configuration.

type PrunerWorker

type PrunerWorker struct {
	// contains filtered or unexported fields
}

PrunerWorker prunes status history or action records at regular intervals.

func New

func New(conf Config) PrunerWorker

New returns a worker.Worker for history Pruner.

func (*PrunerWorker) Catacomb

func (w *PrunerWorker) Catacomb() *catacomb.Catacomb

Catacomb returns the prune worker's catacomb.

func (*PrunerWorker) Config

func (w *PrunerWorker) Config() *Config

Config return the prune worker's config.

func (*PrunerWorker) Kill

func (w *PrunerWorker) Kill()

Kill is defined on worker.Worker.

func (*PrunerWorker) Wait

func (w *PrunerWorker) Wait() error

Wait is defined on worker.Worker.

func (*PrunerWorker) Work

func (w *PrunerWorker) Work(getPrunerConfig func(*config.Config) (time.Duration, uint)) error

Work is the main body of generic pruner loop.