diff options
author | Ed Santiago <santiago@redhat.com> | 2022-09-14 13:05:32 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-09-15 05:17:25 -0600 |
commit | 9ba034293d28970734755d510a2df41290b8176d (patch) | |
tree | 96184a5a2bf98b30f4abdf85cc802944a475392e /docs/source/markdown/podman-pod-stats.1.md.in | |
parent | 2a8df49c2a65831fa2c253afa1ad2b5e1d618b09 (diff) | |
download | podman-9ba034293d28970734755d510a2df41290b8176d.tar.gz podman-9ba034293d28970734755d510a2df41290b8176d.tar.bz2 podman-9ba034293d28970734755d510a2df41290b8176d.zip |
Man pages: refactor common options: 2 stats opts
--no-reset and --no-stream, in podman-stats and pod-stats.
Very minor tweak to --no-stream to account for pods.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-stats.1.md.in')
-rw-r--r-- | docs/source/markdown/podman-pod-stats.1.md.in | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-pod-stats.1.md.in b/docs/source/markdown/podman-pod-stats.1.md.in new file mode 100644 index 000000000..83a4b7a1e --- /dev/null +++ b/docs/source/markdown/podman-pod-stats.1.md.in @@ -0,0 +1,88 @@ +% podman-pod-stats 1 + +## NAME +podman\-pod\-stats - Display a live stream of resource usage stats for containers in one or more pods + +## SYNOPSIS +**podman pod stats** [*options*] [*pod*] + +## DESCRIPTION +Display a live stream of containers in one or more pods resource usage statistics. Running rootless is only supported on cgroups v2. + +## OPTIONS + +#### **--all**, **-a** + +Show all containers. Only running containers are shown by default + +#### **--format**=*template* + +Pretty-print container statistics to JSON or using a Go template + +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | ------------------ | +| .Pod | Pod ID | +| .CID | Container ID | +| .Name | Container Name | +| .CPU | CPU percentage | +| .MemUsage | Memory usage | +| .MemUsageBytes | Memory usage (IEC) | +| .Mem | Memory percentage | +| .NetIO | Network IO | +| .BlockIO | Block IO | +| .PIDS | Number of PIDs | + +When using a GO template, you may precede the format with `table` to print headers. + +#### **--latest**, **-l** + +Instead of providing the pod name or ID, use the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) + +@@option no-reset + +@@option no-stream + +## EXAMPLE + +``` +# podman pod stats -a --no-stream +ID NAME CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS +a9f807ffaacd frosty_hodgkin -- 3.092MB / 16.7GB 0.02% -- / -- -- / -- 2 +3b33001239ee sleepy_stallman -- -- / -- -- -- / -- -- / -- -- +``` + +``` +# podman pod stats --no-stream a9f80 +ID NAME CPU % MEM USAGE / LIMIT MEM % NET IO BLOCK IO PIDS +a9f807ffaacd frosty_hodgkin -- 3.092MB / 16.7GB 0.02% -- / -- -- / -- 2 +``` + +``` +# podman pod stats --no-stream --format=json a9f80 +[ + { + "id": "a9f807ffaacd", + "name": "frosty_hodgkin", + "cpu_percent": "--", + "mem_usage": "3.092MB / 16.7GB", + "mem_percent": "0.02%", + "netio": "-- / --", + "blocki": "-- / --", + "pids": "2" + } +] +``` + +``` +# podman pod stats --no-stream --format "table {{.ID}} {{.Name}} {{.MemUsage}}" 6eae +ID NAME MEM USAGE / LIMIT +6eae9e25a564 clever_bassi 3.031MB / 16.7GB +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)** + +## HISTORY +February 2019, Originally compiled by Dan Walsh <dwalsh@redhat.com> |