podman/docs/podman-stats.1.md at 1c0cd0796abd4230dbab1f7ed33212c78ecce11f

mirror of https://github.com/containers/podman synced 2024-10-21 01:34:37 +00:00

W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS

man-pages(7) has [1]:

> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.

I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project.  Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #1027
Approved by: rhatdan

2018-07-04 09:40:37 +00:00

2.4 KiB

Raw Blame History

% podman-stats "1"

NAME

podman-stats - Display a live stream of 1 or more containers' resource usage statistics

SYNOPSIS

podman stats [options] [container]

DESCRIPTION

Display a live stream of one or more containers' resource usage statistics

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.

--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
.ID	Container ID
.Name	Container Name
.CPUPerc	CPU percentage
.MemUsage	Memory usage
.MemPerc	Memory percentage
.NetIO	Network IO
.BlockIO	Block IO
.PIDS	Number of PIDs

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

HISTORY

July 2017, Originally compiled by Ryan Cole rycole@redhat.com

2.4 KiB Raw Blame History