cgroups package for Go
Go package for creating, managing, inspecting, and destroying cgroups. The resources format for settings on the cgroup uses the OCI runtime-spec found here.
This creates a new cgroup using a static path for all subsystems under
/test.
It uses a single hierarchy and specifies cpu shares as a resource constraint and uses the v1 implementation of cgroups.
shares := uint64(100) control, err := cgroups.New(cgroups.V1, cgroups.StaticPath("/test"), &specs.LinuxResources{ CPU: &specs.CPU{ Shares: &shares, }, }) defer control.Delete()
control, err := cgroups.New(cgroups.Systemd, cgroups.Slice("system.slice", "runc-test"), &specs.LinuxResources{ CPU: &specs.CPU{ Shares: &shares, }, })
control, err = cgroups.Load(cgroups.V1, cgroups.StaticPath("/test"))
if err := control.Add(cgroups.Process{Pid:1234}); err != nil { }
To update the resources applied in the cgroup
shares = uint64(200) if err := control.Update(&specs.LinuxResources{ CPU: &specs.LinuxCPU{ Shares: &shares, }, }); err != nil { }
if err := control.Freeze(); err != nil { } if err := control.Thaw(); err != nil { }
processes, err := control.Processes(cgroups.Devices, recursive)
stats, err := control.Stat()
By adding
cgroups.IgnoreNotExistall non-existent files will be ignored, e.g. swap memory stats without swap enabled
go stats, err := control.Stat(cgroups.IgnoreNotExist)
This allows you to take processes from one cgroup and move them to another.
err := control.MoveTo(destination)
subCgroup, err := control.New("child", resources)
This allows you to get notified by an eventfd for v1 memory cgroups events.
event := cgroups.MemoryThresholdEvent(50 * 1024 * 1024, false) efd, err := control.RegisterMemoryEvent(event)
event := cgroups.MemoryPressureEvent(cgroups.MediumPressure, cgroups.DefaultMode) efd, err := control.RegisterMemoryEvent(event)
efd, err := control.OOMEventFD() // or by using RegisterMemoryEvent event := cgroups.OOMEvent() efd, err := control.RegisterMemoryEvent(event)
All static path should not include
/sys/fs/cgroup/prefix, it should start with your own cgroups name
Cgroups is a containerd sub-project, licensed under the Apache 2.0 license. As a containerd sub-project, you will find the:
containerd/projectrepository.