tally

Documentation

Index

• Variables
• type Config
• type Observer
  • func NewObserver(log *zap.Logger, now time.Time) *Observer
  • func (observer *Observer) InlineSegment(ctx context.Context, segment *metainfo.Segment) (err error)
  • func (observer *Observer) Object(ctx context.Context, object *metainfo.Object) (err error)
  • func (observer *Observer) RemoteSegment(ctx context.Context, segment *metainfo.Segment) (err error)
• type Service
  • func New(log *zap.Logger, sdb accounting.StoragenodeAccounting, ...) *Service
  • func (service *Service) Close() error
  • func (service *Service) Run(ctx context.Context) (err error)
  • func (service *Service) SetNow(now func() time.Time)
  • func (service *Service) Tally(ctx context.Context) (err error)

Variables

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

Error is a standard error class for this package.

Types

type Config

type Config struct {
	Interval            time.Duration `help:"how frequently the tally service should run" releaseDefault:"1h" devDefault:"30s"`
	SaveRollupBatchSize int           `help:"how large of batches SaveRollup should process at a time" default:"1000"`
	ReadRollupBatchSize int           `help:"how large of batches GetBandwidthSince should process at a time" default:"10000"`
}

Config contains configurable values for the tally service.

type Observer

type Observer struct {
	Now    time.Time
	Log    *zap.Logger
	Node   map[storj.NodeID]float64
	Bucket map[metabase.BucketLocation]*accounting.BucketTally
}

Observer observes metainfo and adds up tallies for nodes and buckets.

func NewObserver

func NewObserver(log *zap.Logger, now time.Time) *Observer

NewObserver returns an metainfo loop observer that adds up totals for buckets and nodes. The now argument controls when the observer considers pointers to be expired.

func (*Observer) InlineSegment

func (observer *Observer) InlineSegment(ctx context.Context, segment *metainfo.Segment) (err error)

InlineSegment is called for each inline segment.

func (*Observer) Object

func (observer *Observer) Object(ctx context.Context, object *metainfo.Object) (err error)

Object is called for each object once.

func (*Observer) RemoteSegment

func (observer *Observer) RemoteSegment(ctx context.Context, segment *metainfo.Segment) (err error)

RemoteSegment is called for each remote segment.

type Service

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

Service is the tally service for data stored on each storage node.

architecture: Chore

func New

func New(log *zap.Logger, sdb accounting.StoragenodeAccounting, pdb accounting.ProjectAccounting, liveAccounting accounting.Cache, metainfoLoop *metainfo.Loop, interval time.Duration) *Service

New creates a new tally Service.

func (*Service) Close

func (service *Service) Close() error

Close stops the service and releases any resources.

func (*Service) Run

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

Run the tally service loop.

func (*Service) SetNow

func (service *Service) SetNow(now func() time.Time)

SetNow allows tests to have the Service act as if the current time is whatever they want. This avoids races and sleeping, making tests more reliable and efficient.

func (*Service) Tally

func (service *Service) Tally(ctx context.Context) (err error)

Tally calculates data-at-rest usage once.

How live accounting is calculated:

At the beginning of the tally iteration, we get a map containing the current project totals from the cache- initialLiveTotals (our current estimation of the project totals). At the end of the tally iteration, we have the totals from what we saw during the metainfo loop.

However, data which was uploaded during the loop may or may not have been seen in the metainfo loop. For this reason, we also read the live accounting totals again at the end of the tally iteration- latestLiveTotals.

The difference between latest and initial indicates how much data was uploaded during the metainfo loop and is assigned to delta. However, again, we aren't certain how much of the delta is accounted for in the metainfo totals. For the reason we make an assumption that 50% of the data is accounted for. So to calculate the new live accounting totals, we sum the metainfo totals and 50% of the deltas.