Allow docker stats without arguments #16742

runcom · 2015-10-03T14:56:20Z

This patch adds the ability to run docker stats w/o arguments and get
statistics for all running containers by default. Also add a new
--all flag to list statistics for all containers (like docker ps).
New running containers are added to the list as they show up also.
Add integration tests for this new behavior.
Docs updated accordingly. Fix missing stuff in man/commandline
reference for docker stats.

Close #10772

Signed-off-by: Antonio Murdaca amurdaca@redhat.com

thaJeztah · 2015-10-03T17:47:40Z

man/docker-stats.1.md

 Run **docker stats** with multiple containers.

    $ docker stats redis1 redis2
    CONTAINER           CPU %               MEM USAGE / LIMIT     MEM %               NET I/O             BLOCK I/O
    redis1              0.07%               796 KB / 64 MB        1.21%               788 B / 648 B       3.568 MB / 512 KB
    redis2              0.07%               2.746 MB / 64 MB      4.29%               1.266 KB / 648 B    12.4 MB / 0 B
+
+# HISTORY
+October 2015, updated by Antonio Murdaca <amurdaca@redhat.com>


New email address? 😉

haha yeah, but this isn't needed I'm sure

tianon · 2015-10-03T22:20:52Z

Does this update as containers come and go, or is it a static list from when the command was started? IMO that should be mentioned in the docs for this to make sure expectations are clear. 😄

runcom · 2015-10-03T22:33:57Z

Does this update as containers come and go, or is it a static list from when the command was started? IMO that should be mentioned in the docs for this to make sure expectations are clear.

This is a static list, but I think I can update the stats list by listening on container's create events in the cli as well and update the list with newly running containers, I'll see what I can do, I just didn't want to overload the stats code again and again :). If it'll go with just a static list I'll make sure to update the docs accordingly :)

tianon · 2015-10-03T22:37:09Z

I think it'd be really, really cool if you can pull that off! 👍 (Otherwise this is "just" a helper for piping ps to stats, which is useful but less fun. 😄 )

runcom · 2015-10-03T23:29:16Z

@tianon managed a way to auto update the list in a few line of codes (added an integration test for this also)

runcom · 2015-10-12T13:26:39Z

rebased

ping @cpuguy83 @LK4D4 @icecrime

duglin · 2015-10-12T14:32:56Z

Looks really cool so far. I like that new containers are added dynamically, but then at the same time it seems that as they die they should be removed, no?

Just too bad it can't fit in 80 columns for those of us who like thin windows :-)

runcom · 2015-10-12T14:50:13Z

Looks really cool so far. I like that new containers are added dynamically, but then at the same time it seems that as they die they should be removed, no?

the auto-add/auto-remove use the same behavior of docker stats CID so stopped/exited containers are left in the list (showing zeroed stats, as it's currently happening when you docker stats a stopped container) and if you docker rm -f CID it will be removed from the docker stats list.
I like this behavior but if you prefer removing stopped/exited containers from the list I can change the patch to do so :)

duglin · 2015-10-12T14:57:56Z

It just seems we should be consistent. If I don't see stopped containers when I first run docker stats then I don't think I should see newly stopped ones either. Or, always show them. But I don't think newly stopped ones should be treated differently from older stopped ones - they're both in the same state.

runcom · 2015-10-12T15:10:28Z

It just seems we should be consistent. If I don't see stopped containers when I first run docker stats then I don't think I should see newly stopped ones either. Or, always show them. But I don't think newly stopped ones should be treated differently from older stopped ones - they're both in the same state.

so docker stats should remove stopped/exited containers while if you run docker stats --all it should display them.
Sounds good?

duglin · 2015-10-12T15:12:29Z

sounds good to me

runcom · 2015-10-12T16:25:34Z

@duglin updated

duglin · 2015-10-12T17:53:08Z

@runcom it doesn't seem to be removing non-running containers. I did:

docker run -d ubuntu sleep 600
docker run ubuntu echo hi

and I see two appears in the stats, but then the 2nd one never goes away.

Also, you may want to sort the output based on something that's stable, like the IDs or time started. Even with just those two I saw the order reversing quite a lot which makes it hard to look at when you're watching one particular container to see what its doing.

runcom · 2015-10-12T19:14:07Z

Fixed removing on exited containers, thanks @duglin, I'll take care of the order

tianon · 2015-10-12T19:32:37Z

This is killer ❤️

thaJeztah · 2015-11-05T22:41:49Z

docs/reference/commandline/stats.md


    Display a live stream of one or more containers' resource usage statistics

+      --all=false        Show all containers (default shows just running)


looks like you forgot the -a flag here

fixed, thanks @thaJeztah!

