psprofile 0.1.1

PsProfile

A python process profiler. Watches a process tree and emits resource usage metrics. Uses the psutil library, so runs on a mac and linux (haven’t tested Windows, but theoretically it will work). You will get slightly different fields back depending on the operating system.

Install

pip install psprofile

Usage

$ psprofile -h
usage: psprofile [-h] [-f OUTPUT_FILE] [-i POLL_INTERVAL]
                 [-w WAIT_FOR_COMMAND_SCRIPT]
                 command_script

Profile resource usage of a command

positional arguments:
  command_script        path to a shell script to run

optional arguments:
  -h, --help            show this help message and exit
  -f OUTPUT_FILE, --output_file OUTPUT_FILE
                        File to store output of profile to.
  -i POLL_INTERVAL, --poll_interval POLL_INTERVAL
                        How often to poll the resource usage information in
                        /proc, in seconds (default 1).
  -w WAIT_FOR_COMMAND_SCRIPT, --wait_for_command_script WAIT_FOR_COMMAND_SCRIPT
                        time to wait for command_script to exist(useful to
                        handle eventual consistency on shared filesystems)

Example output:

$ psprofile /path/to/bash.script

{
    "avg_num_threads": 1,
    "cpu_time": 0,
    "avg_vms_mem_kb": 11427840,
    "io_read_kb": 4096,
    "io_write_kb": 0,
    "max_num_threads": 1,
    "system_time": 0,
    "max_rss_mem_kb": 1470464,
    "percent_cpu": 0,
    "max_vms_mem_kb": 11427840,
    "wall_time": 2,
    "ctx_switch_voluntary": 12,
    "user_time": 0,
    "avg_num_fds": 4,
    "num_polls": 1,
    "max_num_fds": 4,
    "io_write_count": 0,
    "avg_rss_mem_kb": 1470464,
    "ctx_switch_involuntary": 3,
    "io_read_count": 12,
    "exit_status": 0
}

Todo

• Support arbitrary commands. Easy to do I just don’t have a use case for it.