cgroup

Documentation

Index

• Constants
• Variables
• func StatPSI(dirPath string, file string) (*castaipb.PSIStats, error)
• type Cgroup
  • func (cg *Cgroup) GetStats() (Stats, error)
• type Client
  • func NewClient(log *logging.Logger, root string, psiEnabled bool) (*Client, error)
  • func (c *Client) CleanupCgroup(id ID)
  • func (c *Client) DefaultCgroupVersion() Version
  • func (c *Client) GetCgroupByContainerID(containerID string) (*Cgroup, error)
  • func (c *Client) GetCgroupByID(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 Stats
• type Version
  • func (v Version) String() string

Constants

const (
	V1 = iota
	V2
)

const UnifiedMountpoint = "/sys/fs/cgroup"

Variables

var (
	ErrCgroupNotFound = errors.New("cgroup not found")
)

var ErrStatsNotFound = errors.New("stats not found")

Functions

func StatPSI

func StatPSI(dirPath string, file string) (*castaipb.PSIStats, error)

Types

type Cgroup

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

func (*Cgroup) GetStats

func (cg *Cgroup) GetStats() (Stats, error)

type Client

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

func NewClient

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

func (*Client) CleanupCgroup

func (c *Client) CleanupCgroup(id ID)

func (*Client) DefaultCgroupVersion

func (c *Client) DefaultCgroupVersion() Version

func (*Client) GetCgroupByContainerID

func (c *Client) GetCgroupByContainerID(containerID string) (*Cgroup, error)

func (*Client) GetCgroupByID

func (c *Client) GetCgroupByID(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 Stats

type Stats struct {
	CpuStats    *castaipb.CpuStats
	MemoryStats *castaipb.MemoryStats
	PidsStats   *castaipb.PidsStats
	IOStats     *castaipb.IOStats
}

type Version

type Version uint8

func (Version) String

func (v Version) String() string