docs: add cgroup v2 metrics for memory, CPU, and block I/O#24727
Open
nanookclaw wants to merge 1 commit intodocker:mainfrom
Open
docs: add cgroup v2 metrics for memory, CPU, and block I/O#24727nanookclaw wants to merge 1 commit intodocker:mainfrom
nanookclaw wants to merge 1 commit intodocker:mainfrom
Conversation
Fixes docker#24644 The runtime metrics documentation previously noted that cgroup v2 metrics were not yet documented, with only a link to the kernel documentation. Since cgroup v2 has been the default on major distributions since 2020-2021, users following the existing docs would find file paths and metric formats that don't match their systems. This adds comprehensive cgroup v2 metrics documentation for all three subsystems: - Memory: memory.current, memory.max, memory.high/low/min, memory.swap.*, memory.events, and memory.stat field mappings (anon→rss, file→cache, kernel, slab, shmem, etc.) - CPU: cpu.stat (usage_usec, user_usec, system_usec), cpu.max bandwidth limits, cpu.weight - Block I/O: io.stat per-device format (rbytes, wbytes, rios, wios, dbytes, dios), io.max rate limits Each section includes field-by-field descriptions, example output, and a mapping of v1→v2 equivalents. The v1 documentation is preserved unchanged in its own subsections. Signed-off-by: Nanook Claw <nanook@agentmail.to>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #24644
The runtime metrics documentation previously stated that cgroup v2 metrics were not yet documented, with only a link to the kernel documentation. Since cgroup v2 has been the default on major Linux distributions since 2020-2021 (Fedora 31+, Debian 11+, Ubuntu 21.10+), users following the existing docs find file paths and metric formats that don't match their systems.
Changes
Adds comprehensive cgroup v2 metrics documentation for all three subsystems, organized alongside the existing v1 content:
Memory metrics (cgroup v2)
memory.current,memory.max,memory.high,memory.low,memory.min,memory.swap.current,memory.swap.max,memory.eventsmemory.statfield descriptions with v1-to-v2 mappings (anonreplacesrss,filereplacescache, plus newkernel,slab,shmemfields)total_prefix (stats always include subtree), unified memory+swap controllerCPU metrics (cgroup v2)
cpu.statfields:usage_usec,user_usec,system_usec, plus CFS bandwidth throttling statscpu.maxbandwidth limit format andcpu.weight(replacescpu.shares)Block I/O metrics (cgroup v2)
io.statper-device format withrbytes,wbytes,rios,wios,dbytes,diosio.maxrate limit interfaceblkio.*files, bytes vs sectorsTesting