From a6acacc53303a7e721d01542a2618005e0b461d1 Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Wed, 25 Oct 2017 16:22:43 -0400 Subject: [PATCH] Add note about reported memory stats on linux 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 --- docs/reference/commandline/stats.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index 467b4bceda..b2bba3114e 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -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.