community.general.cgroup_memory_recap – Profiles maximum memory usage of tasks and full execution using cgroups
Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.cgroup_memory_recap.
Synopsis
- This is an ansible callback plugin that profiles maximum memory usage of ansible and individual tasks, and displays a recap at the end using cgroups
Requirements
The below requirements are needed on the local controller node that executes this callback.
- whitelist in configuration
- cgroups
Parameters
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
| cur_mem_file
string / required
|
ini entries:
[callback_cgroupmemrecap]
env:CGROUP_CUR_MEM_FILE
|
Path to memory.usage_in_bytes file. Example /sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes
|
|
| max_mem_file
string / required
|
ini entries:
[callback_cgroupmemrecap]
env:CGROUP_MAX_MEM_FILE
|
Path to cgroups memory.max_usage_in_bytes file. Example /sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes
|
Notes
Note
- Requires ansible to be run from within a cgroup, such as with
cgexec -g memory:ansible_profile ansible-playbook ... - This cgroup should only be used by ansible to get accurate results
- To create the cgroup, first use a command such as
sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile
Authors
- Unknown (!UNKNOWN)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/cgroup_memory_recap_callback.html