stats

Documentation

Index

• Variables
• type Config
• type Counter
  • func (c *Counter) GetConfig() *opts.Counter
  • func (c *Counter) GetTSHistory(from, to int64) ([]*tstorage.DataPoint, error)
  • func (c *Counter) GetTotal() (float64, error)
  • func (c *Counter) Incr(i float64)
  • func (c *Counter) Value() float64
• type IStats
• type Stats
  • func New(cfg *Config) (*Stats, error)
  • func (s *Stats) AddCounter(cfg *opts.Counter) *Counter
  • func (s *Stats) GetAllCounters() map[string]*Counter
  • func (s *Stats) GetCounter(counterType opts.Counter_Type, resourceType opts.Counter_Resource, ...) (*Counter, error)
  • func (s *Stats) RemoveCounter(c *Counter) error

Variables

var (
	ErrInvalidFlushInterval = errors.New("FlushInterval cannot be 0")
	ErrCounterNotFound      = errors.New("counter not found")
	ErrMissingShutdownCtx   = errors.New("ServiceShutdownCtx cannot be nil")
	ErrMissingStorage       = errors.New("ErrMissingStorage cannot be empty")
)

Types

type Config

type Config struct {
	// FlushInterval is how often the goroutine will flush a counter's value to time-series db
	FlushInterval time.Duration

	// ServiceShutdownCtx is used to signal all counters to flush and then cleanly close the database
	ServiceShutdownCtx context.Context

	Storage tstorage.Storage
}

type Counter

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

func (*Counter) GetConfig

func (c *Counter) GetConfig() *opts.Counter

GetConfig returns counter config

func (*Counter) GetTSHistory

func (c *Counter) GetTSHistory(from, to int64) ([]*tstorage.DataPoint, error)

GetTSHistory gets time-series history for the counter

func (*Counter) GetTotal

func (c *Counter) GetTotal() (float64, error)

GetTotal aggregates the in-memory and historical total

func (*Counter) Incr

func (c *Counter) Incr(i float64)

Incr increases the value of a counter by the value of i

func (*Counter) Value

func (c *Counter) Value() float64

Value returns the current value of a counter

type IStats

type IStats interface {
	AddCounter(cfg *opts.Counter) *Counter
	GetAllCounters() map[string]*Counter
	GetCounter(counterType opts.Counter_Type, resourceType opts.Counter_Resource, resourceID string) (*Counter, error)
	RemoveCounter(counter *Counter) error
}

type Stats

type Stats struct {
	*Config
	// contains filtered or unexported fields
}

func New

func New(cfg *Config) (*Stats, error)

New returns a configured struct for the statistics service

func (*Stats) AddCounter

func (s *Stats) AddCounter(cfg *opts.Counter) *Counter

AddCounter creates a new counter and launches a runFlusher() goroutine for it

func (*Stats) GetAllCounters

func (s *Stats) GetAllCounters() map[string]*Counter

GetAllCounters returns the entire counters map

func (*Stats) GetCounter

func (s *Stats) GetCounter(counterType opts.Counter_Type, resourceType opts.Counter_Resource, resourceID string) (*Counter, error)

GetCounter retrieves a single counter from the counters map

func (*Stats) RemoveCounter

func (s *Stats) RemoveCounter(c *Counter) error

RemoveCounter will flush a counter's value to persistent storage, stop the associated runFlusher() go routine, and delete the counter from the counters map