docker_compose_events.yaml 1.9 KB

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