thaJeztah · 2015-11-05T22:49:39Z

One comment, otherwise docs LGTM

we also need to update completions for this (new flag and container is no longer required for the subcommand) @runcom do you want to take care of those as well, or ping the maintainers of the completion scripts?

vdemeester · 2015-11-05T22:52:29Z

😻

thaJeztah · 2015-11-05T22:57:59Z

ping @albers @sdurrheimer just talked with @runcom on IRC and if you could do the completions, that'd be awesome!

thaJeztah · 2015-11-05T22:58:36Z

ping @SvenDowideit @moxiegirl @jamtur01 thanks!

moxiegirl · 2015-11-06T00:52:23Z

integration-cli/docker_cli_stats_test.go

+		c.Fatalf("Expected stats output to contain both %s and %s, got %s", id1, id2, out)
+	}
+	if strings.Contains(out, id3) {
+		c.Fatalf("Expected %s not to be listed in stats, got %s", id3, out)


This message is super awkward.

Expected %s not to be listed in stats, got %s

Did not expect %s in stats. Got %s in stats.

moxiegirl · 2015-11-06T00:53:15Z

@thaJeztah Is this supposed to be in Docs review?

albers · 2015-11-06T07:55:33Z

@thaJeztah yeah, I'll do the bash completion part. Thanks for bringing me in.

thaJeztah · 2015-11-06T07:57:15Z

@moxiegirl yes it is, so feel free to review :-)

moxiegirl · 2015-11-06T18:06:52Z

docs/reference/commandline/stats.md

@@ -10,13 +10,22 @@ parent = "smn_cli"

 # stats


@runcom Thanks for update. The examples should come after the description. Also, we want to make sure to illustrate the fact they can pass id as well as name. Update please command ref and man..

---> https://gist.github.com/moxiegirl/8744402a9adf5aa288a1

stats

Usage: docker stats [OPTIONS] [CONTAINER...] Display a live stream of one or more containers' resource usage statistics -a, --all=false Show all containers (default shows just running) --help=false Print usage --no-stream=false Disable streaming stats and only pull the first result

The docker stats command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data.

If you want more detailed information about a container's resource usage, use the /containers/(id)/stats API endpoint.

Examples

Running docker stats on all running containers

$ docker stats CONTAINER CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O redis1 0.07% 796 KB / 64 MB 1.21% 788 B / 648 B 3.568 MB / 512 KB redis2 0.07% 2.746 MB / 64 MB 4.29% 1.266 KB / 648 B 12.4 MB / 0 B nginx1 0.03% 4.583 MB / 64 MB 6.30% 2.854 KB / 648 B 27.7 MB / 0 B

Running docker stats on multiple containers by name and id.

$ docker stats fervent_panini 5acfcb1b4fd1 CONTAINER CPU % MEM USAGE/LIMIT MEM % NET I/O 5acfcb1b4fd1 0.00% 115.2 MB/1.045 GB 11.03% 1.422 kB/648 B fervent_panini 0.02% 11.08 MB/1.045 GB 1.06% 648 B/648 B

This patch adds the ability to run `docker stats` w/o arguments and get statistics for all running containers by default. Also add a new `--all` flag to list statistics for all containers (like `docker ps`). New running containers are added to the list as they show up also. Add integration tests for this new behavior. Docs updated accordingly. Fix missing stuff in man/commandline reference for `docker stats`. Signed-off-by: Antonio Murdaca <runcom@redhat.com>

runcom · 2015-11-07T16:04:20Z

@moxiegirl thanks, PTAL

moxiegirl · 2015-11-07T18:55:46Z

@runcom Thank you! LGTM ping @thaJeztah for the merge.

thaJeztah · 2015-11-07T19:40:57Z

Thanks! LGTM

Allow docker stats without arguments

GordonTheTurtle added the status/0-triage label Oct 3, 2015

runcom force-pushed the 10772-docker-stats-all branch from 19dbc52 to 839d595 Compare October 3, 2015 17:18

vdemeester added status/1-design-review and removed status/0-triage labels Oct 3, 2015

thaJeztah reviewed Oct 3, 2015
View reviewed changes

runcom force-pushed the 10772-docker-stats-all branch from 839d595 to 44416d9 Compare October 3, 2015 18:17

thaJeztah mentioned this pull request Oct 3, 2015

Request: docker stats without any container should display all running containers #10772

Closed

runcom force-pushed the 10772-docker-stats-all branch 3 times, most recently from 4ae94a2 to c2b9503 Compare October 4, 2015 21:48

runcom force-pushed the 10772-docker-stats-all branch from c2b9503 to ec4ed2c Compare October 12, 2015 13:26

