| 1 |
command: docker compose events |
| 2 |
short: Receive real time events from containers |
| 3 |
long: |- |
| 4 |
Stream container events for every container in the project. |
| 5 |
|
| 6 |
With the `--json` flag, a json object is printed one per line with the format: |
| 7 |
|
| 8 |
```json |
| 9 |
{ |
| 10 |
"time": "2015-11-20T18:01:03.615550", |
| 11 |
"type": "container", |
| 12 |
"action": "create", |
| 13 |
"id": "213cf7...5fc39a", |
| 14 |
"service": "web", |
| 15 |
"attributes": { |
| 16 |
"name": "application_web_1", |
| 17 |
"image": "alpine:edge" |
| 18 |
} |
| 19 |
} |
| 20 |
``` |
| 21 |
|
| 22 |
The events that can be received using this can be seen [here](/reference/cli/docker/system/events/#object-types). |
| 23 |
usage: docker compose events [OPTIONS] [SERVICE...] |
| 24 |
pname: docker compose |
| 25 |
plink: docker_compose.yaml |
| 26 |
options: |
| 27 |
- option: json |
| 28 |
value_type: bool |
| 29 |
default_value: "false" |
| 30 |
description: Output events as a stream of json objects |
| 31 |
deprecated: false |
| 32 |
hidden: false |
| 33 |
experimental: false |
| 34 |
experimentalcli: false |
| 35 |
kubernetes: false |
| 36 |
swarm: false |
| 37 |
- option: since |
| 38 |
value_type: string |
| 39 |
description: Show all events created since timestamp |
| 40 |
deprecated: false |
| 41 |
hidden: false |
| 42 |
experimental: false |
| 43 |
experimentalcli: false |
| 44 |
kubernetes: false |
| 45 |
swarm: false |
| 46 |
- option: until |
| 47 |
value_type: string |
| 48 |
description: Stream events until this timestamp |
| 49 |
deprecated: false |
| 50 |
hidden: false |
| 51 |
experimental: false |
| 52 |
experimentalcli: false |
| 53 |
kubernetes: false |
| 54 |
swarm: false |
| 55 |
inherited_options: |
| 56 |
- option: dry-run |
| 57 |
value_type: bool |
| 58 |
default_value: "false" |
| 59 |
description: Execute command in dry run mode |
| 60 |
deprecated: false |
| 61 |
hidden: false |
| 62 |
experimental: false |
| 63 |
experimentalcli: false |
| 64 |
kubernetes: false |
| 65 |
swarm: false |
| 66 |
deprecated: false |
| 67 |
hidden: false |
| 68 |
experimental: false |
| 69 |
experimentalcli: false |
| 70 |
kubernetes: false |
| 71 |
swarm: false |
| 72 |
|