Skip to content

docs(events): say the 256-event buffer is in-memory #7202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
locker95 wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −4
Open

docs(events): say the 256-event buffer is in-memory #7202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/reference/commandline/system_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@ 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.

Only the last 256 log events are returned. You can use filters to further limit
the number of events returned.
Only the last 256 events are kept, in daemon memory. They are not written to
disk and they do not survive a daemon restart. There is no option to change
that buffer size or to retain events for a duration. `--since` and `--until`
filter this buffer; they do not read a longer history.

You can use filters to further limit the number of events returned.

### Object types

Expand Down Expand Up @@ -156,8 +160,12 @@ 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.

Only the last 256 log events are returned. You can use filters to further limit
the number of events returned.
Only the last 256 events are kept, in daemon memory. They are not written to
disk and they do not survive a daemon restart. There is no option to change
that buffer size or to retain events for a duration. `--since` and `--until`
filter this buffer; they do not read a longer history.

You can use filters to further limit the number of events returned.

#### <a name="filter"></a> Filtering (--filter)

Expand Down
3 changes: 3 additions & 0 deletions man/src/system/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Get event information from the Docker daemon. Information can include historical
information and real-time information.

Historical events are the last 256 events held in daemon memory. They are not
written to disk and they do not survive a daemon restart.

Docker containers will report the following events:

attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
Expand Down