live

Documentation

Overview

Package live provides live accounting functionality. That is, it keeps track of deltas in the amount of storage used by each project relative to the last tally operation (see pkg/accounting/tally).

Index

• type Config
• type Service
  • func New(log *zap.Logger, config Config) (Service, error)

Types

type Config

type Config struct {
	StorageBackend string `help:"what to use for storing real-time accounting data" default:"plainmemory"`
}

Config contains configurable values for the live accounting service.

type Service

type Service interface {
	GetProjectStorageUsage(ctx context.Context, projectID uuid.UUID) (int64, int64, error)
	AddProjectStorageUsage(ctx context.Context, projectID uuid.UUID, inlineSpaceUsed, remoteSpaceUsed int64) error
	ResetTotals()
}

Service represents the external interface to the live accounting functionality.

func New

func New(log *zap.Logger, config Config) (Service, error)

New creates a new live.Service instance of the type specified in the provided config.