metrics

Documentation

Index

• Constants
• func BaseContainerLabels(whiteList []string) func(container *info.ContainerInfo) map[string]string
• func DefaultContainerLabels(container *info.ContainerInfo) map[string]string
• type ContainerLabelsFunc
• type PrometheusCollector
  • func NewPrometheusCollector(i infoProvider, f ContainerLabelsFunc, includedMetrics container.MetricSet) *PrometheusCollector
  • func (c *PrometheusCollector) Collect(ch chan<- prometheus.Metric)
  • func (c *PrometheusCollector) Describe(ch chan<- *prometheus.Desc)

Constants

const (
	// ContainerLabelPrefix is the prefix added to all container labels.
	ContainerLabelPrefix = "container_label_"
	// ContainerEnvPrefix is the prefix added to all env variable labels.
	ContainerEnvPrefix = "container_env_"
	// LabelID is the name of the id label.
	LabelID = "id"
	// LabelName is the name of the name label.
	LabelName = "name"
	// LabelImage is the name of the image label.
	LabelImage = "image"
)

Functions

func BaseContainerLabels

func BaseContainerLabels(whiteList []string) func(container *info.ContainerInfo) map[string]string

BaseContainerLabels returns a ContainerLabelsFunc that exports the container name, first alias, image name as well as white listed label values.

func DefaultContainerLabels

func DefaultContainerLabels(container *info.ContainerInfo) map[string]string

DefaultContainerLabels implements ContainerLabelsFunc. It exports the container name, first alias, image name as well as all its env and label values.

Types

type ContainerLabelsFunc

type ContainerLabelsFunc func(*info.ContainerInfo) map[string]string

ContainerLabelsFunc defines all base labels and their values attached to each metric exported by cAdvisor.

type PrometheusCollector

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

PrometheusCollector implements prometheus.Collector.

func NewPrometheusCollector

func NewPrometheusCollector(i infoProvider, f ContainerLabelsFunc, includedMetrics container.MetricSet) *PrometheusCollector

NewPrometheusCollector returns a new PrometheusCollector. The passed ContainerLabelsFunc specifies which base labels will be attached to all exported metrics. If left to nil, the DefaultContainerLabels function will be used instead.

func (*PrometheusCollector) Collect

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

Collect fetches the stats from all containers and delivers them as Prometheus metrics. It implements prometheus.PrometheusCollector.

func (*PrometheusCollector) Describe

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

Describe describes all the metrics ever exported by cadvisor. It implements prometheus.PrometheusCollector.