Type Alias: ContainerMemoryStats
ContainerMemoryStats =
object
A container's memory use (ContainerStats.memory_stats). The Linux fields are the ones of cgroup v1: on a host using cgroup v2 (most current distributions), max_usage and failcnt are absent, and stats holds the cgroup v2 counters (anon, file, inactive_file…) instead of the ones listed here.
Properties
commitbytes?
optionalcommitbytes?:number
The committed memory, in bytes (Windows only).
commitpeakbytes?
optionalcommitpeakbytes?:number
The highest committed memory, in bytes (Windows only).
failcnt
failcnt:
number
The number of times the memory use hit the limit (cgroup v1 only).
limit
limit:
number
The memory limit, in bytes: the host memory when the container has no limit.
max_usage
max_usage:
number
The highest memory use recorded, in bytes (cgroup v1 only).
privateworkingset?
optionalprivateworkingset?:number
The private working set, in bytes (Windows only).
stats
stats:
object
The cgroup's memory counters (its memory.stat file): the sizes in bytes, the page fault and page in/out counters in events; the total_ fields include the child cgroups.
active_anon
active_anon:
number
The active anonymous memory, in bytes.
active_file
active_file:
number
The active file-backed memory, in bytes.
cache
cache:
number
The page cache, in bytes.
hierarchical_memory_limit
hierarchical_memory_limit:
number
The memory limit of the cgroup hierarchy, in bytes.
inactive_anon
inactive_anon:
number
The inactive anonymous memory, in bytes.
inactive_file
inactive_file:
number
The inactive file-backed memory, in bytes.
mapped_file
mapped_file:
number
The memory-mapped files, in bytes.
pgfault
pgfault:
number
The page faults.
pgmajfault
pgmajfault:
number
The major page faults.
pgpgin
pgpgin:
number
The pages paged in.
pgpgout
pgpgout:
number
The pages paged out.
rss
rss:
number
The anonymous memory and swap cache (RSS), in bytes.
rss_huge
rss_huge:
number
The anonymous transparent huge pages, in bytes.
total_active_anon
total_active_anon:
number
The active anonymous memory, in bytes, child cgroups included.
total_active_file
total_active_file:
number
The active file-backed memory, in bytes, child cgroups included.
total_cache
total_cache:
number
The page cache, in bytes, child cgroups included.
total_inactive_anon
total_inactive_anon:
number
The inactive anonymous memory, in bytes, child cgroups included.
total_inactive_file
total_inactive_file:
number
The inactive file-backed memory, in bytes, child cgroups included.
total_mapped_file
total_mapped_file:
number
The memory-mapped files, in bytes, child cgroups included.
total_pgfault
total_pgfault:
number
The page faults, child cgroups included.
total_pgmajfault
total_pgmajfault:
number
The major page faults, child cgroups included.
total_pgpgin
total_pgpgin:
number
The pages paged in, child cgroups included.
total_pgpgout
total_pgpgout:
number
The pages paged out, child cgroups included.
total_rss
total_rss:
number
The RSS, in bytes, child cgroups included.
total_rss_huge
total_rss_huge:
number
The anonymous transparent huge pages, in bytes, child cgroups included.
total_unevictable
total_unevictable:
number
The memory which cannot be reclaimed, in bytes, child cgroups included.
total_writeback
total_writeback:
number
The file pages being written back to disk, in bytes, child cgroups included.
unevictable
unevictable:
number
The memory which cannot be reclaimed (locked), in bytes.
writeback
writeback:
number
The file pages being written back to disk, in bytes.
usage
usage:
number
The current memory use, in bytes, page cache included (docker stats subtracts the inactive files from it).