From 7e40673dd0fafe5bfef7acd4746b47e6f70903fd Mon Sep 17 00:00:00 2001 From: Jim Ladd Date: Thu, 15 Aug 2019 10:06:24 -0700 Subject: [PATCH] Add docs for perf data collection --- docs/performance_data.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/performance_data.md diff --git a/docs/performance_data.md b/docs/performance_data.md new file mode 100644 index 0000000000..819de15fcc --- /dev/null +++ b/docs/performance_data.md @@ -0,0 +1,18 @@ +Performance Data +================ + +AWX has the ability to collect performance data on job runs. + +The following data is collected periodically (with a default interval of every 0.25 seconds): +* CPU usage +* Memory usage +* PID count + +The data is stored under `/var/log/tower/playbook_profiling`. A new folder is created for each job run. The folder's name is set to the job's ID. + +Performance data collection is not enabled by default. To enable performance data collection on all jobs, set AWX_RESOURCE_PROFILING_ENABLED to true. + +The frequency with which data is collected can be set using: +* AWX_RESOURCE_PROFILING_CPU_POLL_INTERVAL +* AWX_RESOURCE_PROFILING_MEMORY_POLL_INTERVAL +* AWX_RESOURCE_PROFILING_PID_POLL_INTERVAL