docker/cli
1
0
Fork 0
mirror of https://github.com/docker/cli.git synced 2026-01-18 08:21:31 +03:00
Code Activity

Add note about reported memory stats on linux

Browse Source 
Since the API and the CLI both have a "Usage" field for memory, clarify
that the CLI does additional calculations to avoid confusion of API
consumers.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: a6acacc533
Component: cli
This commit is contained in:
Brian Goff
2017-10-25 16:22:43 -04:00
parent 4883b5d512
commit a3b0929c08
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/cli/docs/reference/commandline/stats.md
View File

@@ -34,6 +34,8 @@ The `docker stats` command returns a live data stream for running containers. To
If you want more detailed information about a container's resource usage, use the `/containers/(id)/stats` API endpoint.
> **Note**: On Linux, the Docker CLI reports memory usage by subtracting page cache usage from the total memory usage. The API does not perform such a calculation but rather provides the total memory usage and the amount from the page cache so that clients can use the data as needed.
## Examples
Running `docker stats` on all running containers against a Linux daemon.