rollup

Documentation

Index

• Variables
• type Config
• type Service
  • func New(logger *zap.Logger, sdb accounting.StoragenodeAccounting, ...) *Service
  • func (r *Service) Close() error
  • func (r *Service) Rollup(ctx context.Context) (err error)
  • func (r *Service) RollupBW(ctx context.Context, lastRollup time.Time, rollupStats accounting.RollupStats) (err error)
  • func (r *Service) RollupStorage(ctx context.Context, lastRollup time.Time, rollupStats accounting.RollupStats) (latestTally time.Time, err error)
  • func (r *Service) Run(ctx context.Context) (err error)

Variables

var (
	Error = errs.Class("rollup error")
)

Error is a standard error class for this package.

Types

type Config

type Config struct {
	Interval      time.Duration `help:"how frequently rollup should run" releaseDefault:"24h" devDefault:"120s"`
	MaxAlphaUsage memory.Size   `help:"the bandwidth and storage usage limit for the alpha release" releaseDefault:"5GB" devDefault:"25GB"`
	DeleteTallies bool          `help:"option for deleting tallies after they are rolled up" default:"true"`
}

Config contains configurable values for rollup

type Service

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

Service is the rollup service for totalling data on storage nodes on daily intervals

architecture: Chore

func New

func New(logger *zap.Logger, sdb accounting.StoragenodeAccounting, interval time.Duration, deleteTallies bool) *Service

New creates a new rollup service

func (*Service) Close

func (r *Service) Close() error

Close stops the service and releases any resources.

func (*Service) Rollup

func (r *Service) Rollup(ctx context.Context) (err error)

Rollup aggregates storage and bandwidth amounts for the time interval

func (*Service) RollupBW

func (r *Service) RollupBW(ctx context.Context, lastRollup time.Time, rollupStats accounting.RollupStats) (err error)

RollupBW aggregates the bandwidth rollups, modifies rollupStats map

func (*Service) RollupStorage

func (r *Service) RollupStorage(ctx context.Context, lastRollup time.Time, rollupStats accounting.RollupStats) (latestTally time.Time, err error)

RollupStorage rolls up storage tally, modifies rollupStats map

func (*Service) Run

func (r *Service) Run(ctx context.Context) (err error)

Run the Rollup loop