cgroups

Documentation

Index

• Variables
• func New(ic *plugin.InitContext) (interface{}, error)
• type Collector
  • func NewCollector(ns *metrics.Namespace) *Collector
  • func (c *Collector) Add(id, namespace string, cg cgroups.Cgroup) error
  • func (c *Collector) Collect(ch chan<- prometheus.Metric)
  • func (c *Collector) Describe(ch chan<- *prometheus.Desc)
  • func (c *Collector) Get(id, namespace string) (cgroups.Cgroup, error)
  • func (c *Collector) Remove(id, namespace string)
• type OOMCollector
  • func NewOOMCollector(ns *metrics.Namespace) (*OOMCollector, error)
  • func (o *OOMCollector) Add(id, namespace string, cg cgroups.Cgroup, triggers ...Trigger) error
  • func (o *OOMCollector) Close() error
  • func (o *OOMCollector) Collect(ch chan<- prometheus.Metric)
  • func (o *OOMCollector) Describe(ch chan<- *prometheus.Desc)
• type Trigger

Variables

var (
	ErrAlreadyCollected = errors.New("cgroup is already being collected")
	ErrCgroupNotExists  = errors.New("cgroup does not exist in the collector")
)

Functions

func New

func New(ic *plugin.InitContext) (interface{}, error)

Types

type Collector

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

Collector provides the ability to collect container stats and export them in the prometheus format

func NewCollector

func NewCollector(ns *metrics.Namespace) *Collector

New registers the Collector with the provided namespace and returns it so that cgroups can be added for collection

func (*Collector) Add

func (c *Collector) Add(id, namespace string, cg cgroups.Cgroup) error

Add adds the provided cgroup and id so that metrics are collected and exported

func (*Collector) Collect

func (c *Collector) Collect(ch chan<- prometheus.Metric)

func (*Collector) Describe

func (c *Collector) Describe(ch chan<- *prometheus.Desc)

func (*Collector) Get

func (c *Collector) Get(id, namespace string) (cgroups.Cgroup, error)

Get returns the cgroup that is being collected under the provided id returns ErrCgroupNotExists if the id is not being collected

func (*Collector) Remove

func (c *Collector) Remove(id, namespace string)

Remove removes the provided cgroup by id from the collector

type OOMCollector

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

func NewOOMCollector

func NewOOMCollector(ns *metrics.Namespace) (*OOMCollector, error)

func (*OOMCollector) Add

func (o *OOMCollector) Add(id, namespace string, cg cgroups.Cgroup, triggers ...Trigger) error

func (*OOMCollector) Close

func (o *OOMCollector) Close() error

Close closes the epoll fd

func (*OOMCollector) Collect

func (o *OOMCollector) Collect(ch chan<- prometheus.Metric)

func (*OOMCollector) Describe

func (o *OOMCollector) Describe(ch chan<- *prometheus.Desc)

type Trigger

type Trigger func(string, string, cgroups.Cgroup)

Trigger will be called when an event happens and provides the cgroup where the event originated from