github.com/kaisenlinux/docker.io@v0.0.0-20230510090727-ea55db55fac7/cli/man/src/system/events.md (about)

     1  Get event information from the Docker daemon. Information can include historical
     2  information and real-time information.
     3  
     4  Docker containers will report the following events:
     5  
     6      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
     7  
     8  Docker images report the following events:
     9  
    10      delete, import, load, pull, push, save, tag, untag
    11  
    12  Docker volumes report the following events:
    13  
    14      create, mount, unmount, destroy
    15  
    16  Docker networks report the following events:
    17  
    18      create, connect, disconnect, destroy
    19  
    20  # OPTIONS
    21  
    22  The `--since` and `--until` parameters can be Unix timestamps, date formatted
    23  timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed
    24  relative to the client machine's time. If you do not provide the `--since` option,
    25  the command returns only new and/or live events.  Supported formats for date
    26  formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
    27  `2006-01-02T15:04:05.999999999`, `2006-01-02Z07:00`, and `2006-01-02`. The local
    28  timezone on the client will be used if you do not provide either a `Z` or a
    29  `+-00:00` timezone offset at the end of the timestamp.  When providing Unix
    30  timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
    31  that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
    32  seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
    33  fraction of a second no more than nine digits long.
    34  
    35  # EXAMPLES
    36  
    37  ## Listening for Docker events
    38  
    39  After running docker events a container 786d698004576 is started and stopped
    40  (The container name has been shortened in the output below):
    41  
    42      # docker events
    43      2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) start
    44      2015-01-28T20:21:31.000000000-08:00 59211849bc10: (from whenry/testimage:latest) die
    45      2015-01-28T20:21:32.000000000-08:00 59211849bc10: (from whenry/testimage:latest) stop
    46  
    47  ## Listening for events since a given date
    48  Again the output container IDs have been shortened for the purposes of this document:
    49  
    50      # docker events --since '2015-01-28'
    51      2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
    52      2015-01-28T20:25:38.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
    53      2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) create
    54      2015-01-28T20:25:39.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
    55      2015-01-28T20:25:40.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
    56      2015-01-28T20:25:42.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
    57      2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) start
    58      2015-01-28T20:25:45.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) die
    59      2015-01-28T20:25:46.000000000-08:00 c21f6c22ba27: (from whenry/testimage:latest) stop
    60  
    61  The following example outputs all events that were generated in the last 3 minutes,
    62  relative to the current time on the client machine:
    63  
    64      # docker events --since '3m'
    65      2015-05-12T11:51:30.999999999Z07:00  4386fb97867d: (from ubuntu:22.04) die
    66      2015-05-12T15:52:12.999999999Z07:00  4386fb97867d: (from ubuntu:22.04) stop
    67      2015-05-12T15:53:45.999999999Z07:00  7805c1d35632: (from redis:2.8) die
    68      2015-05-12T15:54:03.999999999Z07:00  7805c1d35632: (from redis:2.8) stop
    69  
    70  If you do not provide the --since option, the command returns only new and/or
    71  live events.
    72  
    73  ## Format
    74  
    75  If a format (`--format`) is specified, the given template will be executed
    76  instead of the default format. Go's **text/template** package describes all the
    77  details of the format.
    78  
    79      # docker events --filter 'type=container' --format 'Type={{.Type}}  Status={{.Status}}  ID={{.ID}}'
    80      Type=container  Status=create  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    81      Type=container  Status=attach  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    82      Type=container  Status=start  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    83      Type=container  Status=resize  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    84      Type=container  Status=die  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    85      Type=container  Status=destroy  ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
    86  
    87  If a format is set to `{{json .}}`, the events are streamed as valid JSON
    88  Lines. For information about JSON Lines, please refer to http://jsonlines.org/ .
    89  
    90      # docker events --format '{{json .}}'
    91      {"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..
    92      {"status":"attach","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..
    93      {"Type":"network","Action":"connect","Actor":{"ID":"1b50a5bf755f6021dfa78e..
    94      {"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42..
    95      {"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..
    96  
    97  ## Filters
    98  
    99      $ docker events --filter 'event=stop'
   100      2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu:22.04)
   101      2014-09-03T17:42:14.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8)
   102  
   103      $ docker events --filter 'image=ubuntu:22.04'
   104      2014-05-10T17:42:14.999999999Z07:00 container start 4386fb97867d (image=ubuntu:22.04)
   105      2014-05-10T17:42:14.999999999Z07:00 container die 4386fb97867d (image=ubuntu:22.04)
   106      2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu:22.04)
   107  
   108      $ docker events --filter 'container=7805c1d35632'
   109      2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (image=redis:2.8)
   110      2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image= redis:2.8)
   111  
   112      $ docker events --filter 'container=7805c1d35632' --filter 'container=4386fb97867d'
   113      2014-09-03T15:49:29.999999999Z07:00 container die 4386fb97867d (image=ubuntu:22.04)
   114      2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu:22.04)
   115      2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (image=redis:2.8)
   116      2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8)
   117  
   118      $ docker events --filter 'container=7805c1d35632' --filter 'event=stop'
   119      2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8)
   120  
   121      $ docker events --filter 'type=volume'
   122      2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local)
   123      2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, destination=/foo, driver=local, propagation=rprivate)
   124      2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, driver=local)
   125      2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local)
   126  
   127      $ docker events --filter 'type=network'
   128      2015-12-23T21:38:24.705709133Z network create 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, type=bridge)
   129      2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge)
   130  
   131      $ docker events --filter 'type=plugin' (experimental)
   132      2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
   133      2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
   134