collector

README

package collector

This package is responsible for providing any resource and functionality needed in a check life cycle: create a check instance, schedule a check, running a check are all operations implemented in this package or one of the subpackages.

For further details, please refer to the specific READMEs:

• check
• corechecks
• py
• runner
• scheduler

Documentation

Index

• func GetChecksByNameForConfigs(checkName string, configs []integration.Config) []check.Check
• func GetLoaderErrors() map[string]map[string]string
• type CheckScheduler
  • func InitCheckScheduler(collector *Collector) *CheckScheduler
  • func (s *CheckScheduler) AddLoader(loader check.Loader)
  • func (s *CheckScheduler) GetChecksFromConfigs(configs []integration.Config, populateCache bool) []check.Check
  • func (s *CheckScheduler) Schedule(configs []integration.Config)
  • func (s *CheckScheduler) Stop()
  • func (s *CheckScheduler) Unschedule(configs []integration.Config)
• type Collector
  • func NewCollector(paths ...string) *Collector
  • func (c *Collector) GetAllInstanceIDs(checkName string) []check.ID
  • func (c *Collector) ReloadAllCheckInstances(name string, newInstances []check.Check) ([]check.ID, error)
  • func (c *Collector) RunCheck(ch check.Check) (check.ID, error)
  • func (c *Collector) Stop()
  • func (c *Collector) StopCheck(id check.ID) error

Functions

func GetChecksByNameForConfigs

func GetChecksByNameForConfigs(checkName string, configs []integration.Config) []check.Check

GetChecksByNameForConfigs returns checks matching name for passed in configs

func GetLoaderErrors

func GetLoaderErrors() map[string]map[string]string

GetLoaderErrors returns the check loader errors

Types

type CheckScheduler

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

CheckScheduler is the check scheduler

func InitCheckScheduler

func InitCheckScheduler(collector *Collector) *CheckScheduler

InitCheckScheduler creates and returns a check scheduler

func (*CheckScheduler) AddLoader

func (s *CheckScheduler) AddLoader(loader check.Loader)

AddLoader adds a new Loader that AutoConfig can use to load a check.

func (*CheckScheduler) GetChecksFromConfigs

func (s *CheckScheduler) GetChecksFromConfigs(configs []integration.Config, populateCache bool) []check.Check

GetChecksFromConfigs gets all the check instances for given configurations optionally can populate the configToChecks cache

func (*CheckScheduler) Schedule

func (s *CheckScheduler) Schedule(configs []integration.Config)

Schedule schedules configs to checks

func (*CheckScheduler) Stop

func (s *CheckScheduler) Stop()

Stop handles clean stop of registered schedulers

func (*CheckScheduler) Unschedule

func (s *CheckScheduler) Unschedule(configs []integration.Config)

Unschedule unschedules checks matching configs

type Collector

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

Collector abstract common operations about running a Check

func NewCollector

func NewCollector(paths ...string) *Collector

NewCollector create a Collector instance and sets up the Python Environment

func (*Collector) GetAllInstanceIDs

func (c *Collector) GetAllInstanceIDs(checkName string) []check.ID

GetAllInstanceIDs returns the ID's of all instances of a check

func (*Collector) ReloadAllCheckInstances

func (c *Collector) ReloadAllCheckInstances(name string, newInstances []check.Check) ([]check.ID, error)

ReloadAllCheckInstances completely restarts a check with a new configuration

func (*Collector) RunCheck

func (c *Collector) RunCheck(ch check.Check) (check.ID, error)

RunCheck sends a Check in the execution queue

func (*Collector) Stop

func (c *Collector) Stop()

Stop halts any component involved in running a Check and shuts down the Python Environment

func (*Collector) StopCheck

func (c *Collector) StopCheck(id check.ID) error

StopCheck halts a check and remove the instance