From d3c8e0a8ca310cbc6a8889cad885cc221db2044b Mon Sep 17 00:00:00 2001 From: Bret Fisher Date: Sun, 14 Jan 2018 01:08:23 -0500 Subject: [PATCH 1/2] closes #727, add info for events backlog and scope 1. Adds `docker events` description info on the two scope types of events. 2. Adds `docker events` note in two places about backlog limit of event log. Further info and background info in Issue https://github.com/docker/cli/issues/727 Signed-off-by: Bret Fisher --- docs/reference/commandline/events.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index 4cd0fe8a87fc..6da99d1a8e63 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -31,7 +31,12 @@ Options: ## Description Use `docker events` to get real-time events from the server. These events differ -per Docker object type. +per Docker object type. Different event types have different scopes. The local +scoped events are only seen on the node they take place on, and swarm scoped +events are seen on all managers. + +Note that there is a limited backlog of events you can filter. `docker events` is +a rolling log, and has at most 1000 events at a time. ### Object types @@ -159,6 +164,9 @@ that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a fraction of a second no more than nine digits long. +Note that there is a limited backlog of events you can filter. `docker events` is +a rolling log, and has at most 1000 events at a time. + #### Filtering The filtering flag (`-f` or `--filter`) format is of "key=value". If you would From 50fb4d6d54e2f650938f2649237be850c21b473a Mon Sep 17 00:00:00 2001 From: Bret Fisher Date: Mon, 29 Jan 2018 17:45:55 -0500 Subject: [PATCH 2/2] adding recommended changes Signed-off-by: Bret Fisher --- docs/reference/commandline/events.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index 6da99d1a8e63..bd2aa8a486bf 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -31,12 +31,12 @@ Options: ## Description Use `docker events` to get real-time events from the server. These events differ -per Docker object type. Different event types have different scopes. The local +per Docker object type. Different event types have different scopes. Local scoped events are only seen on the node they take place on, and swarm scoped events are seen on all managers. -Note that there is a limited backlog of events you can filter. `docker events` is -a rolling log, and has at most 1000 events at a time. +Only the last 1000 log events are returned. You can use filters to further limit +the number of events returned. ### Object types @@ -164,8 +164,8 @@ that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a fraction of a second no more than nine digits long. -Note that there is a limited backlog of events you can filter. `docker events` is -a rolling log, and has at most 1000 events at a time. +Only the last 1000 log events are returned. You can use filters to further limit +the number of events returned. #### Filtering