Proposal: docker ps: add fields for ordering and column selection #10255

codemac · 2015-01-22T00:10:41Z

api/client/commands.go: Refactor CmdPs to use a fields list of
characters to determine which columns to print on docker ps
invocation.

This adds an ability for the docker command to print the columns of
output in arbitrary order.

This is nominally related to #7477

Signed-off-by: Jeff Mickey j@codemac.net

codemac · 2015-01-22T00:14:53Z

This is my first contribution to the docker project, I apologize for any errors.

This adds a -fields to docker ps that allows you to choose which, and in what order the columns are printed. Haven't finished testing locally yet, but wanted to see if this is the completely wrong direction. This code is small and simple, so any feedback including rewrites is appreciated.

jessfraz · 2015-01-22T01:59:21Z

Thanks for your first contribution! We are super excited to have you! Now since your PR is changing the UX of docker ps it is going to need UX review. Seeing as we are in the middle of the release process, about to make release candidate binaries and try and test and fix all bugs that are found it might take a little longer for us to get to this PR. But we promise we are here and this seems really awesome. Just don't want you to be concerned if there is a slight lull in review :)

codemac · 2015-01-22T02:13:19Z

Yea, more than anything the type of feedback I'd like is if this is the approach people agree with.

The amount of docker ps | tail -n +2 | awk '{print $NF}' occurring in my life is too damn high :)

Thank you for the prompt response!

codemac · 2015-02-18T21:18:14Z

Please let me know what thoughts are, I can rebase/update if necessary.

SvenDowideit · 2015-02-18T23:53:57Z

oh +1 - I was just wanting this for docker image too

codemac · 2015-03-13T04:09:26Z

This is my monthly ping!

Also - the windows builder failed pretty fantastically, on all kinds of things that don't look like my fault.

LK4D4 · 2015-03-31T21:20:16Z

Code is little unreadable with all this next stuff, but idea is okay.
@tiborvass should we move to code-review?

tiborvass · 2015-03-31T22:57:28Z

@LK4D4 although I understand the idea and the reason, I'm not 100% sure we want this (not saying I'm sure we don't want this :P )

Ping @crosbymichael @jfrazelle @estesp @duglin @icecrime

icecrime · 2015-03-31T23:16:21Z

I personally don't feel a need for this, so I'm a "weak no".

thaJeztah · 2015-04-01T21:36:40Z

Different proposal, but just for showing (selected) labels in docker ps #11943 might be good to compare the use-cases and see if they make sense together?

duglin · 2015-04-02T18:34:31Z

api/client/commands.go

+	}
+
+	if *size {
+		*fields = *fields + "z"


do you need to make sure 'z' isn't already in there?

actually, do you purposely want to allow --fields=cccc ? Guess if that's what the user wants.....

It was my consideration that it could be desired, but doesn't seem in line with what I think a user would suspect. I'll uniq the letters that are set in *fields, choosing the earliest existence.

duglin · 2015-04-04T15:31:38Z

I actually like the idea and wouldn't mind seeing it on other tabular-output commands.
Major re-base is needed though - sorry - lots of changes these days.

duglin · 2015-04-07T15:44:20Z

I guess before I make more comments on the code we need to exit design review :-)
I'm +1 on it. @tiborvass ?

thaJeztah · 2015-04-07T21:32:48Z

I wonder if we only want the shorthand (single-chars) to specify the columns, I can imagine they will be hard to remember without checking the help/man. Perhaps also --fields=id,image,status

Would using a comma-separated list be good idea in general (also for single-chars), as it leaves more room for future expansion (I think)

tiborvass · 2015-04-07T22:41:47Z

Still not sure if I want this. But if I did, I agree with @thaJeztah on separating actual words with commas. I don't like the single-chars.

Even though unix philosophy would say no to this PR, I agree it's not as easy to awk the output. One could say just use the API though. Maybe there's room for this. I just hope we're not opening a can of worms where people can point to this PR saying "but he got to have his --fields PR merged".

duglin · 2015-04-29T12:39:25Z

@tiborvass can you elaborate on why on you think the unix philosophy would say no to this PR? The linx 'ps' command itself has this feature.

cpuguy83 · 2015-04-29T19:32:08Z

