bandwidth

Documentation

Overview

Package bandwidth implements bandwidth usage rollup loop.

Index

• type Config
• type DB
• type Service
  • func NewService(log *zap.Logger, db DB, config Config) *Service
  • func (service *Service) Close() (err error)
  • func (service *Service) Rollup(ctx context.Context) (err error)
  • func (service *Service) Run(ctx context.Context) (err error)
• type Usage
  • func TotalMonthlySummary(ctx context.Context, db DB) (*Usage, error)
  • func (usage *Usage) Add(b *Usage)
  • func (usage *Usage) Include(action pb.PieceAction, amount int64)
  • func (usage *Usage) Total() int64

Types

type Config

type Config struct {
	Interval time.Duration `help:"how frequently bandwidth usage rollups are calculated" default:"1h0m0s"`
}

Config defines parameters for storage node Collector.

type DB

type DB interface {
	Add(ctx context.Context, satelliteID storj.NodeID, action pb.PieceAction, amount int64, created time.Time) error
	// MonthSummary returns summary of the current months bandwidth usages
	MonthSummary(ctx context.Context) (int64, error)
	Rollup(ctx context.Context) (err error)
	Summary(ctx context.Context, from, to time.Time) (*Usage, error)
	SummaryBySatellite(ctx context.Context, from, to time.Time) (map[storj.NodeID]*Usage, error)
}

DB contains information about bandwidth usage.

type Service

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

Service implements

func NewService

func NewService(log *zap.Logger, db DB, config Config) *Service

NewService creates a new bandwidth service.

func (*Service) Close

func (service *Service) Close() (err error)

Close stops the background process for rollups of bandwidth usage

func (*Service) Rollup

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

Rollup calls bandwidth DB Rollup method and logs any errors

func (*Service) Run

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

Run starts the background process for rollups of bandwidth usage

type Usage

type Usage struct {
	Invalid int64
	Unknown int64

	Put       int64
	Get       int64
	GetAudit  int64
	GetRepair int64
	PutRepair int64
	Delete    int64
}

Usage contains bandwidth usage information based on the type

func TotalMonthlySummary

func TotalMonthlySummary(ctx context.Context, db DB) (*Usage, error)

TotalMonthlySummary returns total bandwidth usage for current month

func (*Usage) Add

func (usage *Usage) Add(b *Usage)

Add adds another usage to this one.

func (*Usage) Include

func (usage *Usage) Include(action pb.PieceAction, amount int64)

Include adds specified action to the appropriate field.

func (*Usage) Total

func (usage *Usage) Total() int64

Total sums all type of bandwidths