Skip to content

Adding timestamp end to events endpoint. Modifying api docs.#4821

Merged
1 commit merged intomoby:masterfrom
jimenez:3903-add_event_end_timestamp-feature
Apr 10, 2014
Merged

Adding timestamp end to events endpoint. Modifying api docs.#4821
1 commit merged intomoby:masterfrom
jimenez:3903-add_event_end_timestamp-feature

Conversation

@jimenez
Copy link
Contributor

@jimenez jimenez commented Mar 23, 2014

Docker-DCO-1.1-Signed-off-by: Isabel Jimenez contact@isabeljimenez.com (github: jimenez)

fix #3903

ping @crosbymichael

@vieux vieux added /core/api and removed /core/api labels Mar 23, 2014
api/client.go Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean that we no longer continue to show events until ctrl-C?

(or just that the doc change is misleading)

perhaps we should have a -f like we do for docker logs -f container

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SvenDowideit The behaviour is the same as before

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jimenez the reason I asked, is that the highlighted change does not confirm to the reader that it will indeed still stream.

@jamtur01
Copy link
Contributor

@SvenDowideit @vieux we really need to talk about API docs and automation.

@vieux
Copy link
Contributor

vieux commented Mar 25, 2014

@jamtur01 Yes, my first instinct would be to have only the v1.0 doc, and then only diffs. The doc page would be generated.

@jamtur01
Copy link
Contributor

@vieux +10.

@vieux
Copy link
Contributor

vieux commented Mar 25, 2014

ping @ostezer :)

@SvenDowideit
Copy link
Contributor

@jamtur01 @vieux yes, we do - but not on this PR ;)

api/client.go Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and then there's my other thought - can I do

docker log --since Jan-2014 --until April-2014 ?

(I don't mean the date format, I mean in principle - will it stream until that date, or will it break?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will rebase tomorrow. I assume you were talking about events and not log so docker events --since 2014-01 --until 2014-04 will display events previous to the 'since' date and will stream events until the 'until' flag date. Unless you break it with <Ctrl-C>

@vieux vieux mentioned this pull request Mar 31, 2014
@SvenDowideit
Copy link
Contributor

@jimenez oh, sweet - if its that magical, can you please make the docs say so, cos thats cooler than sliced cheese, but if no-one reads about it, only the experimenters will know

@jimenez
Copy link
Contributor Author

jimenez commented Apr 4, 2014

ping @crosbymichael
@SvenDowideit I changed the usage, I see you are docker's docs master :), I think you are more qualified to judge what is better to add on docs, I changed just what goes with the rest of this PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feel free to call me a pedant :) I presume that calling event.Time and comparing it to until is a more computationally expensive thing than comparing until == 0 for each of a crazy number of events until the user hits Ctrl-c

(if not, then I learned something about golang :) )

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SvenDowideit event.Time isn't a function call, so the effective difference
is negligible :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

20 years ago i would have compared the asm compiler output out of curiosity - these days - thank you :)

@jimenez
Copy link
Contributor Author

jimenez commented Apr 9, 2014

@crosbymichael ping
@SvenDowideit updated

@vieux
Copy link
Contributor

vieux commented Apr 9, 2014

It's time to bump the API version now that 0.10.0 is out. There are several modifications I want to include on the API 1.11

@unclejack please take a look.

@SvenDowideit
Copy link
Contributor

Docs LGTM

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it might be better to mark until, i.e.,

use the until parameter > use the -until parameter

and,

timestamp > timestamp.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ostezer done

Docker-DCO-1.1-Signed-off-by: Isabel Jimenez <contact@isabeljimenez.com> (github: jimenez)
ghost pushed a commit that referenced this pull request Apr 10, 2014
…ature

Adding timestamp end to events endpoint. Modifying api docs.
@ghost ghost merged commit a521388 into moby:master Apr 10, 2014
@unclejack
Copy link
Contributor

LGTM

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docker events: Add an ending timestamp

6 participants