273 lines
7.9 KiB
Groff
273 lines
7.9 KiB
Groff
'\" t
|
|
.nh
|
|
.TH podman-events 1
|
|
.SH NAME
|
|
podman-events \- Monitor Podman events
|
|
|
|
.SH SYNOPSIS
|
|
\fBpodman events\fP [\fIoptions\fP]
|
|
|
|
.PP
|
|
\fBpodman system events\fP [\fIoptions\fP]
|
|
|
|
.SH DESCRIPTION
|
|
Monitor and print events that occur in Podman. Each event includes a timestamp,
|
|
a type, a status, name (if applicable), and image (if applicable). The default logging
|
|
mechanism is \fIjournald\fP\&. This can be changed in containers.conf by changing the \fBevents_logger\fR
|
|
value to \fBfile\fR\&. Only \fBfile\fR and \fBjournald\fR are accepted. A \fBnone\fR logger is also
|
|
available, but this logging mechanism completely disables events; nothing is reported by
|
|
\fBpodman events\fR\&.
|
|
|
|
.PP
|
|
By default, streaming mode is used, printing new events as they occur. Previous events can be listed via \fB--since\fR and \fB--until\fR\&.
|
|
|
|
.PP
|
|
The \fIcontainer\fP event type reports the follow statuses:
|
|
* attach
|
|
* checkpoint
|
|
* cleanup
|
|
* commit
|
|
* connect
|
|
* create
|
|
* died
|
|
* disconnect
|
|
* exec
|
|
* exec_died
|
|
* exited
|
|
* export
|
|
* import
|
|
* init
|
|
* kill
|
|
* mount
|
|
* pause
|
|
* prune
|
|
* remove
|
|
* rename
|
|
* restart
|
|
* restore
|
|
* start
|
|
* stop
|
|
* sync
|
|
* unmount
|
|
* unpause
|
|
* update
|
|
|
|
.PP
|
|
The \fIpod\fP event type reports the follow statuses:
|
|
* create
|
|
* kill
|
|
* pause
|
|
* remove
|
|
* start
|
|
* stop
|
|
* unpause
|
|
|
|
.PP
|
|
The \fIimage\fP event type reports the following statuses:
|
|
* loadFromArchive,
|
|
* mount
|
|
* pull
|
|
* pull-error
|
|
* push
|
|
* remove
|
|
* save
|
|
* tag
|
|
* unmount
|
|
* untag
|
|
|
|
.PP
|
|
The \fIsystem\fP type reports the following statuses:
|
|
* refresh
|
|
* renumber
|
|
|
|
.PP
|
|
The \fIvolume\fP type reports the following statuses:
|
|
* create
|
|
* prune
|
|
* remove
|
|
|
|
.PP
|
|
The \fIsecret\fP type reports the following statuses:
|
|
* create
|
|
* remove
|
|
|
|
.SS Verbose Create Events
|
|
Setting \fBevents_container_create_inspect_data=true\fR in containers.conf(5) instructs Podman to create more verbose container-create events which include a JSON payload with detailed information about the containers. The JSON payload is identical to the one of podman-container-inspect(1). The associated field in journald is named \fBPODMAN_CONTAINER_INSPECT_DATA\fR\&.
|
|
|
|
.SH OPTIONS
|
|
.SS \fB--filter\fP, \fB-f\fP=\fIfilter\fP
|
|
Filter events that are displayed. They must be in the format of "filter=value". The following
|
|
filters are supported:
|
|
|
|
.TS
|
|
allbox;
|
|
l l
|
|
l l .
|
|
\fB\fBFilter\fP\fP \fB\fBDescription\fP\fP
|
|
container T{
|
|
[Name or ID] Container's name or ID
|
|
T}
|
|
event event_status (described above)
|
|
image [Name or ID] Image name or ID
|
|
label [key=value] label
|
|
pod [Name or ID] Pod name or ID
|
|
volume [Name or ID] Volume name or ID
|
|
type Event_type (described above)
|
|
.TE
|
|
|
|
.PP
|
|
In the case where an ID is used, the ID may be in its full or shortened form. The "die" event is mapped to "died" for Docker compatibility.
|
|
|
|
.SS \fB--format\fP
|
|
Format the output to JSON Lines or using the given Go template.
|
|
|
|
.TS
|
|
allbox;
|
|
l l
|
|
l l .
|
|
\fB\fBPlaceholder\fP\fP \fB\fBDescription\fP\fP
|
|
\&.Attributes ... T{
|
|
created_at, _by, labels, and more (map[])
|
|
T}
|
|
\&.ContainerExitCode Exit code (int)
|
|
\&.ContainerInspectData T{
|
|
Payload of the container's inspect
|
|
T}
|
|
\&.Error T{
|
|
Error message in case the event status is an error (e.g. pull-error)
|
|
T}
|
|
\&.HealthStatus Health Status (string)
|
|
\&.ID Container ID (full 64-bit SHA)
|
|
\&.Image T{
|
|
Name of image being run (string)
|
|
T}
|
|
\&.Name Container name (string)
|
|
\&.Network T{
|
|
Name of network being used (string)
|
|
T}
|
|
\&.PodID T{
|
|
ID of pod associated with container, if any
|
|
T}
|
|
\&.Status T{
|
|
Event status (e.g., create, start, died, ...)
|
|
T}
|
|
\&.Time Event timestamp (string)
|
|
\&.TimeNano T{
|
|
Event timestamp with nanosecond precision (int64)
|
|
T}
|
|
\&.Type T{
|
|
Event type (e.g., image, container, pod, ...)
|
|
T}
|
|
.TE
|
|
|
|
.SS \fB--help\fP
|
|
Print usage statement.
|
|
|
|
.SS \fB--no-trunc\fP
|
|
Do not truncate the output (default \fItrue\fP).
|
|
|
|
.SS \fB--since\fP=\fItimestamp\fP
|
|
Show all events created since the given timestamp
|
|
|
|
.SS \fB--stream\fP
|
|
Stream events and do not exit after reading the last known event (default \fItrue\fP).
|
|
|
|
.SS \fB--until\fP=\fItimestamp\fP
|
|
Show all events created until the given timestamp
|
|
|
|
.PP
|
|
The \fIsince\fP and \fIuntil\fP values can be RFC3339Nano time stamps or a Go duration string such as 10m, 5h. If no
|
|
\fIsince\fP or \fIuntil\fP values are provided, only new events are shown.
|
|
|
|
.SH JOURNALD IDENTIFIERS
|
|
The journald events-backend of Podman uses the following journald identifiers. You can use the identifiers to filter Podman events directly with \fBjournalctl\fR\&.
|
|
|
|
.TS
|
|
allbox;
|
|
l l
|
|
l l .
|
|
\fB\fBIdentifier\fP\fP \fB\fBDescription\fP\fP
|
|
SYSLOG_IDENTIFIER Always set to "podman"
|
|
PODMAN_EVENT T{
|
|
The event status as described above
|
|
T}
|
|
PODMAN_TYPE T{
|
|
The event type as described above
|
|
T}
|
|
PODMAN_TIME T{
|
|
The time stamp when the event was written
|
|
T}
|
|
PODMAN_NAME T{
|
|
Name of the event object (e.g., container, image)
|
|
T}
|
|
PODMAN_ID T{
|
|
ID of the event object (e.g., container, image)
|
|
T}
|
|
PODMAN_EXIT_CODE Exit code of the container
|
|
PODMAN_POD_ID Pod ID of the container
|
|
PODMAN_LABELS Labels of the container
|
|
PODMAN_HEALTH_STATUS Health status of the container
|
|
PODMAN_CONTAINER_INSPECT_DATA The JSON payload of \fBpodman-inspect\fR as described above
|
|
PODMAN_NETWORK_NAME The name of the network
|
|
.TE
|
|
|
|
.SH EXAMPLES
|
|
Show Podman events:
|
|
|
|
.EX
|
|
$ podman events
|
|
2019-03-02 10:33:42.312377447 -0600 CST container create 34503c192940 (image=docker.io/library/alpine:latest, name=friendly_allen)
|
|
2019-03-02 10:33:46.958768077 -0600 CST container init 34503c192940 (image=docker.io/library/alpine:latest, name=friendly_allen)
|
|
2019-03-02 10:33:46.973661968 -0600 CST container start 34503c192940 (image=docker.io/library/alpine:latest, name=friendly_allen)
|
|
2019-03-02 10:33:50.833761479 -0600 CST container stop 34503c192940 (image=docker.io/library/alpine:latest, name=friendly_allen)
|
|
2019-03-02 10:33:51.047104966 -0600 CST container cleanup 34503c192940 (image=docker.io/library/alpine:latest, name=friendly_allen)
|
|
.EE
|
|
|
|
.PP
|
|
Show only Podman container create events:
|
|
|
|
.EX
|
|
$ podman events -f event=create
|
|
2019-03-02 10:36:01.375685062 -0600 CST container create 20dc581f6fbf (image=docker.io/library/alpine:latest, name=sharp_morse)
|
|
2019-03-02 10:36:08.561188337 -0600 CST container create 58e7e002344c (image=registry.k8s.io/pause:3.1, name=3e701f270d54-infra)
|
|
2019-03-02 10:36:13.146899437 -0600 CST volume create cad6dc50e087 (image=, name=cad6dc50e0879568e7d656bd004bd343d6035e7fc4024e1711506fe2fd459e6f)
|
|
2019-03-02 10:36:29.978806894 -0600 CST container create d81e30f1310f (image=docker.io/library/busybox:latest, name=musing_newton)
|
|
.EE
|
|
|
|
.PP
|
|
Show only Podman pod create events:
|
|
|
|
.EX
|
|
$ podman events --filter event=create --filter type=pod
|
|
2019-03-02 10:44:29.601746633 -0600 CST pod create 1df5ebca7b44 (image=, name=confident_hawking)
|
|
2019-03-02 10:44:42.374637304 -0600 CST pod create ca731231718e (image=, name=webapp)
|
|
2019-03-02 10:44:47.486759133 -0600 CST pod create 71e807fc3a8e (image=, name=reverent_swanson)
|
|
.EE
|
|
|
|
.PP
|
|
Show only Podman events created in the last five minutes:
|
|
|
|
.EX
|
|
$ sudo podman events --since 5m
|
|
2019-03-02 10:44:29.598835409 -0600 CST container create b629d10d3831 (image=registry.k8s.io/pause:3.1, name=1df5ebca7b44-infra)
|
|
2019-03-02 10:44:29.601746633 -0600 CST pod create 1df5ebca7b44 (image=, name=confident_hawking)
|
|
2019-03-02 10:44:42.371100253 -0600 CST container create 170a0f457d00 (image=registry.k8s.io/pause:3.1, name=ca731231718e-infra)
|
|
2019-03-02 10:44:42.374637304 -0600 CST pod create ca731231718e (image=, name=webapp)
|
|
.EE
|
|
|
|
.PP
|
|
Show Podman events in JSON Lines format:
|
|
|
|
.EX
|
|
$ podman events --format json
|
|
{"ID":"683b0909d556a9c02fa8cd2b61c3531a965db42158627622d1a67b391964d519","Image":"localhost/myshdemo:latest","Name":"agitated_diffie","Status":"cleanup","Time":"2019-04-27T22:47:00.849932843-04:00","Type":"container"}
|
|
{"ID":"a0f8ab051bfd43f9c5141a8a2502139707e4b38d98ac0872e57c5315381e88ad","Image":"docker.io/library/alpine:latest","Name":"friendly_tereshkova","Status":"unmount","Time":"2019-04-28T13:43:38.063017276-04:00","Type":"container"}
|
|
.EE
|
|
|
|
.SH SEE ALSO
|
|
\fBpodman(1)\fP, \fBcontainers.conf(5)\fP
|
|
|
|
.SH HISTORY
|
|
March 2019, Originally compiled by Brent Baude bbaude@redhat.com
|
|
\[la]mailto:bbaude@redhat.com\[ra]
|