monitor

Documentation

Index

• func GetDefaultMonitors(linuxProcess, linuxHost, uid, docker, cni bool) map[Type]interface{}
• type Config
  • func SetupConfig(linuxProcessEnable bool, linuxProcess *linuxmonitor.Config, ...) *Config
  • func (c *Config) String() string
• type Monitor
  • func New(c *Config) (Monitor, error)
• type Type

Functions

func GetDefaultMonitors

func GetDefaultMonitors(linuxProcess, linuxHost, uid, docker, cni bool) map[Type]interface{}

GetDefaultMonitors can be used as an example on how to setup configuration or use a set of defaults that work.

Types

type Config

type Config struct {
	Common    *processor.Config
	Monitors  map[Type]interface{}
	MergeTags []string
}

Config specifies the configs for monitors.

func SetupConfig

func SetupConfig(
	linuxProcessEnable bool,
	linuxProcess *linuxmonitor.Config,
	linuxHostEnable bool,
	linuxHost *linuxmonitor.Config,
	uidEnable bool,
	uid *uidmonitor.Config,
	dockerEnable bool,
	docker *dockermonitor.Config,
	cniEnable bool,
	cni *cnimonitor.Config,
	common *processor.Config,
) *Config

SetupConfig provides a complete configurations on the basis of basic inputs provided.

func (*Config) String

func (c *Config) String() string

type Monitor

type Monitor interface {

	// Start starts the monitor.
	Start() error

	// Stop Stops the monitor.
	Stop() error
}

A Monitor is an interface implmented to start/stop monitors.

func New

func New(c *Config) (Monitor, error)

New instantiates all/any combination of monitors supported.

type Type

type Type int

Type specifies the type of monitors supported.

const (
	CNI Type = iota + 1
	Docker
	LinuxProcess
	LinuxHost
	UID
)

Types supported.