batchDeleter

Documentation

Overview

package batchDeleter provides a wrapper around the db.Pruner to provide a way to get expired records at a given interval and delete them at a separate given interval.

Index

• Constants
• func Metrics() []xmetrics.Metric
• type BatchDeleter
  • func NewBatchDeleter(config Config, logger log.Logger, metricsRegistry provider.Provider, ...) (*BatchDeleter, error)
  • func (d *BatchDeleter) Start()
  • func (d *BatchDeleter) Stop()
• type Config
• type Measures
  • func NewMeasures(p provider.Provider) *Measures

Constants

const (
	DeletingQueueDepth = "deleting_queue_depth"
)

Functions

func Metrics

func Metrics() []xmetrics.Metric

Types

type BatchDeleter

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

BatchDeleter manages getting records that have expired and then deleting them.

func NewBatchDeleter

func NewBatchDeleter(config Config, logger log.Logger, metricsRegistry provider.Provider, pruner db.Pruner) (*BatchDeleter, error)

NewBatchDeleter creates a BatchDeleter with the given values, ensuring that the configuration and other values given are valid. If configuration values aren't valid, a default value is used.

func (*BatchDeleter) Start

func (d *BatchDeleter) Start()

Start starts the batcher, which includes a ticker for getting expired records at an interval and the workers that do the deleting.

func (*BatchDeleter) Stop

func (d *BatchDeleter) Stop()

Stop closes the internal queue and waits for the workers to finish processing what has already been added. This can block as it waits for everything to stop.

type Config

type Config struct {
	Shard          int
	MaxWorkers     int
	MaxBatchSize   int
	SetSize        int
	DeleteWaitTime time.Duration
	GetLimit       int
	GetWaitTime    time.Duration
}

Config holds the configuration values for a batch deleter.

type Measures

type Measures struct {
	DeletingQueue metrics.Gauge
}

func NewMeasures

func NewMeasures(p provider.Provider) *Measures

NewMeasures constructs a Measures given a go-kit metrics Provider