diff --git a/agent/cpu.go b/agent/cpu.go index 8ac0c2e9c..ce7fb39f4 100644 --- a/agent/cpu.go +++ b/agent/cpu.go @@ -30,11 +30,20 @@ type CpuMetrics struct { Iowait float64 Steal float64 Idle float64 + // fromCgroup is set when Total comes from cgroup accounting (LXC) rather + // than /proc/stat, so per-core /proc/stat usage would not match it. + fromCgroup bool } // getCpuMetrics calculates detailed CPU usage metrics using cached previous measurements. // It returns percentages for total, user, system, iowait, and steal time. func getCpuMetrics(cacheTimeMs uint16) (CpuMetrics, error) { + // Inside LXC, lxcfs serves /proc/stat with the host cores' counters, not + // the guest's own usage. Prefer the cgroup's CPU accounting there. (#2332) + if metrics, ok := containerCpuMetrics(cacheTimeMs); ok { + metrics.fromCgroup = true + return metrics, nil + } times, err := cpu.Times(false) if err != nil || len(times) == 0 { return CpuMetrics{}, err diff --git a/agent/cpu_linux.go b/agent/cpu_linux.go new file mode 100644 index 000000000..a50d5059b --- /dev/null +++ b/agent/cpu_linux.go @@ -0,0 +1,372 @@ +//go:build linux + +package agent + +import ( + "os" + "path/filepath" + "runtime" + "strconv" + "strings" + "sync" + "time" + + "github.com/henrygd/beszel/agent/utils" +) + +// LXC-aware CPU accounting (issue #2332). +// +// Inside an LXC guest, lxcfs serves /proc/stat with the raw counters of the +// host cores in the guest's cpuset, not the guest's own usage. An idle guest +// sharing a host core with a busy neighbor then reports near-100% CPU while +// doing nothing. The cgroup's own accounting (cpu.stat / cpuacct.usage) +// reflects only the guest's processes, so inside LXC we derive CPU% from that +// instead. +// +// Other runtimes (Docker, Podman, k8s) are deliberately left alone: the agent +// is normally deployed there to monitor the host, and the host's /proc/stat is +// exactly what it should report. + +// File paths and hooks are variables so tests can point them at fixtures. +var ( + cpuCgroupRoot = "/sys/fs/cgroup" // default cgroup v2 mount point + cpuCgroupMountinfo = "/proc/self/mountinfo" + cpuProcSelfCgroup = "/proc/self/cgroup" + cpuSystemdContPath = "/run/systemd/container" + cpuNumCPU = runtime.NumCPU + cpuNow = time.Now +) + +// cpuUserHZ is the USER_HZ jiffies-per-second rate cpuacct.stat reports in. +const cpuUserHZ = 100 + +// inLxc reports whether the agent itself runs inside an LXC guest. +// The result is cached because it cannot change during the process lifetime. +var inLxc = sync.OnceValue(detectLxc) + +// detectLxc looks for LXC guest markers that are readable without root +// (the agent usually runs as an unprivileged user, so /proc/1/environ is not). +func detectLxc() bool { + // lxcfs mounted over /proc/stat is the direct cause of the host-core + // counters. Only match that mount point: an LXC host also has lxcfs + // mounted, but at /var/lib/lxcfs. + if data, err := os.ReadFile(cpuCgroupMountinfo); err == nil && procStatFromLxcfs(data) { + return true + } + // set by liblxc for the container init and inherited on non-systemd guests + if os.Getenv("container") == "lxc" { + return true + } + // written by systemd on systemd-based guests + if data, err := os.ReadFile(cpuSystemdContPath); err == nil && + strings.TrimSpace(string(data)) == "lxc" { + return true + } + return false +} + +// procStatFromLxcfs reports whether mountinfo shows lxcfs mounted on /proc/stat. +func procStatFromLxcfs(mountinfo []byte) bool { + for line := range strings.SplitSeq(string(mountinfo), "\n") { + left, right, found := strings.Cut(line, " - ") + if !found { + continue + } + fields, post := strings.Fields(left), strings.Fields(right) + if len(fields) >= 5 && len(post) > 0 && fields[4] == "/proc/stat" && post[0] == "fuse.lxcfs" { + return true + } + } + return false +} + +// cgroupCpuSample is one read of the container's cumulative CPU accounting. +type cgroupCpuSample struct { + usageUsec uint64 + userUsec uint64 + systemUsec uint64 + cores float64 // usable CPU cores: affinity ∩ cpuset ∩ quota + at time.Time +} + +var lastCgroupCpuSamples = make(map[uint16]cgroupCpuSample) + +// init seeds the LXC CPU baseline so the first reported value is a real +// delta since startup rather than zero. +func init() { + if !inLxc() { + return + } + if s, ok := readContainerCpuSample(); ok { + s.at = cpuNow() + lastCgroupCpuSamples[60000] = s + } +} + +// containerCpuMetrics derives CPU metrics from the guest's own cgroup +// accounting when running inside LXC. It returns ok=false everywhere else and +// whenever cgroup accounting is unreadable, so callers keep the /proc/stat +// path. +func containerCpuMetrics(cacheTimeMs uint16) (CpuMetrics, bool) { + if !inLxc() { + return CpuMetrics{}, false + } + cur, ok := readContainerCpuSample() + if !ok { + return CpuMetrics{}, false + } + cur.at = cpuNow() + + prev, ok := lastCgroupCpuSamples[cacheTimeMs] + if !ok { + prev = lastCgroupCpuSamples[60000] + } + lastCgroupCpuSamples[cacheTimeMs] = cur + + // No baseline yet, a backwards counter (cgroup recreated), or a + // non-positive clock delta: report zero this tick instead of guessing. + elapsedUsec := cur.at.Sub(prev.at).Microseconds() + if prev.at.IsZero() || elapsedUsec <= 0 || cur.usageUsec < prev.usageUsec { + return CpuMetrics{}, true + } + + cores := cur.cores + if cores <= 0 { + cores = 1 + } + window := float64(elapsedUsec) * cores + + metrics := CpuMetrics{ + Total: clampPercent(float64(cur.usageUsec-prev.usageUsec) / window * 100), + User: clampPercent(float64(cur.userUsec-prev.userUsec) / window * 100), + System: clampPercent(float64(cur.systemUsec-prev.systemUsec) / window * 100), + } + // cgroup accounting has no iowait/steal; everything not busy is idle. + metrics.Idle = clampPercent(100 - metrics.Total) + return metrics, true +} + +// readContainerCpuSample reads the container's cumulative CPU usage, preferring +// the cgroup v2 unified hierarchy and falling back to the v1 cpuacct +// controller. +func readContainerCpuSample() (cgroupCpuSample, bool) { + if s, ok := readCgroupV2CpuSample(); ok { + return s, true + } + return readCgroupV1CpuSample() +} + +// readCgroupV2CpuSample reads usage from the unified hierarchy's cpu.stat. +// +// The mount root is always the cgroup to read: an LXC guest has a private +// cgroup namespace, so /sys/fs/cgroup already is the guest's root cgroup, and +// its cpu.stat accounts for every process in the guest. The agent's own path +// in /proc/self/cgroup (its service cgroup, or the ".lxc" leaf when started +// from an attached shell) only covers a subset and must not be descended into. +func readCgroupV2CpuSample() (cgroupCpuSample, bool) { + if !inCgroupV2() { + return cgroupCpuSample{}, false // no v2 membership; try v1 + } + dir := cpuCgroupRoot + if mount := cgroupMountPoint("cgroup2", ""); mount != "" { + dir = mount + } + stat := filepath.Join(dir, "cpu.stat") + usage, ok := cgroupStatValue(stat, "usage_usec") + if !ok { + return cgroupCpuSample{}, false + } + s := cgroupCpuSample{usageUsec: usage, cores: cpuCgroupCores(dir)} + s.userUsec, _ = cgroupStatValue(stat, "user_usec") + s.systemUsec, _ = cgroupStatValue(stat, "system_usec") + return s, true +} + +// readCgroupV1CpuSample reads usage from the legacy cpuacct controller. +// As with v2, the hierarchy mount root is the guest's own cgroup and its +// accounting includes every child cgroup, so it is read directly rather than +// the agent's own sub-cgroup. +func readCgroupV1CpuSample() (cgroupCpuSample, bool) { + dir := cgroupMountPoint("cgroup", "cpuacct") + if dir == "" { + return cgroupCpuSample{}, false + } + usageNs, ok := utils.ReadUintFile(filepath.Join(dir, "cpuacct.usage")) + if !ok { + return cgroupCpuSample{}, false + } + s := cgroupCpuSample{usageUsec: usageNs / 1000, cores: cpuCgroupCores(dir)} + // cpuacct.stat reports user/system in USER_HZ jiffies. + if v, ok := cgroupStatValue(filepath.Join(dir, "cpuacct.stat"), "user"); ok { + s.userUsec = v * 1e6 / cpuUserHZ + } + if v, ok := cgroupStatValue(filepath.Join(dir, "cpuacct.stat"), "system"); ok { + s.systemUsec = v * 1e6 / cpuUserHZ + } + return s, true +} + +// inCgroupV2 reports whether /proc/self/cgroup lists the v2 unified hierarchy +// (a "0::" entry). +func inCgroupV2() bool { + data, err := os.ReadFile(cpuProcSelfCgroup) + if err != nil { + return false + } + for line := range strings.SplitSeq(string(data), "\n") { + if strings.HasPrefix(line, "0::") { + return true + } + } + return false +} + +// cgroupMountPoint returns the mount point of a cgroup hierarchy from +// /proc/self/mountinfo: the cgroup2 mount for v2, or the cgroup mount whose +// super options list the wanted v1 controller. +func cgroupMountPoint(fstype, v1ctrl string) string { + data, err := os.ReadFile(cpuCgroupMountinfo) + if err != nil { + return "" + } + for _, line := range strings.Split(string(data), "\n") { + left, right, found := strings.Cut(line, " - ") + if !found { + continue + } + post := strings.Fields(right) + if len(post) == 0 || post[0] != fstype { + continue + } + if v1ctrl != "" && !mountOptHas(post, v1ctrl) { + continue + } + fields := strings.Fields(left) + if len(fields) >= 5 { + return unescapeMountPoint(fields[4]) + } + } + return "" +} + +// mountOptHas reports whether the comma-separated super options (field 3 after +// the " - " separator) contain opt. +func mountOptHas(post []string, opt string) bool { + if len(post) < 3 { + return false + } + for _, o := range strings.Split(post[2], ",") { + if o == opt { + return true + } + } + return false +} + +// unescapeMountPoint decodes octal escapes (e.g. \040 for space) used in +// mountinfo paths. +func unescapeMountPoint(s string) string { + return strings.NewReplacer(`\040`, " ", `\011`, "\t", `\012`, "\n", `\134`, `\`).Replace(s) +} + +// cpuCgroupCores returns how many CPU cores the cgroup at dir may use: the +// smallest of the process affinity mask, the cgroup cpuset, and the CPU quota. +func cpuCgroupCores(dir string) float64 { + cores := float64(cpuNumCPU()) + if n := cpusetCount(dir); n > 0 && n < cores { + cores = n + } + if q, ok := cpuQuotaCores(dir); ok && q < cores { + cores = q + } + if cores <= 0 { + cores = 1 + } + return cores +} + +// cpusetCount returns the number of CPUs in the cgroup's cpuset, e.g. "0-3" or +// "2,5-7". An empty or missing file means unconstrained. +func cpusetCount(dir string) float64 { + for _, name := range []string{"cpuset.cpus.effective", "cpuset.cpus"} { + raw, err := os.ReadFile(filepath.Join(dir, name)) + if err != nil { + continue + } + if n := countCpuList(strings.TrimSpace(string(raw))); n > 0 { + return float64(n) + } + } + return 0 +} + +// countCpuList counts the CPUs in a Linux CPU list like "0-3,5,8-9". +func countCpuList(list string) int { + total := 0 + for part := range strings.SplitSeq(list, ",") { + lo, hi, ranged := strings.Cut(part, "-") + a, err := strconv.Atoi(lo) + if err != nil { + continue + } + b := a + if ranged { + if v, err := strconv.Atoi(hi); err == nil { + b = v + } + } + if b >= a { + total += b - a + 1 + } + } + return total +} + +// cpuQuotaCores returns the cgroup's CPU quota in cores. v2 uses cpu.max +// (" "), v1 uses cpu.cfs_quota_us / cpu.cfs_period_us. +func cpuQuotaCores(dir string) (float64, bool) { + if raw, err := os.ReadFile(filepath.Join(dir, "cpu.max")); err == nil { + fields := strings.Fields(string(raw)) + if len(fields) == 2 && fields[0] != "max" { + if quota, err := strconv.ParseFloat(fields[0], 64); err == nil && quota > 0 { + if period, err := strconv.ParseFloat(fields[1], 64); err == nil && period > 0 { + return quota / period, true + } + } + } + } + if quota, ok := readCgroupInt(filepath.Join(dir, "cpu.cfs_quota_us")); ok && quota > 0 { + if period, ok := readCgroupInt(filepath.Join(dir, "cpu.cfs_period_us")); ok && period > 0 { + return float64(quota) / float64(period), true + } + } + return 0, false +} + +// cgroupStatValue returns the value of key in a cgroup "key value" stat file. +func cgroupStatValue(path, key string) (uint64, bool) { + data, err := os.ReadFile(path) + if err != nil { + return 0, false + } + for line := range strings.SplitSeq(string(data), "\n") { + name, value, found := strings.Cut(line, " ") + if !found || name != key { + continue + } + v, err := strconv.ParseUint(strings.TrimSpace(value), 10, 64) + return v, err == nil + } + return 0, false +} + +// readCgroupInt reads a file containing a single signed integer +// (cpu.cfs_quota_us is -1 when no quota is set). +func readCgroupInt(path string) (int64, bool) { + data, err := os.ReadFile(path) + if err != nil { + return 0, false + } + v, err := strconv.ParseInt(strings.TrimSpace(string(data)), 10, 64) + return v, err == nil +} diff --git a/agent/cpu_linux_test.go b/agent/cpu_linux_test.go new file mode 100644 index 000000000..337ad76b1 --- /dev/null +++ b/agent/cpu_linux_test.go @@ -0,0 +1,350 @@ +//go:build testing && linux + +package agent + +import ( + "os" + "path/filepath" + "sync" + "testing" + "time" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// swapCpuContainerSeams points every container-detection and cgroup path at +// empty fixtures under a temp dir, then restores them on cleanup. +func swapCpuContainerSeams(t *testing.T) { + t.Helper() + backup := struct { + root, mountinfo, selfCgroup, systemdCont string + numCPU func() int + now func() time.Time + }{ + cpuCgroupRoot, cpuCgroupMountinfo, cpuProcSelfCgroup, cpuSystemdContPath, cpuNumCPU, cpuNow, + } + origInLxc := inLxc + samples := lastCgroupCpuSamples + env, hadEnv := os.LookupEnv("container") + t.Cleanup(func() { + cpuCgroupRoot, cpuCgroupMountinfo, cpuProcSelfCgroup, cpuSystemdContPath = backup.root, backup.mountinfo, backup.selfCgroup, backup.systemdCont + cpuNumCPU, cpuNow = backup.numCPU, backup.now + inLxc = origInLxc + lastCgroupCpuSamples = samples + if hadEnv { + os.Setenv("container", env) + } + }) + + inLxc = sync.OnceValue(detectLxc) + lastCgroupCpuSamples = make(map[uint16]cgroupCpuSample) + os.Unsetenv("container") + + tmp := t.TempDir() + cpuCgroupRoot = filepath.Join(tmp, "cgroup") + cpuCgroupMountinfo = filepath.Join(tmp, "mountinfo") + cpuProcSelfCgroup = filepath.Join(tmp, "self-cgroup") + cpuSystemdContPath = filepath.Join(tmp, "systemd-container") +} + +func writeCpuFixture(t *testing.T, path, contents string) { + t.Helper() + require.NoError(t, os.MkdirAll(filepath.Dir(path), 0o755)) + require.NoError(t, os.WriteFile(path, []byte(contents), 0o644)) +} + +// markLxc makes detection see a systemd-based LXC guest. +func markLxc(t *testing.T) { + t.Helper() + writeCpuFixture(t, cpuSystemdContPath, "lxc\n") +} + +// fakeNow installs a controllable clock and returns a function to advance it. +func fakeNow(t *testing.T) func(time.Duration) { + t.Helper() + cur := time.Unix(1_700_000_000, 0) + cpuNow = func() time.Time { return cur } + return func(d time.Duration) { cur = cur.Add(d) } +} + +func TestDetectLxc(t *testing.T) { + tests := []struct { + name string + setup func(t *testing.T) + want bool + }{ + {"plain host", func(t *testing.T) {}, false}, + {"container env lxc", func(t *testing.T) { t.Setenv("container", "lxc") }, true}, + {"container env podman", func(t *testing.T) { t.Setenv("container", "podman") }, false}, + {"systemd container lxc", func(t *testing.T) { writeCpuFixture(t, cpuSystemdContPath, "lxc\n") }, true}, + {"systemd container nspawn", func(t *testing.T) { writeCpuFixture(t, cpuSystemdContPath, "systemd-nspawn\n") }, false}, + {"lxcfs serving /proc/stat", func(t *testing.T) { + writeCpuFixture(t, cpuCgroupMountinfo, + "31 25 0:28 / /proc/stat rw,nosuid,nodev,relatime - fuse.lxcfs lxcfs rw,user_id=0,group_id=0\n") + }, true}, + // an LXC host (e.g. Proxmox) mounts lxcfs too, but not over its own /proc + {"lxcfs mounted on host", func(t *testing.T) { + writeCpuFixture(t, cpuCgroupMountinfo, + "45 25 0:40 / /var/lib/lxcfs rw,nosuid,nodev,relatime - fuse.lxcfs lxcfs rw,user_id=0,group_id=0\n") + }, false}, + {"cgroup-only mountinfo", func(t *testing.T) { + writeCpuFixture(t, cpuCgroupMountinfo, + "36 25 0:32 / /sys/fs/cgroup rw - cgroup2 cgroup2 rw,nsdelegate\n") + }, false}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + swapCpuContainerSeams(t) + tt.setup(t) + assert.Equal(t, tt.want, detectLxc()) + }) + } +} + +func TestReadCgroupV2CpuSample(t *testing.T) { + swapCpuContainerSeams(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + require.NoError(t, os.MkdirAll(cpuCgroupRoot, 0o755)) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), + "usage_usec 3000000\nuser_usec 2000000\nsystem_usec 1000000\nnr_throttled 7\n") + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpuset.cpus.effective"), "2,5-7\n") + cpuNumCPU = func() int { return 8 } + + s, ok := readCgroupV2CpuSample() + require.True(t, ok) + assert.EqualValues(t, 3000000, s.usageUsec) + assert.EqualValues(t, 2000000, s.userUsec) + assert.EqualValues(t, 1000000, s.systemUsec) + assert.InDelta(t, 4, s.cores, 0.001) // cpuset 2,5-7 = 4 cores +} + +// The agent may sit in a sub-cgroup of the guest (a systemd service, or the +// ".lxc" leaf when started from an attached shell); the mount root still +// accounts for the whole guest and must win. +func TestReadCgroupV2PrefersContainerRoot(t *testing.T) { + for _, rel := range []string{"system.slice/beszel-agent.service", ".lxc"} { + t.Run(rel, func(t *testing.T) { + swapCpuContainerSeams(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/"+rel+"\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 9000\n") + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, rel, "cpu.stat"), "usage_usec 5\n") + + s, ok := readCgroupV2CpuSample() + require.True(t, ok) + assert.EqualValues(t, 9000, s.usageUsec) + }) + } +} + +// Same for v1: the cpuacct mount root covers the agent's sibling services. +func TestReadCgroupV1PrefersContainerRoot(t *testing.T) { + swapCpuContainerSeams(t) + writeCpuFixture(t, cpuProcSelfCgroup, "3:cpu,cpuacct:/system.slice/beszel-agent.service\n") + v1 := filepath.Join(t.TempDir(), "cpu,cpuacct") + writeCpuFixture(t, cpuCgroupMountinfo, + "30 25 0:26 / "+v1+" rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,cpu,cpuacct\n") + writeCpuFixture(t, filepath.Join(v1, "cpuacct.usage"), "9000000\n") + writeCpuFixture(t, filepath.Join(v1, "system.slice/beszel-agent.service/cpuacct.usage"), "5000\n") + + s, ok := readContainerCpuSample() + require.True(t, ok) + assert.EqualValues(t, 9000, s.usageUsec) +} + +func TestReadCgroupV1CpuSample(t *testing.T) { + swapCpuContainerSeams(t) + writeCpuFixture(t, cpuProcSelfCgroup, "3:cpuacct:/\n2:memory:/\n") + v1 := filepath.Join(t.TempDir(), "cpuacct") + writeCpuFixture(t, cpuCgroupMountinfo, + "30 25 0:26 / "+v1+" rw,nosuid,nodev,noexec,relatime - cgroup cgroup rw,cpuacct\n") + writeCpuFixture(t, filepath.Join(v1, "cpuacct.usage"), "2000000000\n") + writeCpuFixture(t, filepath.Join(v1, "cpuacct.stat"), "user 100\nsystem 50\n") + cpuNumCPU = func() int { return 4 } + + s, ok := readContainerCpuSample() // no 0:: line -> falls through to v1 + require.True(t, ok) + assert.EqualValues(t, 2000000, s.usageUsec) // ns -> usec + assert.EqualValues(t, 1000000, s.userUsec) // 100 jiffies * 1e6/100 + assert.EqualValues(t, 500000, s.systemUsec) // 50 jiffies + assert.InDelta(t, 4, s.cores, 0.001) +} + +func TestContainerCpuMetricsMath(t *testing.T) { + swapCpuContainerSeams(t) + markLxc(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + require.NoError(t, os.MkdirAll(cpuCgroupRoot, 0o755)) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpuset.cpus.effective"), "0-3\n") + cpuNumCPU = func() int { return 8 } + advance := fakeNow(t) + + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), + "usage_usec 1000000\nuser_usec 600000\nsystem_usec 400000\n") + m, ok := containerCpuMetrics(60000) + require.True(t, ok) + assert.Zero(t, m.Total) // first call only seeds the baseline + + // 1s elapsed, container burned 2 core-seconds on 4 usable cores + advance(time.Second) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), + "usage_usec 3000000\nuser_usec 1600000\nsystem_usec 900000\n") + m, ok = containerCpuMetrics(60000) + require.True(t, ok) + assert.InDelta(t, 50, m.Total, 0.01) + assert.InDelta(t, 25, m.User, 0.01) + assert.InDelta(t, 12.5, m.System, 0.01) + assert.Zero(t, m.Iowait) + assert.Zero(t, m.Steal) + assert.InDelta(t, 50, m.Idle, 0.01) +} + +func TestContainerCpuMetricsHonorsQuota(t *testing.T) { + swapCpuContainerSeams(t) + markLxc(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + require.NoError(t, os.MkdirAll(cpuCgroupRoot, 0o755)) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.max"), "200000 100000\n") // 2 cores + cpuNumCPU = func() int { return 8 } + advance := fakeNow(t) + + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 1000000\n") + containerCpuMetrics(60000) + advance(time.Second) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 2000000\n") + m, ok := containerCpuMetrics(60000) + require.True(t, ok) + assert.InDelta(t, 50, m.Total, 0.01) // 1 core-second against a 2-core quota +} + +func TestContainerCpuMetricsZeroAndBackwardDelta(t *testing.T) { + swapCpuContainerSeams(t) + markLxc(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + require.NoError(t, os.MkdirAll(cpuCgroupRoot, 0o755)) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 5000000\n") + cpuNumCPU = func() int { return 4 } + advance := fakeNow(t) + + // seed the baseline, then do not advance the clock: elapsed <= 0 + containerCpuMetrics(60000) + m, ok := containerCpuMetrics(60000) + require.True(t, ok) + assert.Zero(t, m.Total) + + // counter goes backwards (cgroup recreated): report zero and re-baseline + advance(time.Second) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 100000\n") + m, ok = containerCpuMetrics(60000) + require.True(t, ok) + assert.Zero(t, m.Total) + + // next tick measures from the new baseline, not the stale one + advance(time.Second) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 1100000\n") + m, ok = containerCpuMetrics(60000) + require.True(t, ok) + assert.InDelta(t, 25, m.Total, 0.01) // 1e6 usec / (1s * 4 cores) +} + +func TestContainerCpuMetricsFallbacks(t *testing.T) { + t.Run("not in lxc", func(t *testing.T) { + swapCpuContainerSeams(t) + _, ok := containerCpuMetrics(60000) + assert.False(t, ok) + }) + // Docker agents monitor the host, so cgroup accounting must not kick in + // even when it is readable and no LXC marker is present. + t.Run("docker container", func(t *testing.T) { + swapCpuContainerSeams(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 5000000\n") + _, ok := containerCpuMetrics(60000) + assert.False(t, ok) + }) + t.Run("in lxc without cgroup accounting", func(t *testing.T) { + swapCpuContainerSeams(t) + markLxc(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + // cpuCgroupRoot has no cpu.stat + _, ok := containerCpuMetrics(60000) + assert.False(t, ok) + }) +} + +// The host path must keep reporting through gopsutil untouched. +func TestGetCpuMetricsHostFallback(t *testing.T) { + swapCpuContainerSeams(t) + m, err := getCpuMetrics(60000) + require.NoError(t, err) + assert.False(t, m.fromCgroup) + assert.GreaterOrEqual(t, m.Total, 0.0) + assert.LessOrEqual(t, m.Total, 100.0) +} + +// Inside LXC getCpuMetrics must report the cgroup-derived value, not +// the host core counters from /proc/stat. +func TestGetCpuMetricsPrefersCgroup(t *testing.T) { + swapCpuContainerSeams(t) + markLxc(t) + writeCpuFixture(t, cpuProcSelfCgroup, "0::/\n") + writeCpuFixture(t, cpuCgroupMountinfo, "") + require.NoError(t, os.MkdirAll(cpuCgroupRoot, 0o755)) + cpuNumCPU = func() int { return 4 } + advance := fakeNow(t) + + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 0\n") + m, err := getCpuMetrics(60000) + require.NoError(t, err) + assert.Zero(t, m.Total) + + advance(time.Second) + writeCpuFixture(t, filepath.Join(cpuCgroupRoot, "cpu.stat"), "usage_usec 2000000\n") + m, err = getCpuMetrics(60000) + require.NoError(t, err) + assert.InDelta(t, 50, m.Total, 0.01) + assert.True(t, m.fromCgroup) // per-core usage is skipped for this source +} + +func TestCountCpuList(t *testing.T) { + assert.Equal(t, 4, countCpuList("0-3")) + assert.Equal(t, 4, countCpuList("2,5-7")) + assert.Equal(t, 1, countCpuList("2")) + assert.Equal(t, 0, countCpuList("")) + assert.Equal(t, 0, countCpuList("max")) + assert.Equal(t, 6, countCpuList("0-3,8-9")) +} + +func TestCpuQuotaCores(t *testing.T) { + dir := t.TempDir() + _, ok := cpuQuotaCores(dir) + assert.False(t, ok) // no quota files + + writeCpuFixture(t, filepath.Join(dir, "cpu.max"), "max 100000\n") + _, ok = cpuQuotaCores(dir) + assert.False(t, ok) // unlimited + + writeCpuFixture(t, filepath.Join(dir, "cpu.max"), "150000 100000\n") + q, ok := cpuQuotaCores(dir) + require.True(t, ok) + assert.InDelta(t, 1.5, q, 0.001) + + // v1 files + v1 := t.TempDir() + writeCpuFixture(t, filepath.Join(v1, "cpu.cfs_quota_us"), "-1\n") + writeCpuFixture(t, filepath.Join(v1, "cpu.cfs_period_us"), "100000\n") + _, ok = cpuQuotaCores(v1) + assert.False(t, ok) + + writeCpuFixture(t, filepath.Join(v1, "cpu.cfs_quota_us"), "50000\n") + q, ok = cpuQuotaCores(v1) + require.True(t, ok) + assert.InDelta(t, 0.5, q, 0.001) +} diff --git a/agent/cpu_unsupported.go b/agent/cpu_unsupported.go new file mode 100644 index 000000000..886941f82 --- /dev/null +++ b/agent/cpu_unsupported.go @@ -0,0 +1,9 @@ +//go:build !linux + +package agent + +// containerCpuMetrics is Linux-only (cgroup accounting). Other platforms keep +// the gopsutil /proc path. +func containerCpuMetrics(uint16) (CpuMetrics, bool) { + return CpuMetrics{}, false +} diff --git a/agent/system.go b/agent/system.go index 3373e1aad..f567585f9 100644 --- a/agent/system.go +++ b/agent/system.go @@ -170,9 +170,13 @@ func (a *Agent) getSystemStats(cacheTimeMs uint16) system.Stats { slog.Error("Error getting cpu metrics", "err", err) } - // per-core cpu usage - if perCoreUsage, err := getPerCoreCpuUsage(cacheTimeMs); err == nil { - systemStats.CpuCoresUsage = perCoreUsage + // per-core cpu usage. Skipped when the total comes from cgroup accounting: + // per-core /proc/stat counters there describe shared host cores, not the + // guest, and would contradict the total. + if !cpuMetrics.fromCgroup { + if perCoreUsage, err := getPerCoreCpuUsage(cacheTimeMs); err == nil { + systemStats.CpuCoresUsage = perCoreUsage + } } // load average