container

Documentation

Overview

Package container defines types for sub-container events and also defines an interface for container operation handlers.

Index

• func ClearContainerHandlerFactories()
• func DebugInfo() map[string][]string
• func HasFactories() bool
• func RegisterContainerHandlerFactory(factory ContainerHandlerFactory)
• type ContainerHandler
  • func NewContainerHandler(name string, inHostNamespace bool) (ContainerHandler, bool, error)
• type ContainerHandlerFactory
• type ListType
• type MetricKind
  • func (mk MetricKind) String() string
• type MetricSet
  • func (ms MetricSet) Add(mk MetricKind)
  • func (ms MetricSet) Has(mk MetricKind) bool
• type SubcontainerEvent
• type SubcontainerEventType

Functions

func ClearContainerHandlerFactories

func ClearContainerHandlerFactories()

Clear the known factories.

func DebugInfo

func DebugInfo() map[string][]string

func HasFactories

func HasFactories() bool

Returns whether there are any container handler factories registered.

func RegisterContainerHandlerFactory

func RegisterContainerHandlerFactory(factory ContainerHandlerFactory)

Register a ContainerHandlerFactory. These should be registered from least general to most general as they will be asked in order whether they can handle a particular container.

Types

type ContainerHandler

type ContainerHandler interface {
	// Returns the ContainerReference
	ContainerReference() (info.ContainerReference, error)

	// Returns container's isolation spec.
	GetSpec() (info.ContainerSpec, error)

	// Returns the current stats values of the container.
	GetStats() (*info.ContainerStats, error)

	// Returns the subcontainers of this container.
	ListContainers(listType ListType) ([]info.ContainerReference, error)

	// Returns the threads inside this container.
	ListThreads(listType ListType) ([]int, error)

	// Returns the processes inside this container.
	ListProcesses(listType ListType) ([]int, error)

	// Registers a channel to listen for events affecting subcontainers (recursively).
	WatchSubcontainers(events chan SubcontainerEvent) error

	// Stops watching for subcontainer changes.
	StopWatchingSubcontainers() error

	// Returns absolute cgroup path for the requested resource.
	GetCgroupPath(resource string) (string, error)

	// Returns container labels, if available.
	GetContainerLabels() map[string]string

	// Returns whether the container still exists.
	Exists() bool

	// Cleanup frees up any resources being held like fds or go routines, etc.
	Cleanup()

	// Start starts any necessary background goroutines - must be cleaned up in Cleanup().
	// It is expected that most implementations will be a no-op.
	Start()
}

Interface for container operation handlers.

func NewContainerHandler

func NewContainerHandler(name string, inHostNamespace bool) (ContainerHandler, bool, error)

Create a new ContainerHandler for the specified container.

type ContainerHandlerFactory

type ContainerHandlerFactory interface {
	// Create a new ContainerHandler using this factory. CanHandleAndAccept() must have returned true.
	NewContainerHandler(name string, inHostNamespace bool) (c ContainerHandler, err error)

	// Returns whether this factory can handle and accept the specified container.
	CanHandleAndAccept(name string) (handle bool, accept bool, err error)

	// Name of the factory.
	String() string

	// Returns debugging information. Map of lines per category.
	DebugInfo() map[string][]string
}

type ListType

type ListType int

ListType describes whether listing should be just for a specific container or performed recursively.

const (
	ListSelf ListType = iota
	ListRecursive
)

type MetricKind

type MetricKind string

MetricKind represents the kind of metrics that cAdvisor exposes.

const (
	CpuUsageMetrics        MetricKind = "cpu"
	MemoryUsageMetrics     MetricKind = "memory"
	CpuLoadMetrics         MetricKind = "cpuLoad"
	DiskIOMetrics          MetricKind = "diskIO"
	DiskUsageMetrics       MetricKind = "disk"
	NetworkUsageMetrics    MetricKind = "network"
	NetworkTcpUsageMetrics MetricKind = "tcp"
	AppMetrics             MetricKind = "app"
)

func (MetricKind) String

func (mk MetricKind) String() string

type MetricSet

type MetricSet map[MetricKind]struct{}

func (MetricSet) Add

func (ms MetricSet) Add(mk MetricKind)

func (MetricSet) Has

func (ms MetricSet) Has(mk MetricKind) bool

type SubcontainerEvent

type SubcontainerEvent struct {
	// The type of event that occurred.
	EventType SubcontainerEventType

	// The full container name of the container where the event occurred.
	Name string
}

SubcontainerEvent represents a

type SubcontainerEventType

type SubcontainerEventType int

SubcontainerEventType indicates an addition or deletion event.

const (
	SubcontainerAdd SubcontainerEventType = iota
	SubcontainerDelete
)