diff options
Diffstat (limited to 'devdocs/docker/engine%2Freference%2Fcommandline%2Fsystem_events%2Findex.html')
| -rw-r--r-- | devdocs/docker/engine%2Freference%2Fcommandline%2Fsystem_events%2Findex.html | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/devdocs/docker/engine%2Freference%2Fcommandline%2Fsystem_events%2Findex.html b/devdocs/docker/engine%2Freference%2Fcommandline%2Fsystem_events%2Findex.html new file mode 100644 index 00000000..1d27fadb --- /dev/null +++ b/devdocs/docker/engine%2Freference%2Fcommandline%2Fsystem_events%2Findex.html @@ -0,0 +1,146 @@ +<h1>docker system events</h1> <p><br></p> <p>Get real time events from the server</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker system events [OPTIONS] +</pre></div> <p>Refer to the <a href="#options">options section</a> for an overview of available <a href="#options"><code class="language-plaintext highlighter-rouge">OPTIONS</code></a> for this command.</p> <h2 id="description">Description</h2> <p name="extended-description">Use <code class="language-plaintext highlighter-rouge">docker system events</code> to get real-time events from the server. These events differ per Docker object type.</p> <h3 id="object-types">Object types</h3> <h4 id="containers">Containers</h4> <p>Docker containers report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">attach</code></li> <li><code class="language-plaintext highlighter-rouge">commit</code></li> <li><code class="language-plaintext highlighter-rouge">copy</code></li> <li><code class="language-plaintext highlighter-rouge">create</code></li> <li><code class="language-plaintext highlighter-rouge">destroy</code></li> <li><code class="language-plaintext highlighter-rouge">detach</code></li> <li><code class="language-plaintext highlighter-rouge">die</code></li> <li><code class="language-plaintext highlighter-rouge">exec_create</code></li> <li><code class="language-plaintext highlighter-rouge">exec_detach</code></li> <li><code class="language-plaintext highlighter-rouge">exec_start</code></li> <li><code class="language-plaintext highlighter-rouge">export</code></li> <li><code class="language-plaintext highlighter-rouge">health_status</code></li> <li><code class="language-plaintext highlighter-rouge">kill</code></li> <li><code class="language-plaintext highlighter-rouge">oom</code></li> <li><code class="language-plaintext highlighter-rouge">pause</code></li> <li><code class="language-plaintext highlighter-rouge">rename</code></li> <li><code class="language-plaintext highlighter-rouge">resize</code></li> <li><code class="language-plaintext highlighter-rouge">restart</code></li> <li><code class="language-plaintext highlighter-rouge">start</code></li> <li><code class="language-plaintext highlighter-rouge">stop</code></li> <li><code class="language-plaintext highlighter-rouge">top</code></li> <li><code class="language-plaintext highlighter-rouge">unpause</code></li> <li><code class="language-plaintext highlighter-rouge">update</code></li> </ul> <h4 id="images">Images</h4> <p>Docker images report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">delete</code></li> <li><code class="language-plaintext highlighter-rouge">import</code></li> <li><code class="language-plaintext highlighter-rouge">load</code></li> <li><code class="language-plaintext highlighter-rouge">pull</code></li> <li><code class="language-plaintext highlighter-rouge">push</code></li> <li><code class="language-plaintext highlighter-rouge">save</code></li> <li><code class="language-plaintext highlighter-rouge">tag</code></li> <li><code class="language-plaintext highlighter-rouge">untag</code></li> </ul> <h4 id="plugins">Plugins</h4> <p>Docker plugins report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">install</code></li> <li><code class="language-plaintext highlighter-rouge">enable</code></li> <li><code class="language-plaintext highlighter-rouge">disable</code></li> <li><code class="language-plaintext highlighter-rouge">remove</code></li> </ul> <h4 id="volumes">Volumes</h4> <p>Docker volumes report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">create</code></li> <li><code class="language-plaintext highlighter-rouge">mount</code></li> <li><code class="language-plaintext highlighter-rouge">unmount</code></li> <li><code class="language-plaintext highlighter-rouge">destroy</code></li> </ul> <h4 id="networks">Networks</h4> <p>Docker networks report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">create</code></li> <li><code class="language-plaintext highlighter-rouge">connect</code></li> <li><code class="language-plaintext highlighter-rouge">disconnect</code></li> <li><code class="language-plaintext highlighter-rouge">destroy</code></li> </ul> <h4 id="daemons">Daemons</h4> <p>Docker daemons report the following events:</p> <ul> <li><code class="language-plaintext highlighter-rouge">reload</code></li> </ul> <h3 id="limiting-filtering-and-formatting-the-output">Limiting, filtering, and formatting the output</h3> <h4 id="limit-events-by-time">Limit events by time</h4> <p>The <code class="language-plaintext highlighter-rouge">--since</code> and <code class="language-plaintext highlighter-rouge">--until</code> parameters can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. <code class="language-plaintext highlighter-rouge">10m</code>, <code class="language-plaintext highlighter-rouge">1h30m</code>) computed relative to the client machine’s time. If you do not provide the <code class="language-plaintext highlighter-rouge">--since</code> option, the command returns only new and/or live events. Supported formats for date formatted time stamps include RFC3339Nano, RFC3339, <code class="language-plaintext highlighter-rouge">2006-01-02T15:04:05</code>, <code class="language-plaintext highlighter-rouge">2006-01-02T15:04:05.999999999</code>, <code class="language-plaintext highlighter-rouge">2006-01-02Z07:00</code>, and <code class="language-plaintext highlighter-rouge">2006-01-02</code>. The local timezone on the client will be used if you do not provide either a <code class="language-plaintext highlighter-rouge">Z</code> or a <code class="language-plaintext highlighter-rouge">+-00:00</code> timezone offset at the end of the timestamp. When providing Unix timestamps enter seconds[.nanoseconds], where seconds is the number of seconds 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.</p> <h4 id="filtering">Filtering</h4> <p>The filtering flag (<code class="language-plaintext highlighter-rouge">-f</code> or <code class="language-plaintext highlighter-rouge">--filter</code>) format is of “key=value”. If you would like to use multiple filters, pass multiple flags (e.g., <code class="language-plaintext highlighter-rouge">--filter "foo=bar" --filter "bif=baz"</code>)</p> <p>Using the same filter multiple times will be handled as a <em>OR</em>; for example <code class="language-plaintext highlighter-rouge">--filter container=588a23dac085 --filter container=a8f7720b8c22</code> will display events for container 588a23dac085 <em>OR</em> container a8f7720b8c22</p> <p>Using multiple filters will be handled as a <em>AND</em>; for example <code class="language-plaintext highlighter-rouge">--filter container=588a23dac085 --filter event=start</code> will display events for container container 588a23dac085 <em>AND</em> the event type is <em>start</em></p> <p>The currently supported filters are:</p> <ul> <li>container (<code class="language-plaintext highlighter-rouge">container=<name or id></code>)</li> <li>daemon (<code class="language-plaintext highlighter-rouge">daemon=<name or id></code>)</li> <li>event (<code class="language-plaintext highlighter-rouge">event=<event action></code>)</li> <li>image (<code class="language-plaintext highlighter-rouge">image=<tag or id></code>)</li> <li>label (<code class="language-plaintext highlighter-rouge">label=<key></code> or <code class="language-plaintext highlighter-rouge">label=<key>=<value></code>)</li> <li>network (<code class="language-plaintext highlighter-rouge">network=<name or id></code>)</li> <li>plugin (<code class="language-plaintext highlighter-rouge">plugin=<name or id></code>)</li> <li>type (<code class="language-plaintext highlighter-rouge">type=<container or image or volume or network or daemon or plugin></code>)</li> <li>volume (<code class="language-plaintext highlighter-rouge">volume=<name or id></code>)</li> </ul> <h4 id="format">Format</h4> <p>If a format (<code class="language-plaintext highlighter-rouge">--format</code>) is specified, the given template will be executed instead of the default format. Go’s <a href="https://golang.org/pkg/text/template/">text/template</a> package describes all the details of the format.</p> <p>If a format is set to <code class="language-plaintext highlighter-rouge">{{json .}}</code>, the events are streamed as valid JSON Lines. For information about JSON Lines, please refer to https://jsonlines.org/ .</p> <p>For example uses of this command, refer to the <a href="#examples">examples section</a> below.</p> <h2 id="options">Options</h2> <table> <thead> <tr> <td>Name, shorthand</td> <td>Default</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td> +<code class="language-plaintext highlighter-rouge">--filter</code> , <code class="language-plaintext highlighter-rouge">-f</code> +</td> <td></td> <td>Filter output based on conditions provided</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--format</code></td> <td></td> <td>Format the output using the given Go template</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--since</code></td> <td></td> <td>Show all events created since timestamp</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--until</code></td> <td></td> <td>Stream events until this timestamp</td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <h3 id="basic-example">Basic example</h3> <p>You’ll need two shells for this example.</p> <p><strong>Shell 1: Listening for events:</strong></p> <div class="highlight"><pre class="highlight" data-language="">$ docker system events +</pre></div> <p><strong>Shell 2: Start and Stop containers:</strong></p> <div class="highlight"><pre class="highlight" data-language="">$ docker create --name test alpine:latest top +$ docker start test +$ docker stop test +</pre></div> <p><strong>Shell 1: (Again .. now showing events):</strong></p> <div class="highlight"><pre class="highlight" data-language="">2017-01-05T00:35:58.859401177+08:00 container create 0fdb48addc82871eb34eb23a847cfd033dedd1a0a37bef2e6d9eb3870fc7ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:04.703631903+08:00 network connect e2e1f5ceda09d4300f3a846f0acfaa9a8bb0d89e775eb744c5acecd60e0529e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) +</pre></div> <p>To exit the <code class="language-plaintext highlighter-rouge">docker system events</code> command, use <code class="language-plaintext highlighter-rouge">CTRL+C</code>.</p> <h3 id="filter-events-by-time">Filter events by time</h3> <p>You can filter the output by an absolute timestamp or relative time on the host machine, using the following different time syntaxes:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker system events --since 1483283804 + +2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local) +2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test) +2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) + +$ docker system events --since '2017-01-05' + +2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local) +2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test) +2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) + +$ docker system events --since '2013-09-03T15:49:29' + +2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local) +2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test) +2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) + +$ docker system events --since '10m' + +2017-01-05T00:35:41.241772953+08:00 volume create testVol (driver=local) +2017-01-05T00:35:58.859401177+08:00 container create d9cd...4d70 (image=alpine:latest, name=test) +2017-01-05T00:36:04.703631903+08:00 network connect e2e1...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:04.795031609+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:36:09.830268747+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:36:09.840186338+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:36:09.880113663+08:00 network disconnect e2e...29e2 (container=0fdb...ff37, name=bridge, type=bridge) +2017-01-05T00:36:09.890214053+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) +</pre></div> <h3 id="filter-events-by-criteria">Filter events by criteria</h3> <p>The following commands show several different ways to filter the <code class="language-plaintext highlighter-rouge">docker event</code> output.</p> <div class="highlight"><pre class="highlight" data-language="">$ docker system events --filter 'event=stop' + +2017-01-05T00:40:22.880175420+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:41:17.888104182+08:00 container stop 2a8f...4e78 (image=alpine, name=kickass_brattain) + +$ docker system events --filter 'image=alpine' + +2017-01-05T00:41:55.784240236+08:00 container create d9cd...4d70 (image=alpine, name=happy_meitner) +2017-01-05T00:41:55.913156783+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) +2017-01-05T00:42:01.106875249+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=15) +2017-01-05T00:42:11.111934041+08:00 container kill d9cd...4d70 (image=alpine, name=happy_meitner, signal=9) +2017-01-05T00:42:11.119578204+08:00 container die d9cd...4d70 (exitCode=137, image=alpine, name=happy_meitner) +2017-01-05T00:42:11.173276611+08:00 container stop d9cd...4d70 (image=alpine, name=happy_meitner) + +$ docker system events --filter 'container=test' + +2017-01-05T00:43:00.139719934+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:43:09.259951086+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=15) +2017-01-05T00:43:09.270102715+08:00 container die 0fdb...ff37 (exitCode=143, image=alpine:latest, name=test) +2017-01-05T00:43:09.312556440+08:00 container stop 0fdb...ff37 (image=alpine:latest, name=test) + +$ docker system events --filter 'container=test' --filter 'container=d9cdb1525ea8' + +2017-01-05T00:44:11.517071981+08:00 container start 0fdb...ff37 (image=alpine:latest, name=test) +2017-01-05T00:44:17.685870901+08:00 container start d9cd...4d70 (image=alpine, name=happy_meitner) +2017-01-05T00:44:29.757658470+08:00 container kill 0fdb...ff37 (image=alpine:latest, name=test, signal=9) +2017-01-05T00:44:29.767718510+08:00 container die 0fdb...ff37 (exitCode=137, image=alpine:latest, name=test) +2017-01-05T00:44:29.815798344+08:00 container destroy 0fdb...ff37 (image=alpine:latest, name=test) + +$ docker system events --filter 'container=test' --filter 'event=stop' + +2017-01-05T00:46:13.664099505+08:00 container stop a9d1...e130 (image=alpine, name=test) + +$ docker system events --filter 'type=volume' + +2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) +2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562f...5025, destination=/foo, driver=local, propagation=rprivate) +2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562f...5025, driver=local) +2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) + +$ docker system events --filter 'type=network' + +2015-12-23T21:38:24.705709133Z network create 8b11...2c5b (name=test-event-network-local, type=bridge) +2015-12-23T21:38:25.119625123Z network connect 8b11...2c5b (name=test-event-network-local, container=b4be...c54e, type=bridge) + +$ docker system events --filter 'container=container_1' --filter 'container=container_2' + +2014-09-03T15:49:29.999999999Z07:00 container die 4386fb97867d (image=ubuntu-1:14.04) +2014-05-10T17:42:14.999999999Z07:00 container stop 4386fb97867d (image=ubuntu-1:14.04) +2014-05-10T17:42:14.999999999Z07:00 container die 7805c1d35632 (imager=redis:2.8) +2014-09-03T15:49:29.999999999Z07:00 container stop 7805c1d35632 (image=redis:2.8) + +$ docker system events --filter 'type=volume' + +2015-12-23T21:05:28.136212689Z volume create test-event-volume-local (driver=local) +2015-12-23T21:05:28.383462717Z volume mount test-event-volume-local (read/write=true, container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, destination=/foo, driver=local, propagation=rprivate) +2015-12-23T21:05:28.650314265Z volume unmount test-event-volume-local (container=562fe10671e9273da25eed36cdce26159085ac7ee6707105fd534866340a5025, driver=local) +2015-12-23T21:05:28.716218405Z volume destroy test-event-volume-local (driver=local) + +$ docker system events --filter 'type=network' + +2015-12-23T21:38:24.705709133Z network create 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, type=bridge) +2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge) + +$ docker system events --filter 'type=plugin' + +2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) +2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest) +</pre></div> <h3 id="format-the-output">Format the output</h3> <div class="highlight"><pre class="highlight" data-language="">$ docker system events --filter 'type=container' --format 'Type={{.Type}} Status={{.Status}} ID={{.ID}}' + +Type=container Status=create ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +Type=container Status=attach ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +Type=container Status=start ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +Type=container Status=resize ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +Type=container Status=die ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26 +</pre></div> <h4 id="format-as-json">Format as JSON</h4> <div class="highlight"><pre class="highlight" data-language="">$ docker system events --format '{{json .}}' + +{"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. +{"status":"attach","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. +{"Type":"network","Action":"connect","Actor":{"ID":"1b50a5bf755f6021dfa78e.. +{"status":"start","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f42.. +{"status":"resize","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4.. +</pre></div> <h2 id="parent-command">Parent command</h2> <table> <thead> <tr> <th style="text-align: left">Command</th> <th style="text-align: left">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left"><a href="../system/index">docker system</a></td> <td style="text-align: left">Manage Docker</td> </tr> </tbody> </table> <h2 id="related-commands">Related commands</h2> <table> <thead> <tr> <td>Command</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td><a href="../system_df/index">docker system df</a></td> <td>Show docker disk usage</td> </tr> <tr> <td><a href="index">docker system events</a></td> <td>Get real time events from the server</td> </tr> <tr> <td><a href="../system_info/index">docker system info</a></td> <td>Display system-wide information</td> </tr> <tr> <td><a href="../system_prune/index">docker system prune</a></td> <td>Remove unused data</td> </tr> </tbody> </table> <div class="_attribution"> + <p class="_attribution-p"> + © 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br> + <a href="https://docs.docker.com/engine/reference/commandline/system_events/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/system_events/</a> + </p> +</div> |