mirror of
https://github.com/containers/podman.git
synced 2025-06-05 05:57:24 +08:00
ad7c54e13a
Followup to #14906, in which a nonexistent option was found in a man page. The xref script was designed to catch that, but I was too lax in my parsing: the option was documented using wrong syntax, and the script didn't catch it. Solution: do not allow *any* unrecognized cruft in the option description lines. And fix all improperly-written entries to conform to the rule: **--option**=*value(s)* Two asterisks around option, which must have two dashes. One asterisk around value(s). This is going to cause headaches for some people adding new options, but I don't think I can fix that: there are many factors that make an unparseable line. Adding 'hint' code would make the script even more complex than it is. I have to assume that our contributors are smart enough to look at surrounding context and figure out the right way to specify options. Signed-off-by: Ed Santiago <santiago@redhat.com>
112 lines
3.3 KiB
Markdown
112 lines
3.3 KiB
Markdown
% 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
|
|
|
|
#### **--format**=*template*
|
|
|
|
Pretty-print container statistics to JSON or using a Go template
|
|
|
|
Valid placeholders for the Go template are listed below:
|
|
|
|
| **Placeholder** | **Description** |
|
|
| --------------- | ------------------ |
|
|
| .ID | Container ID |
|
|
| .Name | Container Name |
|
|
| .CPUPerc | CPU percentage |
|
|
| .MemUsage | Memory usage |
|
|
| .MemUsageBytes | Memory usage (IEC) |
|
|
| .MemPerc | 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.
|
|
|
|
#### **--interval**, **-i**=*seconds*
|
|
|
|
Time in seconds between stats reports, defaults to 5 seconds.
|
|
|
|
#### **--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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
|
|
|
|
#### **--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
|
|
|
|
## 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
|
|
```
|
|
|
|
Note: When using a slirp4netns network with the rootlesskit port
|
|
handler, the traffic send via the port forwarding will be accounted to
|
|
the `lo` device. Traffic accounted to `lo` is not accounted in the
|
|
stats output.
|
|
|
|
|
|
## SEE ALSO
|
|
**[podman(1)](podman.1.md)**
|
|
|
|
## HISTORY
|
|
July 2017, Originally compiled by Ryan Cole <rycole@redhat.com>
|