runcom force-pushed the 10772-docker-stats-all branch 2 times, most recently from 9c409af to 7880927 Compare October 12, 2015 16:25

runcom force-pushed the 10772-docker-stats-all branch from 7880927 to 432fd6b Compare October 12, 2015 19:10

thaJeztah reviewed Nov 5, 2015
View reviewed changes

thaJeztah added impact/changelog impact/cli labels Nov 5, 2015

runcom force-pushed the 10772-docker-stats-all branch from 88971c2 to 6c79c95 Compare November 5, 2015 22:50

moxiegirl reviewed Nov 6, 2015
View reviewed changes

runcom force-pushed the 10772-docker-stats-all branch from 6c79c95 to 35ca8d6 Compare November 6, 2015 08:24

moxiegirl reviewed Nov 6, 2015
View reviewed changes

runcom force-pushed the 10772-docker-stats-all branch from 35ca8d6 to ae818a8 Compare November 7, 2015 16:03

thaJeztah added a commit that referenced this pull request Nov 7, 2015

Merge pull request #16742 from runcom/10772-docker-stats-all

fdc8cce

Allow docker stats without arguments

thaJeztah merged commit fdc8cce into moby:master Nov 7, 2015

runcom deleted the 10772-docker-stats-all branch November 7, 2015 19:54

albers mentioned this pull request Nov 9, 2015

bash completion for docker stats --all #17829

Merged

sdurrheimer mentioned this pull request Nov 10, 2015

Add zsh completion for 'docker stats --all -a' #17857

Merged

thaJeztah added this to the 1.10.0 milestone Jan 15, 2016

SamSaffron mentioned this pull request Apr 14, 2016

docker stats all should use container names before falling back to guids #22021

Closed

thaJeztah mentioned this pull request Apr 14, 2016

Docker stats for all container #22052

Open

thaJeztah mentioned this pull request May 12, 2016

Support wildcards for commands which take multiple containers/images (rm/rmi/...) #17237

Closed

mdlinville mentioned this pull request Dec 28, 2016

Feedback for: engine/reference/commandline/stats.md docker/docs#729

Closed

omercnet mentioned this pull request Jul 18, 2019

Add docker stats --all #19648

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow docker stats without arguments #16742

Allow docker stats without arguments #16742

runcom commented Oct 3, 2015

thaJeztah Oct 3, 2015

runcom Oct 3, 2015

tianon commented Oct 3, 2015

runcom commented Oct 3, 2015

tianon commented Oct 3, 2015 via email

runcom commented Oct 3, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

tianon commented Oct 12, 2015 via email

thaJeztah Nov 5, 2015

runcom Nov 5, 2015

thaJeztah commented Nov 5, 2015

vdemeester commented Nov 5, 2015

thaJeztah commented Nov 5, 2015

thaJeztah commented Nov 5, 2015

moxiegirl Nov 6, 2015

runcom Nov 6, 2015

moxiegirl commented Nov 6, 2015

albers commented Nov 6, 2015

thaJeztah commented Nov 6, 2015

moxiegirl Nov 6, 2015

runcom commented Nov 7, 2015

moxiegirl commented Nov 7, 2015

thaJeztah commented Nov 7, 2015


		Display a live stream of one or more containers' resource usage statistics

		--all=false Show all containers (default shows just running)

Allow docker stats without arguments #16742

Allow docker stats without arguments #16742

Conversation

runcom commented Oct 3, 2015

thaJeztah Oct 3, 2015

Choose a reason for hiding this comment

runcom Oct 3, 2015

Choose a reason for hiding this comment

tianon commented Oct 3, 2015

runcom commented Oct 3, 2015

tianon commented Oct 3, 2015 via email

runcom commented Oct 3, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

duglin commented Oct 12, 2015

runcom commented Oct 12, 2015

tianon commented Oct 12, 2015 via email

thaJeztah Nov 5, 2015

Choose a reason for hiding this comment

runcom Nov 5, 2015

Choose a reason for hiding this comment

thaJeztah commented Nov 5, 2015

vdemeester commented Nov 5, 2015

thaJeztah commented Nov 5, 2015

thaJeztah commented Nov 5, 2015

moxiegirl Nov 6, 2015

Choose a reason for hiding this comment

runcom Nov 6, 2015

Choose a reason for hiding this comment

moxiegirl commented Nov 6, 2015

albers commented Nov 6, 2015

thaJeztah commented Nov 6, 2015

moxiegirl Nov 6, 2015

Choose a reason for hiding this comment

stats

Examples

runcom commented Nov 7, 2015

moxiegirl commented Nov 7, 2015

thaJeztah commented Nov 7, 2015