How about just docker ps --json to spit out the literally json data instead of building the table?

* api/client/ps.go: Refactor CmdPs to use a fields list of characters to determine which columns to print on `docker ps` invocation. This adds an ability for the docker command to print the columns of output in arbitrary order. Signed-off-by: Jeff Mickey <j@codemac.net>

aluzzardi · 2015-05-19T00:00:21Z

What I'd like to see from this:

Labels: As in, add columns based on a user specified labels
Naming. Right now, columns are mapped based on hardcoded names, which is fine. I'd like to be able to rename them (as in, CONTAINER ID -> ID) and this is especially true for labels.

Use case:

docker ps --fields "c=ID,com.docker.swarm.id=Swarm ID,m"

/cc @vieux

codemac · 2015-05-19T00:05:44Z

@aluzzardi see 59c4561

* api/client/ps.go: named label support Signed-off-by: Jeff Mickey <j@codemac.net>

codemac · 2015-05-19T00:32:08Z

Well, I updated for naming the columns, but not any epic --format, --template or other work. I'd like to see a clear description of what is wanted from the steak-holders in this docker project who actually have a say. I've updated to mostly include what @aluzzardi asked for.

aluzzardi · 2015-05-19T01:48:34Z

Thanks @codemac. The only missing requirement we (Swarm) have is to include container labels.

ping @docker/core-maintainers @vieux for feedback

calavera · 2015-05-19T02:02:13Z

As @thaJeztah mentioned, and as we discussed in the maintainers meeting, any effort for custom formatting must:

Be more descriptive than single letters.
Follow Docker conventions about extra formatting by exposing a go template.

I really appreciate your PR, it made us aware of some improvements needed in this command. Please, refer to #12931 as it fulfills these two requirements and it also supports what the Swarm team needs.

duglin · 2015-05-25T18:46:23Z

@codemac where are we with this?

icecrime · 2015-06-12T23:05:01Z

@codemac Hey! Are you still available to rebase and pursue this PR? If that's not the case, maybe @calavera can you plese carry (meaning we keep your commits in and you still get credited for the work, but we take it on to completion)? Thanks!

calavera · 2015-06-18T17:54:30Z

@icecrime see #10255 (comment)

I really don't care about having any credit in the commit, but we should not deviate from other commands that already support the --format option.

cpuguy83 · 2015-06-30T18:39:18Z

@codemac Did you want to make the suggested changes?

icecrime · 2015-07-13T17:44:15Z

Ping @docker/core-maintainers: if somebody wants to carry that, I think it's a good time.

arun-gupta · 2015-07-16T17:54:27Z

Any ETA of when this will be available?

estesp · 2015-07-16T18:11:56Z

I'm going to carry this--sorry for the delay as everything else has come up this week. Of course, it will still require review and merge before it makes its way into master, so no prediction on an actual date.

estesp · 2015-07-17T04:16:46Z

Carried in PR #14699 , closing.

thaJeztah · 2015-07-17T10:41:35Z

Thanks @estesp!

Carry #10255: Docker ps format

codemac force-pushed the dockerps branch from dcbc92c to 85512e8 Compare January 22, 2015 00:12

jessfraz added the UX label Jan 22, 2015

jessfraz changed the title ~~docker ps: add fields for ordering and column selection~~ Proposal: docker ps: add fields for ordering and column selection Jan 22, 2015

jessfraz added the Proposal label Jan 22, 2015

jessfraz added the status/1-design-review label Feb 10, 2015

codemac force-pushed the dockerps branch 3 times, most recently from 75094e1 to d641863 Compare February 26, 2015 06:45

codemac force-pushed the dockerps branch from d641863 to 952f5d3 Compare March 10, 2015 20:07

thaJeztah mentioned this pull request Apr 1, 2015

Proposal: add --label to docker ps #11943

Closed

duglin reviewed Apr 2, 2015
View reviewed changes

icecrime added the status/needs-attention Calls for a collective discussion during a review session label Apr 21, 2015

codemac force-pushed the dockerps branch from 7998dca to 37b6a01 Compare May 18, 2015 23:50

codemac force-pushed the dockerps branch 3 times, most recently from 5ac2690 to 1e11070 Compare May 19, 2015 00:17

