containers

Documentation

Overview

Package containers implements the functionality needed to fetch metrics from the different runtimes supported (Docker, containerd, etc.).

Index

• Constants
• Variables
• func BuildEntityName(runtime, id string) string
• func BuildTaggerEntityName(id string) string
• func ContainerIDForEntity(name string) string
• func GetFilterErrors() map[string]struct{}
• func IsEntityName(name string) bool
• func IsPauseContainer(labels map[string]string) bool
• func ResetSharedFilter()
• func SplitEntityName(name string) (string, string)
• func SplitImageName(image string) (string, string, string, string, error)
• type EnvFilter
  • func EnvVarFilterFromConfig() EnvFilter
  • func (f EnvFilter) IsIncluded(envVarName string) bool
• type Filter
  • func GetPauseContainerFilter() (*Filter, error)
  • func GetSharedMetricFilter() (*Filter, error)
  • func NewAutodiscoveryFilter(ft FilterType) (*Filter, error)
  • func NewFilter(ft FilterType, includeList, excludeList []string) (*Filter, error)
  • func (cf Filter) IsExcluded(annotations map[string]string, ...) bool
• type FilterType

Constants

const ContainerEntityName = "container_id"

ContainerEntityName is the entity name applied to all containers

const ContainerEntityPrefix = ContainerEntityName + EntitySeparator

ContainerEntityPrefix is the prefix that any entity corresponding to a container must have It replaces any prior prefix like <runtime>:// in a pod container status.

const EntitySeparator = "://"

EntitySeparator is used to separate the entity name from its ID

const (
	// KubeNamespaceFilterPrefix if the prefix used for Kubernetes namespaces
	KubeNamespaceFilterPrefix = `kube_namespace:`
)

Variables

var (
	// ErrEmptyImage is returned when image name argument is empty
	ErrEmptyImage = errors.New("empty image name")
	// ErrImageIsSha256 is returned when image name argument is a sha256
	ErrImageIsSha256 = errors.New("invalid image name (is a sha256)")
)

Functions

func BuildEntityName

func BuildEntityName(runtime, id string) string

BuildEntityName builds a valid entity name for a given container runtime and cid.

func BuildTaggerEntityName

func BuildTaggerEntityName(id string) string

BuildTaggerEntityName builds a valid tagger entity name for a given cid.

func ContainerIDForEntity

func ContainerIDForEntity(name string) string

ContainerIDForEntity extracts the container ID portion of a container entity name

func GetFilterErrors

func GetFilterErrors() map[string]struct{}

GetFilterErrors retrieves a list of errors and warnings resulting from parseFilters

func IsEntityName

func IsEntityName(name string) bool

IsEntityName tests whether a given entity name is valid

func IsPauseContainer

func IsPauseContainer(labels map[string]string) bool

IsPauseContainer returns whether a container is a pause container based on the container labels This util can be used to exclude pause container in best-effort Note: Pause containers can still be excluded based on the image name via the container filtering module

func ResetSharedFilter

func ResetSharedFilter()

ResetSharedFilter is only to be used in unit tests: it resets the global filter instance to force re-parsing of the configuration.

func SplitEntityName

func SplitEntityName(name string) (string, string)

SplitEntityName returns the prefix and container cid parts of a valid entity name

func SplitImageName

func SplitImageName(image string) (string, string, string, string, error)

SplitImageName splits a valid image name (from ResolveImageName) and returns:

• the "long image name" with registry and prefix, without tag
• the registry
• the "short image name", without registry, prefix nor tag
• the image tag if present
• an error if parsing failed

Types

type EnvFilter

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

EnvFilter defines a filter for environment variables

func EnvVarFilterFromConfig

func EnvVarFilterFromConfig() EnvFilter

EnvVarFilterFromConfig returns an EnvFilter based on the options present in the config

func (EnvFilter) IsIncluded

func (f EnvFilter) IsIncluded(envVarName string) bool

IsIncluded returns whether the given env variable name is included

type Filter

type Filter struct {
	FilterType           FilterType
	Enabled              bool
	ImageIncludeList     []*regexp.Regexp
	NameIncludeList      []*regexp.Regexp
	NamespaceIncludeList []*regexp.Regexp
	ImageExcludeList     []*regexp.Regexp
	NameExcludeList      []*regexp.Regexp
	NamespaceExcludeList []*regexp.Regexp
	Errors               map[string]struct{}
}

Filter holds the state for the container filtering logic

func GetPauseContainerFilter

func GetPauseContainerFilter() (*Filter, error)

GetPauseContainerFilter returns a filter only excluding pause containers

func GetSharedMetricFilter

func GetSharedMetricFilter() (*Filter, error)

GetSharedMetricFilter allows to share the result of NewFilterFromConfig for several user classes

func NewAutodiscoveryFilter

func NewAutodiscoveryFilter(ft FilterType) (*Filter, error)

NewAutodiscoveryFilter creates a new container filter for Autodiscovery It sources patterns from the pkg/config options but ignores the exclude_pause_container options It allows to filter metrics and logs separately For use in autodiscovery.

func NewFilter

func NewFilter(ft FilterType, includeList, excludeList []string) (*Filter, error)

NewFilter creates a new container filter from a two slices of regexp patterns for a include list and exclude list. Each pattern should have the following format: "field:pattern" where field can be: [image, name, kube_namespace]. An error is returned if any of the expression don't compile.

func (Filter) IsExcluded

func (cf Filter) IsExcluded(annotations map[string]string, containerName, containerImage, podNamespace string) bool

IsExcluded returns a bool indicating if the container should be excluded based on the filters in the containerFilter instance. Consider also using Note: exclude filters are not applied to empty container names, empty images and empty namespaces.

type FilterType

type FilterType string

FilterType indicates the container filter type

const (
	// GlobalFilter is used to cover both MetricsFilter and LogsFilter filter types
	GlobalFilter FilterType = "GlobalFilter"
	// MetricsFilter refers to the Metrics filter type
	MetricsFilter FilterType = "MetricsFilter"
	// LogsFilter refers to the Logs filter type
	LogsFilter FilterType = "LogsFilter"
)