collect-iotop-periodically

#!/usr/bin/env bash
# Collects the output of 'iotop' periodically, and dumps them to
# the given directory, with one file per dump.
#
# This program requires root privileges, because iotop requires it.
#
# ## Usage syntax
#
#     collect-iotop-periodically <DUMP DIRECTORY> <INTERVAL>
#
# `DUMP DIRECTORY` specifies where to dump to. This directory must
# already exist.
#
# `INTERVAL` specifies the interval between dumps, in seconds. You
# can also specify a unit suffix, e.g. `5m` (5 minutes) or `2h` (2 hours).
#
# ## Example
#
# Create a dump directory and run the script in the background,
# collecting every 5 minutes:
#
#     sudo mkdir ~/iotop-dumps
#     sudo nohup collect-iotop-periodically ~/iotop-dumps 5m &
#
# At any point, feel free to stop the script...
#
#     ps aux | grep collect-iotop-periodically
#     sudo kill <PID>
#
# ...and tar the dump directory and send it to someone for analysis:
#
#     sudo tar -czf iotop-dumps.tar.gz ~/iotop-dumps

set -e

TARGET_DIR="$1"
INTERVAL="$2"
if [[ -z "$TARGET_DIR" || -z "$INTERVAL" ]]; then
	echo 'Usage: collect-iotop-periodically <DUMP DIRECTORY> <INTERVAL>'
	exit 1
fi

function cleanup()
{
	# shellcheck disable=SC2155
	local PIDS=$(jobs -p)
	if [[ -n "$PIDS" ]]; then
		# shellcheck disable=SC2086
		kill $PIDS || true
	fi
}

trap cleanup EXIT

while true; do
	DATE=$(date --rfc-3339=seconds)
	iotop -obPn 1 > "$TARGET_DIR/$DATE iotop.txt"
	sleep "$INTERVAL"
done