github.com/yogeshlonkar/moby@v1.13.2-0.20201203103638-c0b64beaea94/docs/reference/commandline/stats.md (about)

     1  ---
     2  title: "stats"
     3  description: "The stats command description and usage"
     4  keywords: "container, resource, statistics"
     5  ---
     6  
     7  <!-- This file is maintained within the docker/docker Github
     8       repository at https://github.com/docker/docker/. Make all
     9       pull requests against that repo. If you see this file in
    10       another repository, consider it read-only there, as it will
    11       periodically be overwritten by the definitive file. Pull
    12       requests which include edits to this file in other repositories
    13       will be rejected.
    14  -->
    15  
    16  # stats
    17  
    18  ```markdown
    19  Usage:  docker stats [OPTIONS] [CONTAINER...]
    20  
    21  Display a live stream of container(s) resource usage statistics
    22  
    23  Options:
    24    -a, --all             Show all containers (default shows just running)
    25        --format string   Pretty-print images using a Go template
    26        --help            Print usage
    27        --no-stream       Disable streaming stats and only pull the first result
    28  ```
    29  
    30  ## Description
    31  
    32  The `docker stats` command returns a live data stream for running containers. To limit data to one or more specific containers, specify a list of container names or ids separated by a space. You can specify a stopped container but stopped containers do not return any data.
    33  
    34  If you want more detailed information about a container's resource usage, use the `/containers/(id)/stats` API endpoint.
    35  
    36  ## Examples
    37  
    38  Running `docker stats` on all running containers against a Linux daemon.
    39  
    40  ```bash
    41  $ docker stats
    42  CONTAINER           CPU %               MEM USAGE / LIMIT     MEM %               NET I/O             BLOCK I/O
    43  1285939c1fd3        0.07%               796 KiB / 64 MiB        1.21%               788 B / 648 B       3.568 MB / 512 KB
    44  9c76f7834ae2        0.07%               2.746 MiB / 64 MiB      4.29%               1.266 KB / 648 B    12.4 MB / 0 B
    45  d1ea048f04e4        0.03%               4.583 MiB / 64 MiB      6.30%               2.854 KB / 648 B    27.7 MB / 0 B
    46  ```
    47  
    48  Running `docker stats` on multiple containers by name and id against a Linux daemon.
    49  
    50  ```bash
    51  $ docker stats fervent_panini 5acfcb1b4fd1
    52  CONTAINER           CPU %               MEM USAGE/LIMIT       MEM %               NET I/O
    53  5acfcb1b4fd1        0.00%               115.2 MiB/1.045 GiB   11.03%              1.422 kB/648 B
    54  fervent_panini      0.02%               11.08 MiB/1.045 GiB   1.06%               648 B/648 B
    55  ```
    56  
    57  Running `docker stats` on all running containers against a Windows daemon.
    58  
    59  ```powershell
    60  PS E:\> docker stats
    61  CONTAINER           CPU %               PRIV WORKING SET    NET I/O             BLOCK I/O
    62  09d3bb5b1604        6.61%               38.21 MiB           17.1 kB / 7.73 kB   10.7 MB / 3.57 MB
    63  9db7aa4d986d        9.19%               38.26 MiB           15.2 kB / 7.65 kB   10.6 MB / 3.3 MB
    64  3f214c61ad1d        0.00%               28.64 MiB           64 kB / 6.84 kB     4.42 MB / 6.93 MB
    65  ```
    66  
    67  Running `docker stats` on multiple containers by name and id against a Windows daemon.
    68  
    69  ```powershell
    70  PS E:\> docker ps -a
    71  CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES
    72  3f214c61ad1d        nanoserver          "cmd"               2 minutes ago       Up 2 minutes                            big_minsky
    73  9db7aa4d986d        windowsservercore   "cmd"               2 minutes ago       Up 2 minutes                            mad_wilson
    74  09d3bb5b1604        windowsservercore   "cmd"               2 minutes ago       Up 2 minutes                            affectionate_easley
    75  
    76  PS E:\> docker stats 3f214c61ad1d mad_wilson
    77  CONTAINER           CPU %               PRIV WORKING SET    NET I/O             BLOCK I/O
    78  3f214c61ad1d        0.00%               46.25 MiB           76.3 kB / 7.92 kB   10.3 MB / 14.7 MB
    79  mad_wilson          9.59%               40.09 MiB           27.6 kB / 8.81 kB   17 MB / 20.1 MB
    80  ```
    81  
    82  ### Formatting
    83  
    84  The formatting option (`--format`) pretty prints container output
    85  using a Go template.
    86  
    87  Valid placeholders for the Go template are listed below:
    88  
    89  Placeholder  | Description
    90  ------------ | --------------------------------------------
    91  `.Container` | Container name or ID (user input)
    92  `.Name`      | Container name
    93  `.ID`        | Container ID
    94  `.CPUPerc`   | CPU percentage
    95  `.MemUsage`  | Memory usage
    96  `.NetIO`     | Network IO
    97  `.BlockIO`   | Block IO
    98  `.MemPerc`   | Memory percentage (Not available on Windows)
    99  `.PIDs`      | Number of PIDs (Not available on Windows)
   100  
   101  
   102  When using the `--format` option, the `stats` command either
   103  outputs the data exactly as the template declares or, when using the
   104  `table` directive, includes column headers as well.
   105  
   106  The following example uses a template without headers and outputs the
   107  `Container` and `CPUPerc` entries separated by a colon for all images:
   108  
   109  ```bash
   110  $ docker stats --format "{{.Container}}: {{.CPUPerc}}"
   111  
   112  09d3bb5b1604: 6.61%
   113  9db7aa4d986d: 9.19%
   114  3f214c61ad1d: 0.00%
   115  ```
   116  
   117  To list all containers statistics with their name, CPU percentage and memory
   118  usage in a table format you can use:
   119  
   120  ```bash
   121  $ docker stats --format "table {{.Container}}\t{{.CPUPerc}}\t{{.MemUsage}}"
   122  
   123  CONTAINER           CPU %               PRIV WORKING SET
   124  1285939c1fd3        0.07%               796 KiB / 64 MiB
   125  9c76f7834ae2        0.07%               2.746 MiB / 64 MiB
   126  d1ea048f04e4        0.03%               4.583 MiB / 64 MiB
   127  ```