collector

Documentation

Index

• type Collector
  • func New(store *store.Store, opts ...Option) (*Collector, error)
  • func (c *Collector) Close() error
  • func (c *Collector) Subscribe() <-chan struct{}
• type Option
  • func WithFetchLimit(limit int) Option
  • func WithFetchTimeout(timeout time.Duration) Option
  • func WithFrequency(freq time.Duration) Option
  • func WithRunOnStart(enabled bool) Option

Types

type Collector

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

Collector is responsible for fetching storage/retrieval records from external Powergate instances, and merging them in a unified database.

func New

func New(store *store.Store, opts ...Option) (*Collector, error)

New returns a new Collector.

func (*Collector) Close

func (c *Collector) Close() error

Close closes the Collector.

func (*Collector) Subscribe

func (c *Collector) Subscribe() <-chan struct{}

Subscribe returns a notification channel that will get pushed signales whenever a new batch of records was imported. This is useful for interested parties knowing about new record's data might be available.

type Option

type Option func(*config)

Option parametrizes a collector configuration.

func WithFetchLimit

func WithFetchLimit(limit int) Option

WithFetchLimit indicates the maximum record batch size to be fetched from targets.

func WithFetchTimeout

func WithFetchTimeout(timeout time.Duration) Option

WithFetchTimeout indicates the maximum amount of time that fetching from a target can take.

func WithFrequency

func WithFrequency(freq time.Duration) Option

WithFrequency indicates the frequency for the collector daemon.

func WithRunOnStart

func WithRunOnStart(enabled bool) Option

WithRunOnStart indicates if a collection should be fired on start.