collector

README

package collector

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

Metadata

All the facilities to compute and post metadata informations to the backend live here, in analogy with how this worked in the Python agent. Should this code be used by any other softwares than the Agent itself at some point, the metadata package could be moved out of the collector folder and made more visible.

For further details, please refer to the specific READMEs:

• check
• corechecks
• metadata
• providers
• py
• runner
• scheduler

Documentation

Index

• type Collector
  • func NewCollector(paths ...string) *Collector
  • func (c *Collector) ReloadCheck(id check.ID, config, initConfig check.ConfigData) error
  • func (c *Collector) RunCheck(ch check.Check) (check.ID, error)
  • func (c *Collector) Stop()
  • func (c *Collector) StopCheck(id check.ID) error
• Bugs

Types

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) ReloadCheck

func (c *Collector) ReloadCheck(id check.ID, config, initConfig check.ConfigData) error

ReloadCheck stops and restart 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

Notes

Bugs

• we could create the Check if it doesn't exist, see https://github.com/DataDog/datadog-agent/pull/148 for reference