cgroup

Documentation

Index

• Constants
• Variables
• func Init() error
• type CPUStat
• type Cgroup
  • func NewFromProcessCgroupFile(filePath string) (*Cgroup, error)
  • func (cg Cgroup) CpuStat() (*CPUStat, error)
  • func (cg *Cgroup) CreatedAt() time.Time
  • func (cg *Cgroup) IOStat() (map[string]IOStat, error)
  • func (cg *Cgroup) MemoryStat() (*MemoryStat, error)
• type Client
  • func NewClient(log *logging.Logger, root string) (*Client, error)
  • func (c *Client) CleanupCgroup(id ID)
  • func (c *Client) DefaultCgroupVersion() Version
  • func (c *Client) GetCgroupForID(cgroupID ID) (*Cgroup, error)
  • func (c *Client) GetCgroupsRootPath() string
  • func (c *Client) IsDefaultHierarchy(hierarchyID uint32) bool
  • func (c *Client) LoadCgroup(id ID, path string)
• type ContainerRuntimeID
  • func FromString(str string) ContainerRuntimeID
  • func GetContainerIdFromCgroup(cgroupPath string) (string, ContainerRuntimeID)
  • func (runtime ContainerRuntimeID) String() string
• type ID
• type IOStat
• type MemoryStat
• type Version
  • func (v Version) String() string

Constants

const (
	V1 = iota
	V2
)

Variables

var (
	ErrContainerIDNotFoundInCgroupPath = errors.New("container id not found in cgroup path")
	ErrCgroupNotFound                  = errors.New("cgroup not found")
)

Functions

func Init

func Init() error

Types

type CPUStat

type CPUStat struct {
	UsageSeconds         float64
	ThrottledTimeSeconds float64
	LimitCores           float64
}

type Cgroup

type Cgroup struct {
	Id               uint64
	Version          Version
	ContainerRuntime ContainerRuntimeID
	ContainerID      string
	Path             string
	// contains filtered or unexported fields
}

func NewFromProcessCgroupFile

func NewFromProcessCgroupFile(filePath string) (*Cgroup, error)

func (Cgroup) CpuStat

func (cg Cgroup) CpuStat() (*CPUStat, error)

func (*Cgroup) CreatedAt

func (cg *Cgroup) CreatedAt() time.Time

func (*Cgroup) IOStat

func (cg *Cgroup) IOStat() (map[string]IOStat, error)

func (*Cgroup) MemoryStat

func (cg *Cgroup) MemoryStat() (*MemoryStat, error)

type Client

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

func NewClient

func NewClient(log *logging.Logger, root string) (*Client, error)

func (*Client) CleanupCgroup

func (c *Client) CleanupCgroup(id ID)

func (*Client) DefaultCgroupVersion

func (c *Client) DefaultCgroupVersion() Version

func (*Client) GetCgroupForID

func (c *Client) GetCgroupForID(cgroupID ID) (*Cgroup, error)

func (*Client) GetCgroupsRootPath

func (c *Client) GetCgroupsRootPath() string

func (*Client) IsDefaultHierarchy

func (c *Client) IsDefaultHierarchy(hierarchyID uint32) bool

func (*Client) LoadCgroup

func (c *Client) LoadCgroup(id ID, path string)

type ContainerRuntimeID

type ContainerRuntimeID int

Represents the internal ID of a container runtime

const (
	UnknownRuntime ContainerRuntimeID = iota
	DockerRuntime
	ContainerdRuntime
	CrioRuntime
	PodmanRuntime
	GardenRuntime
)

func FromString

func FromString(str string) ContainerRuntimeID

func GetContainerIdFromCgroup

func GetContainerIdFromCgroup(cgroupPath string) (string, ContainerRuntimeID)

GetContainerIdFromCgroup extracts container id and its runtime from path. It returns the container id and the used runtime.

func (ContainerRuntimeID) String

func (runtime ContainerRuntimeID) String() string

type ID

type ID = uint64

type IOStat

type IOStat struct {
	ReadOps      uint64
	WriteOps     uint64
	ReadBytes    uint64
	WrittenBytes uint64
}

type MemoryStat

type MemoryStat struct {
	RSS   uint64
	Cache uint64
	Limit uint64
}

type Version

type Version uint8

func (Version) String

func (v Version) String() string