nodestats

Documentation

Index

• Variables
• type Cache
  • func NewCache(log *zap.Logger, config Config, db CacheStorage, service *Service, ...) *Cache
  • func (cache *Cache) CacheHeldAmount(ctx context.Context) (err error)
  • func (cache *Cache) CacheReputationStats(ctx context.Context) (err error)
  • func (cache *Cache) CacheSpaceUsage(ctx context.Context) (err error)
  • func (cache *Cache) Close() error
  • func (cache *Cache) Run(ctx context.Context) error
• type CacheStorage
• type Client
  • func (c *Client) Close() error
• type Config
• type Service
  • func NewService(log *zap.Logger, dialer rpc.Dialer, trust *trust.Pool) *Service
  • func (s *Service) GetDailyStorageUsage(ctx context.Context, satelliteID storj.NodeID, from, to time.Time) (_ []storageusage.Stamp, err error)
  • func (s *Service) GetPricingModel(ctx context.Context, satelliteID storj.NodeID) (_ *pricing.Pricing, err error)
  • func (s *Service) GetReputationStats(ctx context.Context, satelliteID storj.NodeID) (_ *reputation.Stats, err error)
• type UsageStat
  • func NewUsageStat() *UsageStat
  • func (u *UsageStat) Stats(cb func(key monkit.SeriesKey, field string, val float64))
  • func (u *UsageStat) Update(satellite storj.NodeID, usedSpace float64)

Variables

var (
	// NodeStatsServiceErr defines node stats service error.
	NodeStatsServiceErr = errs.Class("nodestats")
)

Types

type Cache

type Cache struct {
	Reputation *sync2.Cycle
	Storage    *sync2.Cycle

	UsageStat *UsageStat
	// contains filtered or unexported fields
}

Cache runs cache loop and stores reputation stats and storage usage into db.

architecture: Chore

func NewCache

func NewCache(log *zap.Logger, config Config, db CacheStorage, service *Service,
	payoutEndpoint *payouts.Endpoint, reputationService *reputation.Service, trust *trust.Pool) *Cache

NewCache creates new caching service instance.

func (*Cache) CacheHeldAmount

func (cache *Cache) CacheHeldAmount(ctx context.Context) (err error)

CacheHeldAmount queries held amount stats and payments from all the satellites known to the storagenode and stores info into db.

func (*Cache) CacheReputationStats

func (cache *Cache) CacheReputationStats(ctx context.Context) (err error)

CacheReputationStats queries node stats from all the satellites known to the storagenode and stores information into db.

func (*Cache) CacheSpaceUsage

func (cache *Cache) CacheSpaceUsage(ctx context.Context) (err error)

CacheSpaceUsage queries disk space usage from all the satellites known to the storagenode and stores information into db.

func (*Cache) Close

func (cache *Cache) Close() error

Close closes underlying cycles.

func (*Cache) Run

func (cache *Cache) Run(ctx context.Context) error

Run runs loop.

type CacheStorage

type CacheStorage struct {
	Reputation   reputation.DB
	StorageUsage storageusage.DB
	Payout       payouts.DB
	Pricing      pricing.DB
}

CacheStorage encapsulates cache DBs.

type Client

type Client struct {
	pb.DRPCNodeStatsClient
	// contains filtered or unexported fields
}

Client encapsulates NodeStatsClient with underlying connection.

architecture: Client

func (*Client) Close

func (c *Client) Close() error

Close closes underlying client connection.

type Config

type Config struct {
	MaxSleep       time.Duration `help:"maximum duration to wait before requesting data" releaseDefault:"300s" devDefault:"1s"`
	ReputationSync time.Duration `help:"how often to sync reputation" releaseDefault:"4h" devDefault:"1m"`
	StorageSync    time.Duration `help:"how often to sync storage" releaseDefault:"12h" devDefault:"2m"`
}

Config defines nodestats cache configuration.

type Service

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

Service retrieves info from satellites using an rpc client.

architecture: Service

func NewService

func NewService(log *zap.Logger, dialer rpc.Dialer, trust *trust.Pool) *Service

NewService creates new instance of service.

func (*Service) GetDailyStorageUsage

func (s *Service) GetDailyStorageUsage(ctx context.Context, satelliteID storj.NodeID, from, to time.Time) (_ []storageusage.Stamp, err error)

GetDailyStorageUsage returns daily storage usage over a period of time for a particular satellite.

func (*Service) GetPricingModel

func (s *Service) GetPricingModel(ctx context.Context, satelliteID storj.NodeID) (_ *pricing.Pricing, err error)

GetPricingModel returns pricing model of specific satellite.

func (*Service) GetReputationStats

func (s *Service) GetReputationStats(ctx context.Context, satelliteID storj.NodeID) (_ *reputation.Stats, err error)

GetReputationStats retrieves reputation stats from particular satellite.

type UsageStat

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

UsageStat caches last space usage value for each satellite, to make it available for monkit.

func NewUsageStat

func NewUsageStat() *UsageStat

NewUsageStat initializes a UsageState.

func (*UsageStat) Stats

func (u *UsageStat) Stats(cb func(key monkit.SeriesKey, field string, val float64))

Stats implements monkit.StatSource.

func (*UsageStat) Update

func (u *UsageStat) Update(satellite storj.NodeID, usedSpace float64)

Update updates the cached value.