summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-stats.1.md.in
blob: a14bd81e642286d14ecec791555cc5371841f32d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
% 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**                                  |
|---------------------|--------------------------------------------------|
| .AvgCPU             | Average CPU, full precision float                |
| .AVGCPU             | Average CPU, formatted as a percent              |
| .BlockInput         | Block Input                                      |
| .BlockIO            | Block IO                                         |
| .BlockOutput        | Block Output                                     |
| .ContainerID        | Container ID, full (untruncated) hash            |
| .ContainerStats ... | Nested structure, for experts only               |
| .CPU                | Percent CPU, full precision float                |
| .CPUNano            | CPU Usage, total, in nanoseconds                 |
| .CPUPerc            | CPU percentage                                   |
| .CPUSystemNano      | CPU Usage, kernel, in nanoseconds                |
| .Duration           | Same as CPUNano                                  |
| .ID                 | Container ID, truncated                          |
| .MemLimit           | Memory limit, in bytes                           |
| .MemPerc            | Memory percentage                                |
| .MemUsage           | Memory usage                                     |
| .MemUsageBytes      | Memory usage (IEC)                               |
| .Name               | Container Name                                   |
| .NetInput           | Network Input                                    |
| .NetIO              | Network IO                                       |
| .NetOutput          | Network Output                                   |
| .PerCPU             | CPU time consumed by all tasks [1]               |
| .PIDs               | Number of PIDs                                   |
| .PIDS               | Number of PIDs (yes, we know it's a dup)         |
| .SystemNano         | Current system datetime, nanoseconds since epoch |
| .Up                 | Duration (CPUNano), in human-readable form       |
| .UpTime             | Same as UpTime                                   |

[1] Cgroups V1 only

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)

@@option no-reset

@@option no-stream

#### **--no-trunc**

Do not truncate output

## 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-trunc 3667 --format 'table {{ .ID }} {{ .MemUsage }}'
ID                                                                MEM USAGE / LIMIT
3667c6aacb06aac2eaffce914c01736420023d56ef9b0f4cfe58b6d6a78b7503  49.15kB / 67.17GB
```

```
# 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>