monitor

Documentation

Index

• Variables
• type Config
• type Service
  • func NewService(log *zap.Logger, store *pieces.Store, contact *contact.Service, ...) *Service
  • func (service *Service) AvailableBandwidth(ctx context.Context) (_ int64, err error)
  • func (service *Service) AvailableSpace(ctx context.Context) (_ int64, err error)
  • func (service *Service) Close() (err error)
  • func (service *Service) NotifyLowDisk()
  • func (service *Service) Run(ctx context.Context) (err error)

Variables

var (

	// Error is the default error class for piecestore monitor errors
	Error = errs.Class("piecestore monitor")
)

Types

type Config

type Config struct {
	Interval              time.Duration `help:"how frequently Kademlia bucket should be refreshed with node stats" default:"1h0m0s"`
	MinimumDiskSpace      memory.Size   `help:"how much disk space a node at minimum has to advertise" default:"500GB"`
	MinimumBandwidth      memory.Size   `help:"how much bandwidth a node at minimum has to advertise" default:"500GB"`
	NotifyLowDiskCooldown time.Duration `help:"minimum length of time between capacity reports" default:"10m" hidden:"true"`
}

Config defines parameters for storage node disk and bandwidth usage monitoring.

type Service

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

Service which monitors disk usage

architecture: Service

func NewService

func NewService(log *zap.Logger, store *pieces.Store, contact *contact.Service, usageDB bandwidth.DB, allocatedDiskSpace, allocatedBandwidth int64, interval time.Duration, reportCapacity func(context.Context), config Config) *Service

NewService creates a new storage node monitoring service.

func (*Service) AvailableBandwidth

func (service *Service) AvailableBandwidth(ctx context.Context) (_ int64, err error)

AvailableBandwidth returns available bandwidth for upload/download

func (*Service) AvailableSpace

func (service *Service) AvailableSpace(ctx context.Context) (_ int64, err error)

AvailableSpace returns available disk space for upload

func (*Service) Close

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

Close stops the monitor service.

func (*Service) NotifyLowDisk

func (service *Service) NotifyLowDisk()

NotifyLowDisk reports disk space to satellites if cooldown timer has expired

func (*Service) Run

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

Run runs monitor service