InTheForest/moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2026-01-11 18:51:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #51786 from majiayu000/43810-fix-stats-api-docs-cgroups-v2

Browse Source 
docs: update stats API description for cgroups v2 compatibility
This commit is contained in:
Sebastiaan van Stijn
2026-01-05 22:04:19 +01:00
committed by GitHub
parent 5275f5f33c 917d66d833
commit e3f60d72f4
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
api/swagger.yaml
View File

@@ -6259,7 +6259,11 @@ definitions:
example: 0 example: 0
stats: stats:
description: | description: |
All the stats exported via memory.stat. when using cgroups v2. All the stats exported via memory.stat.
The fields in this object differ between cgroups v1 and v2.
On cgroups v1, fields such as `cache`, `rss`, `mapped_file` are available.
On cgroups v2, fields such as `file`, `anon`, `inactive_file` are available.
This field is Linux-specific and omitted for Windows containers. This field is Linux-specific and omitted for Windows containers.
type: "object" type: "object"
@@ -8532,7 +8536,8 @@ paths:
To calculate the values shown by the `stats` command of the docker cli tool To calculate the values shown by the `stats` command of the docker cli tool
the following formulas can be used: the following formulas can be used:
* used_memory = `memory_stats.usage - memory_stats.stats.cache` * used_memory = `memory_stats.usage - memory_stats.stats.cache` (cgroups v1)
* used_memory = `memory_stats.usage - memory_stats.stats.inactive_file` (cgroups v2)
* available_memory = `memory_stats.limit` * available_memory = `memory_stats.limit`
* Memory usage % = `(used_memory / available_memory) * 100.0` * Memory usage % = `(used_memory / available_memory) * 100.0`
* cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage` * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`