manager

Documentation

Overview

TODO(cAdvisor): Package comment.

Index

• Variables
• type Manager
  • func New(driver storage.StorageDriver) (Manager, error)

Variables

var HousekeepingInterval = flag.Duration("housekeeping_interval", 1*time.Second, "Interval between container housekeepings")

Housekeeping interval.

Types

type Manager

type Manager interface {
	// Start the manager.
	Start() error

	// Stops the manager.
	Stop() error

	// Get information about a container.
	GetContainerInfo(containerName string, query *info.ContainerInfoRequest) (*info.ContainerInfo, error)

	// Get information about all subcontainers of the specified container (includes self).
	SubcontainersInfo(containerName string, query *info.ContainerInfoRequest) ([]*info.ContainerInfo, error)

	// Get information for the specified Docker container (or "/" for all Docker containers).
	// Full container names here are interpreted within the Docker namespace (e.g.: /test -> top-level Docker container named 'test').
	DockerContainersInfo(containerName string, query *info.ContainerInfoRequest) ([]*info.ContainerInfo, error)

	// Get information about the machine.
	GetMachineInfo() (*info.MachineInfo, error)

	// Get version information about different components we depend on.
	GetVersionInfo() (*info.VersionInfo, error)
}

The Manager interface defines operations for starting a manager and getting container and machine information.

func New

func New(driver storage.StorageDriver) (Manager, error)

New takes a driver and returns a new manager.