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 satellite/accounting/tally).

Index

• Variables
• func OpenCache(ctx context.Context, log *zap.Logger, config Config) (accounting.Cache, error)
• type Config

Variables

var (
	// Error is the default error class for live-accounting.
	Error = errs.Class("live-accounting")
)

Functions

func OpenCache

func OpenCache(ctx context.Context, log *zap.Logger, config Config) (accounting.Cache, error)

OpenCache creates a new accounting.Cache instance using the type specified backend in the provided config.

The cache instance may be returned despite of returning the accounting.ErrSystemOrNetError because some backends allows to reconnect on each operation if the connection was not established or it was disconnected, which is what it could happen at the moment to instance it and the cache will work one the backend system will be reachable later on. For this reason, the components that uses the cache should operate despite the backend is not responding successfully although their service is degraded.

Types

type Config

type Config struct {
	StorageBackend    string        `help:"what to use for storing real-time accounting data"`
	BandwidthCacheTTL time.Duration `default:"5m" help:"bandwidth cache key time to live"`
}

Config contains configurable values for the live accounting service.