Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
| ... | ... |
@@ -2688,7 +2688,7 @@ func (s *containerStats) Display(w io.Writer) error {
|
| 2688 | 2688 |
} |
| 2689 | 2689 |
|
| 2690 | 2690 |
func (cli *DockerCli) CmdStats(args ...string) error {
|
| 2691 |
- cmd := cli.Subcmd("stats", "CONTAINER", "Display live container stats based on resource usage", true)
|
|
| 2691 |
+ cmd := cli.Subcmd("stats", "CONTAINER", "Display a live stream of one or more containers' resource usage statistics", true)
|
|
| 2692 | 2692 |
cmd.Require(flag.Min, 1) |
| 2693 | 2693 |
utils.ParseFlags(cmd, args, true) |
| 2694 | 2694 |
|
| ... | ... |
@@ -98,7 +98,7 @@ func init() {
|
| 98 | 98 |
{"save", "Save an image to a tar archive"},
|
| 99 | 99 |
{"search", "Search for an image on the Docker Hub"},
|
| 100 | 100 |
{"start", "Start a stopped container"},
|
| 101 |
- {"stats", "Display live container stats based on resource usage"},
|
|
| 101 |
+ {"stats", "Display a live stream of one or more containers' resource usage statistics"},
|
|
| 102 | 102 |
{"stop", "Stop a running container"},
|
| 103 | 103 |
{"tag", "Tag an image into a repository"},
|
| 104 | 104 |
{"top", "Lookup the running processes of a container"},
|
| ... | ... |
@@ -2,7 +2,7 @@ |
| 2 | 2 |
% Docker Community |
| 3 | 3 |
% JUNE 2014 |
| 4 | 4 |
# NAME |
| 5 |
-docker-stats - Display live container stats based on resource usage. |
|
| 5 |
+docker-stats - Display a live stream of one or more containers' resource usage statistics |
|
| 6 | 6 |
|
| 7 | 7 |
# SYNOPSIS |
| 8 | 8 |
**docker stats** |
| ... | ... |
@@ -11,7 +11,7 @@ docker-stats - Display live container stats based on resource usage. |
| 11 | 11 |
|
| 12 | 12 |
# DESCRIPTION |
| 13 | 13 |
|
| 14 |
-Display live container stats based on resource usage. |
|
| 14 |
+Display a live stream of one or more containers' resource usage statistics |
|
| 15 | 15 |
|
| 16 | 16 |
# OPTIONS |
| 17 | 17 |
**--help** |
| ... | ... |
@@ -71,7 +71,7 @@ root filesystem as read only. |
| 71 | 71 |
`GET /containers/(id)/stats` |
| 72 | 72 |
|
| 73 | 73 |
**New!** |
| 74 |
-This endpoint returns a stream of container stats based on resource usage. |
|
| 74 |
+This endpoint returns a live stream of a container's resource usage statistics. |
|
| 75 | 75 |
|
| 76 | 76 |
|
| 77 | 77 |
## v1.16 |
| ... | ... |
@@ -2005,11 +2005,11 @@ more details on finding shared images from the command line. |
| 2005 | 2005 |
|
| 2006 | 2006 |
Usage: docker stats [CONTAINERS] |
| 2007 | 2007 |
|
| 2008 |
- Display live container stats based on resource usage |
|
| 2008 |
+ Display a live stream of one or more containers' resource usage statistics |
|
| 2009 | 2009 |
|
| 2010 | 2010 |
--help=false Print usage |
| 2011 | 2011 |
|
| 2012 |
-Running `docker stats` on two redis containers |
|
| 2012 |
+Running `docker stats` on multiple containers |
|
| 2013 | 2013 |
|
| 2014 | 2014 |
$ sudo docker stats redis1 redis2 |
| 2015 | 2015 |
CONTAINER CPU % MEM USAGE/LIMIT MEM % NET I/O |
| ... | ... |
@@ -2017,12 +2017,11 @@ Running `docker stats` on two redis containers |
| 2017 | 2017 |
redis2 0.07% 2.746 MiB/64 MiB 4.29% 1.266 KiB/648 B |
| 2018 | 2018 |
|
| 2019 | 2019 |
|
| 2020 |
-When run on running containers live container stats will be streamed |
|
| 2021 |
-back and displayed to the client. Stopped containers will not |
|
| 2022 |
-receive any updates to their stats unless the container is started again. |
|
| 2020 |
+The `docker stats` command will only return a live stream of data for running |
|
| 2021 |
+containers. Stopped containers will not return any data. |
|
| 2023 | 2022 |
|
| 2024 | 2023 |
> **Note:** |
| 2025 |
-> If you want more in depth resource usage for a container use the API endpoint |
|
| 2024 |
+> If you want more detailed information about a container's resource usage, use the API endpoint. |
|
| 2026 | 2025 |
|
| 2027 | 2026 |
## stop |
| 2028 | 2027 |
|