Support named labels with field=label syntax

c5053aa

* api/client/ps.go: named label support Signed-off-by: Jeff Mickey <j@codemac.net>

codemac force-pushed the dockerps branch from 1e11070 to c5053aa Compare May 19, 2015 00:19

calavera closed this May 19, 2015

crosbymichael reopened this May 19, 2015

aluzzardi mentioned this pull request May 25, 2015

Container Rebalancing docker-archive/classicswarm#599

Closed

duglin mentioned this pull request May 29, 2015

Default "docker ps" output is too wide #7477

Closed

duglin mentioned this pull request Jul 16, 2015

Formatted output from Docker CLI #14681

Closed

estesp mentioned this pull request Jul 17, 2015

Carry #10255: Docker ps format #14699

Merged

estesp closed this Jul 17, 2015

calavera added a commit that referenced this pull request Jul 22, 2015

Merge pull request #14699 from estesp/docker-ps-format

40b9224

Carry #10255: Docker ps format

thaJeztah mentioned this pull request Dec 7, 2015

Verbose ls docker/machine#2513

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposal: docker ps: add fields for ordering and column selection #10255

Proposal: docker ps: add fields for ordering and column selection #10255

codemac commented Jan 22, 2015

codemac commented Jan 22, 2015

jessfraz commented Jan 22, 2015

codemac commented Jan 22, 2015

codemac commented Feb 18, 2015

SvenDowideit commented Feb 18, 2015

codemac commented Mar 13, 2015

LK4D4 commented Mar 31, 2015

tiborvass commented Mar 31, 2015

icecrime commented Mar 31, 2015

thaJeztah commented Apr 1, 2015

duglin Apr 2, 2015

duglin Apr 4, 2015

codemac Apr 6, 2015

duglin commented Apr 4, 2015

duglin commented Apr 7, 2015

thaJeztah commented Apr 7, 2015

tiborvass commented Apr 7, 2015

duglin commented Apr 29, 2015

cpuguy83 commented Apr 29, 2015

aluzzardi commented May 19, 2015

codemac commented May 19, 2015

codemac commented May 19, 2015

aluzzardi commented May 19, 2015

calavera commented May 19, 2015

duglin commented May 25, 2015

icecrime commented Jun 12, 2015

calavera commented Jun 18, 2015

cpuguy83 commented Jun 30, 2015

icecrime commented Jul 13, 2015

arun-gupta commented Jul 16, 2015

estesp commented Jul 16, 2015

estesp commented Jul 17, 2015

thaJeztah commented Jul 17, 2015

Proposal: docker ps: add fields for ordering and column selection #10255

Proposal: docker ps: add fields for ordering and column selection #10255

Conversation

codemac commented Jan 22, 2015

codemac commented Jan 22, 2015

jessfraz commented Jan 22, 2015

codemac commented Jan 22, 2015

codemac commented Feb 18, 2015

SvenDowideit commented Feb 18, 2015

codemac commented Mar 13, 2015

LK4D4 commented Mar 31, 2015

tiborvass commented Mar 31, 2015

icecrime commented Mar 31, 2015

thaJeztah commented Apr 1, 2015

duglin Apr 2, 2015

Choose a reason for hiding this comment

duglin Apr 4, 2015

Choose a reason for hiding this comment

codemac Apr 6, 2015

Choose a reason for hiding this comment

duglin commented Apr 4, 2015

duglin commented Apr 7, 2015

thaJeztah commented Apr 7, 2015

tiborvass commented Apr 7, 2015

duglin commented Apr 29, 2015

cpuguy83 commented Apr 29, 2015

aluzzardi commented May 19, 2015

codemac commented May 19, 2015

codemac commented May 19, 2015

aluzzardi commented May 19, 2015

calavera commented May 19, 2015

duglin commented May 25, 2015

icecrime commented Jun 12, 2015

calavera commented Jun 18, 2015

cpuguy83 commented Jun 30, 2015

icecrime commented Jul 13, 2015

arun-gupta commented Jul 16, 2015

estesp commented Jul 16, 2015

estesp commented Jul 17, 2015

thaJeztah commented Jul 17, 2015