1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
|
package cgroups
import (
"fmt"
"hash/crc32"
"os/exec"
"path/filepath"
"strings"
"time"
"github.com/containerd/cgroups/v3/cgroup1"
specs "github.com/opencontainers/runtime-spec/specs-go"
"github.com/prometheus/client_golang/prometheus"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
cgroupscfg "gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config/cgroups"
"gitlab.com/gitlab-org/gitaly/v16/internal/log"
)
// cfs_period_us hardcoded to be 100ms.
const cfsPeriodUs uint64 = 100000
// CGroupV1Manager is the manager for cgroups v1
type CGroupV1Manager struct {
cfg cgroupscfg.Config
hierarchy func() ([]cgroup1.Subsystem, error)
memoryReclaimAttemptsTotal *prometheus.GaugeVec
cpuUsage *prometheus.GaugeVec
cpuCFSPeriods *prometheus.Desc
cpuCFSThrottledPeriods *prometheus.Desc
cpuCFSThrottledTime *prometheus.Desc
procs *prometheus.GaugeVec
pid int
}
func newV1Manager(cfg cgroupscfg.Config, pid int) *CGroupV1Manager {
return &CGroupV1Manager{
cfg: cfg,
pid: pid,
hierarchy: func() ([]cgroup1.Subsystem, error) {
return defaultSubsystems(cfg.Mountpoint)
},
memoryReclaimAttemptsTotal: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "gitaly_cgroup_memory_reclaim_attempts_total",
Help: "Number of memory usage hits limits",
},
[]string{"path"},
),
cpuUsage: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "gitaly_cgroup_cpu_usage_total",
Help: "CPU Usage of Cgroup",
},
[]string{"path", "type"},
),
cpuCFSPeriods: prometheus.NewDesc(
"gitaly_cgroup_cpu_cfs_periods_total",
"Number of elapsed enforcement period intervals",
[]string{"path"}, nil,
),
cpuCFSThrottledPeriods: prometheus.NewDesc(
"gitaly_cgroup_cpu_cfs_throttled_periods_total",
"Number of throttled period intervals",
[]string{"path"}, nil,
),
cpuCFSThrottledTime: prometheus.NewDesc(
"gitaly_cgroup_cpu_cfs_throttled_seconds_total",
"Total time duration the Cgroup has been throttled",
[]string{"path"}, nil,
),
procs: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: "gitaly_cgroup_procs_total",
Help: "Total number of procs",
},
[]string{"path", "subsystem"},
),
}
}
//nolint:revive // This is unintentionally missing documentation.
func (cg *CGroupV1Manager) Setup() error {
cfsPeriodUs := cfsPeriodUs
var parentResources specs.LinuxResources
// Leave them `nil` so it takes kernel default unless cfg value above `0`.
parentResources.CPU = &specs.LinuxCPU{}
if cg.cfg.CPUShares > 0 {
parentResources.CPU.Shares = &cg.cfg.CPUShares
}
if cg.cfg.CPUQuotaUs > 0 {
parentResources.CPU.Quota = &cg.cfg.CPUQuotaUs
parentResources.CPU.Period = &cfsPeriodUs
}
if cg.cfg.MemoryBytes > 0 {
parentResources.Memory = &specs.LinuxMemory{Limit: &cg.cfg.MemoryBytes}
}
if _, err := cgroup1.New(
cgroup1.StaticPath(cg.currentProcessCgroup()),
&parentResources,
cgroup1.WithHiearchy(cg.hierarchy),
); err != nil {
return fmt.Errorf("failed creating parent cgroup: %w", err)
}
var reposResources specs.LinuxResources
// Leave them `nil` so it takes kernel default unless cfg value above `0`.
reposResources.CPU = &specs.LinuxCPU{}
if cg.cfg.Repositories.CPUShares > 0 {
reposResources.CPU.Shares = &cg.cfg.Repositories.CPUShares
}
if cg.cfg.Repositories.CPUQuotaUs > 0 {
reposResources.CPU.Quota = &cg.cfg.Repositories.CPUQuotaUs
reposResources.CPU.Period = &cfsPeriodUs
}
if cg.cfg.Repositories.MemoryBytes > 0 {
reposResources.Memory = &specs.LinuxMemory{Limit: &cg.cfg.Repositories.MemoryBytes}
}
for i := 0; i < int(cg.cfg.Repositories.Count); i++ {
if _, err := cgroup1.New(
cgroup1.StaticPath(cg.repoPath(i)),
&reposResources,
cgroup1.WithHiearchy(cg.hierarchy),
); err != nil {
return fmt.Errorf("failed creating repository cgroup: %w", err)
}
}
return nil
}
// AddCommand adds the given command to one of the CGroup's buckets. The bucket used for the command
// is determined by hashing the repository storage and path. No error is returned if the command has already
// exited.
func (cg *CGroupV1Manager) AddCommand(
cmd *exec.Cmd,
opts ...AddCommandOption,
) (string, error) {
var cfg addCommandCfg
for _, opt := range opts {
opt(&cfg)
}
key := cfg.cgroupKey
if key == "" {
key = strings.Join(cmd.Args, "/")
}
checksum := crc32.ChecksumIEEE(
[]byte(key),
)
if cmd.Process == nil {
return "", fmt.Errorf("cannot add command that has not yet been started")
}
groupID := uint(checksum) % cg.cfg.Repositories.Count
cgroupPath := cg.repoPath(int(groupID))
return cgroupPath, cg.addToCgroup(cmd.Process.Pid, cgroupPath)
}
func (cg *CGroupV1Manager) addToCgroup(pid int, cgroupPath string) error {
control, err := cgroup1.Load(
cgroup1.StaticPath(cgroupPath),
cgroup1.WithHiearchy(cg.hierarchy),
)
if err != nil {
return fmt.Errorf("failed loading %s cgroup: %w", cgroupPath, err)
}
if err := control.Add(cgroup1.Process{Pid: pid}); err != nil {
// Command could finish so quickly before we can add it to a cgroup, so
// we don't consider it an error.
if strings.Contains(err.Error(), "no such process") {
return nil
}
return fmt.Errorf("failed adding process to cgroup: %w", err)
}
return nil
}
// Collect collects metrics from the cgroups controller
func (cg *CGroupV1Manager) Collect(ch chan<- prometheus.Metric) {
if !cg.cfg.MetricsEnabled {
return
}
for i := 0; i < int(cg.cfg.Repositories.Count); i++ {
repoPath := cg.repoPath(i)
logger := log.Default().WithField("cgroup_path", repoPath)
control, err := cgroup1.Load(
cgroup1.StaticPath(repoPath),
cgroup1.WithHiearchy(cg.hierarchy),
)
if err != nil {
logger.WithError(err).Warn("unable to load cgroup controller")
return
}
if metrics, err := control.Stat(); err != nil {
logger.WithError(err).Warn("unable to get cgroup stats")
} else {
memoryMetric := cg.memoryReclaimAttemptsTotal.WithLabelValues(repoPath)
memoryMetric.Set(float64(metrics.Memory.Usage.Failcnt))
ch <- memoryMetric
cpuUserMetric := cg.cpuUsage.WithLabelValues(repoPath, "user")
cpuUserMetric.Set(float64(metrics.CPU.Usage.User))
ch <- cpuUserMetric
ch <- prometheus.MustNewConstMetric(
cg.cpuCFSPeriods,
prometheus.CounterValue,
float64(metrics.CPU.Throttling.Periods),
repoPath,
)
ch <- prometheus.MustNewConstMetric(
cg.cpuCFSThrottledPeriods,
prometheus.CounterValue,
float64(metrics.CPU.Throttling.ThrottledPeriods),
repoPath,
)
ch <- prometheus.MustNewConstMetric(
cg.cpuCFSThrottledTime,
prometheus.CounterValue,
float64(metrics.CPU.Throttling.ThrottledTime)/float64(time.Second),
repoPath,
)
cpuKernelMetric := cg.cpuUsage.WithLabelValues(repoPath, "kernel")
cpuKernelMetric.Set(float64(metrics.CPU.Usage.Kernel))
ch <- cpuKernelMetric
}
if subsystems, err := cg.hierarchy(); err != nil {
logger.WithError(err).Warn("unable to get cgroup hierarchy")
} else {
for _, subsystem := range subsystems {
processes, err := control.Processes(subsystem.Name(), true)
if err != nil {
logger.WithField("subsystem", subsystem.Name()).
WithError(err).
Warn("unable to get process list")
continue
}
procsMetric := cg.procs.WithLabelValues(repoPath, string(subsystem.Name()))
procsMetric.Set(float64(len(processes)))
ch <- procsMetric
}
}
}
}
// Describe describes the cgroup metrics that Collect provides
func (cg *CGroupV1Manager) Describe(ch chan<- *prometheus.Desc) {
prometheus.DescribeByCollect(cg, ch)
}
//nolint:revive // This is unintentionally missing documentation.
func (cg *CGroupV1Manager) Cleanup() error {
processCgroupPath := cg.currentProcessCgroup()
control, err := cgroup1.Load(
cgroup1.StaticPath(processCgroupPath),
cgroup1.WithHiearchy(cg.hierarchy),
)
if err != nil {
return fmt.Errorf("failed loading cgroup %s: %w", processCgroupPath, err)
}
if err := control.Delete(); err != nil {
return fmt.Errorf("failed cleaning up cgroup %s: %w", processCgroupPath, err)
}
return nil
}
func (cg *CGroupV1Manager) repoPath(groupID int) string {
return filepath.Join(cg.currentProcessCgroup(), fmt.Sprintf("repos-%d", groupID))
}
func (cg *CGroupV1Manager) currentProcessCgroup() string {
return config.GetGitalyProcessTempDir(cg.cfg.HierarchyRoot, cg.pid)
}
func defaultSubsystems(root string) ([]cgroup1.Subsystem, error) {
subsystems := []cgroup1.Subsystem{
cgroup1.NewMemory(root, cgroup1.OptionalSwap()),
cgroup1.NewCpu(root),
}
return subsystems, nil
}
|