diff options
| author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
|---|---|---|
| committer | baude <bbaude@redhat.com> | 2019-10-31 12:31:39 -0500 |
| commit | 52b92023edeba3a5e2c466d92d742e54b14a85cb (patch) | |
| tree | 44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/podman-stats.1.md | |
| parent | 5af166ff513265b17aee92a9ce3a1522090d7dec (diff) | |
| download | podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2 podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip | |
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man
pages now exist in docs/source/man and the sphinx make files exists in
docs.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-stats.1.md')
| -rw-r--r-- | docs/podman-stats.1.md | 103 |
1 files changed, 0 insertions, 103 deletions
diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md deleted file mode 100644 index 741873c3f..000000000 --- a/docs/podman-stats.1.md +++ /dev/null @@ -1,103 +0,0 @@ -% podman-stats(1) - -## NAME -podman\-stats - Display a live stream of one or more container's resource usage statistics - -## SYNOPSIS -**podman stats** [*options*] [*container*] - -**podman container stats** [*options*] [*container*] - -## DESCRIPTION -Display a live stream of one or more containers' resource usage statistics - -Note: Podman stats will not work in rootless environments that use CGroups V1. -Podman stats relies on CGroup information for statistics, and CGroup v1 is not -supported for rootless use cases. - -Note: Rootless environments that use CGroups V2 are not able to report statistics -about their networking usage. - -## OPTIONS - -**--all**, **-a** - -Show all containers. Only running containers are shown by default - -**--latest**, **-l** - -Instead of providing the container name or ID, use the last created container. If you use methods other than Podman -to run containers such as CRI-O, the last started container could be from either of those methods. - -The latest option is not supported on the remote client. - -**--no-reset** - -Do not clear the terminal/screen in between reporting intervals - -**--no-stream** - -Disable streaming stats and only pull the first result, default setting is false - -**--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 | -| .ID | Container ID | -| .Name | Container Name | -| .CPU | CPU percentage | -| .MemUsage | Memory usage | -| .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. - -## EXAMPLE - -``` -# podman 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 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 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 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) - -## HISTORY -July 2017, Originally compiled by Ryan Cole <rycole@redhat.com> |