stats

Documentation

Index

• Constants
• Variables
• type BufferedCollector
  • func NewBufferedCollector(installationID, processID string, opts ...BufferedCollectorOpts) *BufferedCollector
  • func (s *BufferedCollector) CollectEvent(class, action string)
  • func (s *BufferedCollector) CollectMetadata(accountMetadata map[string]string)
  • func (s *BufferedCollector) Done() <-chan bool
  • func (s *BufferedCollector) Run(ctx context.Context)
• type BufferedCollectorOpts
  • func WithFlushInterval(d time.Duration) BufferedCollectorOpts
  • func WithSendTimeout(d time.Duration) BufferedCollectorOpts
  • func WithSender(sender Sender) BufferedCollectorOpts
  • func WithTicker(t FlushTicker) BufferedCollectorOpts
  • func WithWriteBufferSize(bufferSize int) BufferedCollectorOpts
• type Collector
• type FlushTicker
• type HTTPSender
  • func NewHTTPSender(addr string, timeFunc TimeFn) *HTTPSender
  • func (s *HTTPSender) SendEvent(ctx context.Context, installationID, processID string, metrics []Metric) error
  • func (s *HTTPSender) UpdateMetadata(ctx context.Context, m Metadata) error
• type InputEvent
• type Metadata
• type MetadataEntry
• type Metric
• type Sender
  • func NewDummySender() Sender
• type TimeFn
• type TimeTicker
  • func (t *TimeTicker) Stop()
  • func (t *TimeTicker) Tick() <-chan time.Time

Constants

const (
	DefaultCollectorEventBufferSize = 1024 * 1024
	DefaultFlushInterval            = time.Second * 600
	DefaultSendTimeout              = time.Second * 5
)

Variables

var (
	ErrSendError        = errors.New("stats: send error")
	ErrNoInstallationID = fmt.Errorf("installation ID is missing: %w", ErrSendError)
)

Types

type BufferedCollector

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

func NewBufferedCollector

func NewBufferedCollector(installationID, processID string, opts ...BufferedCollectorOpts) *BufferedCollector

func (*BufferedCollector) CollectEvent

func (s *BufferedCollector) CollectEvent(class, action string)

func (*BufferedCollector) CollectMetadata

func (s *BufferedCollector) CollectMetadata(accountMetadata map[string]string)

func (*BufferedCollector) Done

func (s *BufferedCollector) Done() <-chan bool

func (*BufferedCollector) Run

func (s *BufferedCollector) Run(ctx context.Context)

type BufferedCollectorOpts

type BufferedCollectorOpts func(s *BufferedCollector)

func WithFlushInterval

func WithFlushInterval(d time.Duration) BufferedCollectorOpts

func WithSendTimeout

func WithSendTimeout(d time.Duration) BufferedCollectorOpts

func WithSender

func WithSender(sender Sender) BufferedCollectorOpts

func WithTicker

func WithTicker(t FlushTicker) BufferedCollectorOpts

func WithWriteBufferSize

func WithWriteBufferSize(bufferSize int) BufferedCollectorOpts

type Collector

type Collector interface {
	CollectEvent(class, action string)
	CollectMetadata(accountMetadata map[string]string)
}

type FlushTicker

type FlushTicker interface {
	Stop()
	Tick() <-chan time.Time
}

type HTTPSender

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

func NewHTTPSender

func NewHTTPSender(addr string, timeFunc TimeFn) *HTTPSender

func (*HTTPSender) SendEvent

func (s *HTTPSender) SendEvent(ctx context.Context, installationID, processID string, metrics []Metric) error

func (*HTTPSender) UpdateMetadata

func (s *HTTPSender) UpdateMetadata(ctx context.Context, m Metadata) error

type InputEvent

type InputEvent struct {
	InstallationID string   `json:"installation_id"`
	ProcessID      string   `json:"process_id"`
	Time           string   `json:"time"`
	Metrics        []Metric `json:"metrics"`
}

type Metadata

type Metadata struct {
	InstallationID string          `json:"installation_id"`
	Entries        []MetadataEntry `json:"entries"`
}

type MetadataEntry

type MetadataEntry struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type Metric

type Metric struct {
	Class string `json:"class"`
	Name  string `json:"name"`
	Value uint64 `json:"value"`
}

type Sender

type Sender interface {
	SendEvent(ctx context.Context, installationID, processID string, m []Metric) error
	UpdateMetadata(ctx context.Context, m Metadata) error
}

func NewDummySender

func NewDummySender() Sender

type TimeFn

type TimeFn func() time.Time

type TimeTicker

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

func (*TimeTicker) Stop

func (t *TimeTicker) Stop()

func (*TimeTicker) Tick

func (t *TimeTicker) Tick() <-chan time.Time