NAME

API::Docker::Type::ContainerMemoryStats - Aggregates all memory stats since container inception on Linux

VERSION

version 0.004

DESCRIPTION

Generated from the ContainerMemoryStats definition of spec/v1.51.yaml.

Windows returns stats for commit and private working set only.

usage

Current res_counter usage for memory.

This field is Linux-specific and omitted for Windows containers. Serialised as usage -- spelled out, because deriving it from the Perl name would produce Usage.

max_usage

Maximum usage ever recorded.

This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. Serialised as max_usage -- spelled out, because deriving it from the Perl name would produce MaxUsage.

stats

All the stats exported via memory.stat.

The fields in this object differ between cgroups v1 and v2. On cgroups v1, fields such as cache, rss, mapped_file are available. On cgroups v2, fields such as file, anon, inactive_file are available.

This field is Linux-specific and omitted for Windows containers. The keys are the caller's data and are never translated. Serialised as stats -- spelled out, because deriving it from the Perl name would produce Stats.

failcnt

Number of times memory usage hits limits.

This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. Serialised as failcnt -- spelled out, because deriving it from the Perl name would produce Failcnt.

limit

This field is Linux-specific and omitted for Windows containers. Serialised as limit -- spelled out, because deriving it from the Perl name would produce Limit.

commitbytes

Committed bytes.

This field is Windows-specific and omitted for Linux containers. Serialised as commitbytes -- spelled out, because deriving it from the Perl name would produce Commitbytes.

commitpeakbytes

Peak committed bytes.

This field is Windows-specific and omitted for Linux containers. Serialised as commitpeakbytes -- spelled out, because deriving it from the Perl name would produce Commitpeakbytes.

privateworkingset

Private working set.

This field is Windows-specific and omitted for Linux containers. Serialised as privateworkingset -- spelled out, because deriving it from the Perl name would produce Privateworkingset.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.