rrd-graph.sh

#!/usr/bin/env bash
#####
# Given an rrd file of the system's cpu and drive temperatures
# as input, this script uses rrdtool to graph the data.
# The input files must named as such: temps-Xmin.rdd
# where X is the minute interval between readings.
# ex: "temps-10min.rrd" would contain readings every 10 minutes
#
# Author: Seren Thompson
# Date: 2017-09-19
# Website: https://github.com/seren/freenas-temperature-graphing
#####

# # display expanded values
# set -o xtrace
# # quit on errors
# set -o errexit
# # error on unset variables
# set -o nounset


######################################
# Script variables
######################################
# These use external environment variables if set, otherwise use arbitrary default values
MAXGRAPHTEMP=${MAXGRAPHTEMP:-70}
MINGRAPHTEMP=${MINGRAPHTEMP:-20}
SAFETEMPMAX=${SAFETEMPMAX:-46}
SAFETEMPMIN=${SAFETEMPMIN:-37}

# # Different strokes for different folks
# LINECOLORS=( 0000FF 4573A7 AA4644 89A54E 71588F 006060 0f4880 )
# LINECOLORS=( 0000FF FF4A46 008941 006FA6 A30059 FFDBE5 7A4900 0000A6 63FFAC B79762 004D43 8FB0FF 997D87 )
# LINECOLORS=( 1CE6FF FF34FF FF4A46 008941 A30059 7A4900 63FFAC B79762 004D43 8FB0FF 997D87 000000 )
# From http://stackoverflow.com/questions/309149/generate-distinctly-different-rgb-colors-in-graphs
# LINECOLORS=( 777A7E E0FEFD E16DC5 01344B F8F8FC 9F9FB5 182617 FE3D21 7D0017 822F21 EFD9DC 6E68C4 35473E 007523 767667 A6825D 83DC5F 227285 A95E34 526172 979730 756F6D 716259 E8B2B5 B6C9BB 9078DA 4F326E B2387B 888C6F 314B5F E5B678 38A3C6 586148 5C515B CDCCE1 C8977F )
# From http://stackoverflow.com/questions/309149/generate-distinctly-different-rgb-colors-in-graphs
LINECOLORS=( 000000 00FF00 0000FF FF0000 01FFFE FFA6FE FFDB66 006401 010067 95003A 007DB5 FF00F6 FFEEE8 774D00 90FB92 0076FF D5FF00 FF937E 6A826C FF029D FE8900 7A4782 7E2DD2 85A900 FF0056 A42400 00AE7E 683D3B BDC6FF 263400 BDD393 00B917 9E008E 001544 C28C9F FF74A3 01D0FF 004754 E56FFE 788231 0E4CA1 91D0CB BE9970 968AE8 BB8800 43002C DEFF74 00FFC6 FFE502 620E00 008F9C 98FF52 7544B1 B500FF 00FF78 FF6E41 005F39 6B6882 5FAD4E A75740 A5FFD2 FFB167 009BFF E85EBE )

NUMCOLORS=${#LINECOLORS[@]}
colorindex=0

# Keep track of which graphs we generate
graphs=()

#######################################
RRDGRAPHSCRIPTVERSION=1.0

# Usage message
func_usage () {
  echo '
Given an rrd file of the system cpu and drive temperatures
as input, this script uses rrdtool to graph the data.

Usage '"$0"' [-v] [-d] [-h] [--platform "esxi"] [-e "email@address"] output-filename

-v | --verbose  Enables verbose output
-d | --debug    Outputs each line of the script as it executes (turns on xtrace)
-h | --help     Displays this message
-e | --email <email@address>    Send an email after creating graphs

Options for ESXi:
--platform "esxi"                  Indicates that we will use ESXi tools to retrieve CPU count
--ipmitool_username <USERNAME>     Required: Username to use when connecting to BMC
--ipmitool_address  <BMC_ADDRESS>  Required: BMC ip address to connect to

Note: The filename must be in the following format: temps-Xmin.rdd
  where X is the minute interval between readings.
  ex: 'temps-10min.rrd' would contain readings every 10 minutes

Example:
  '"$0"' /mnt/mainpool/temperatures/temps-5min.rrd

'
echo "Script version: ${RRDGRAPHSCRIPTVERSION}"
}

# Process command line args
args=''
help=
verbose=
debug=
datafile=
PLATFORM=default
while [ $# -gt 0 ]; do
  case $1 in
    -h|--help)  help=1;                     shift 1 ;;
    -v|--verbose) verbose=1;                shift 1 ;;
    -d|--debug) debug=1;                    shift 1 ;;
    -e|--email) email=$2;                   shift 1; shift 1;;
    --platform) PLATFORM=$2;                shift 1; shift 1 ;;
    --ipmitool_username) USERNAME=$2;       shift 1; shift 1 ;;
    --ipmitool_address) BMC_ADDRESS=$2;     shift 1; shift 1 ;;
    -*)
      echo "$0: Unrecognized option: $1 (try --help)" >&2
      exit 1
      ;;
    *)
      if [ -n "$datafile" ]; then
        echo "You can only specify one output-filename. You gave these:"
        echo "${datafile}"
        echo "$1"
        exit 1
      else
        datafile=$1
        shift 1
      fi
      ;;
  esac
done

if [ -n "$debug" ]; then
  set -o xtrace
  verbose=1
fi

[ -n "$help" ] && func_usage && exit 0

[ -n "$verbose" ] && echo "Script version: ${RRDGRAPHSCRIPTVERSION}"

case "${PLATFORM}" in
  esxi)
    [ -n "$verbose" ] && echo "Platform is set to '${PLATFORM}'. Username is '${USERNAME} and ip is '${BMC_ADDRESS}'"
    [ -z "$USERNAME" ] && echo "You need to to provide --ipmitool_username with an argument" && exit 1
    [ -z "$BMC_ADDRESS" ] && echo "You need to to provide --ipmitool_address with an argument" && exit 1
    args="${args} --platform ${PLATFORM} --ipmitool_username ${USERNAME} --ipmitool_address ${BMC_ADDRESS}"
    ;;
  default)
    args=''
    ;;
  *)
    echo "Unrecognized platform: '${PLATFORM}'"
    exit 1
    ;;
esac

# Check that we were supplied a db filename
if [ -z "${datafile}" ]; then
  echo "Error: you need to give a rrdtool database filename as an argument."
  echo
  func_usage
  exit 1
fi

# Debugging info
[ -n "$verbose" ] && echo "Rrdtool database filename: ${datafile}"

# Get current working directory
CWD="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
[ -n "$verbose" ] && echo "Current working directory is: ${CWD}"

# Load common functions (temperature retrieval, device enumeration, etc)
# shellcheck source=./rrd-lib.sh
. "${CWD}/rrd-lib.sh"

# Sleep to give time for the data-collection script to finish (if we're
# running non-interactively). This prevents race conditions in case this and
# the data-collection script were launched from cron at the same time.
if [ -v PS1 ]; then
  sleep 5
fi

# rrdtool database file
outputprefix=${datafile%.*}  # strip extension
outputprefix=${outputprefix##*/}   # strip leading path

get_devices

title="Temps"


######################################
# Main
######################################
# seconds in:
# a day:   86400
# 2 days:  172800
# a week:  604800
# 30 days: 2592000

interval=$(echo "${datafile}" | sed 's/.*temps-\(.*\)min.rrd/\1/')  # extract minute number
if [ -z "$interval" ]; then
  echo "Couldn't find a minute number in filename '${datafile}' (should in format: temps-5min.rrd)."
  exit 1
fi
[ -n "$verbose" ] && echo "Interval minutes: ${interval}"
timespan=$((interval * 86400))
[ -n "$verbose" ] && echo "Graph timespan seconds: ${timespan}"

# Graph all cpus and drives together
func_graph_everything_together () {
  outputfilename=everything
  graphs+=( $outputfilename )
  title="Temperature: All CPUs and Drives, ${interval} minute interval"
  guidrule=
  defsandlines=
  for (( i=0; i < numcpus; i++ )); do
    (( colorindex = i % NUMCOLORS )) # If we run out of colors, start over
    defsandlines="${defsandlines} DEF:cpu${i}=${datafile}:cpu${i}:MAX LINE1:cpu${i}#${LINECOLORS[$colorindex]}:cpu${i}"
  done
  i=0
  for drdev in ${drivedevs}; do
    (( colorindex = ( i + numcpus ) % NUMCOLORS )) # Don't reuse the cpu colors unless we have to
    defsandlines="${defsandlines} DEF:${drdev}=${datafile}:${drdev}:MAX LINE1:${drdev}#${LINECOLORS[$colorindex]}:${drdev}"
    (( i = i + 1 ))
  done
  write_graph_to_disk
}

# Output a combined graph of all cpus
func_graph_cpus_together () {
  [ -n "$verbose" ] && echo "Output a combined graph of all cpus"
  outputfilename=cpus
  graphs+=( $outputfilename )
  defsandlines=
  title="Temperature: All CPUs, ${interval} minute interval"
  guidrule=
  for (( i=0; i < numcpus; i++ )); do
    [ -n "$verbose" ] && echo "cpu: ${i}"
    (( colorindex = i % NUMCOLORS )) # If we run out of colors, start over
    defsandlines="${defsandlines} DEF:cpu${i}=${datafile}:cpu${i}:MAX LINE1:cpu${i}#${LINECOLORS[$colorindex]}:cpu${i}"
  done
  [ -n "$verbose" ] && echo "Definitions and lines: ${defsandlines}"
  write_graph_to_disk
}

# Output a combined graph of all drives
func_graph_drives_together () {
  [ -n "$verbose" ] && echo "Output a combined graph of all drives"
  outputfilename=drives
  graphs+=( $outputfilename )
  defsandlines=
  title="Temperature: All Drives, ${interval} minute interval"
  guidrule="HRULE:${SAFETEMPMIN}#0000FF:Min-safe-temp-mechanical:dashes HRULE:${SAFETEMPMAX}#FF0000:Max-safe-temp-mechanical:dashes"
  i=0
  for drdev in ${drivedevs}; do
    [ -n "$verbose" ] && echo "drive device: ${drdev}"
    (( colorindex = i % NUMCOLORS )) # If we run out of colors, start over
    defsandlines="${defsandlines} DEF:${drdev}=${datafile}:${drdev}:MAX LINE1:${drdev}#${LINECOLORS[$colorindex]}:${drdev}"
    (( i = i + 1 ))
  done
  [ -n "$verbose" ] && echo "Definitions and lines: ${defsandlines}"
  write_graph_to_disk
}

# Output graphs of each cpu
func_graph_cpus_separately () {
  for (( i=0; i < ${numcpus}; i++ )); do
    defsandlines="DEF:cpu${i}=${datafile}:cpu${i}:MAX LINE1:cpu${i}#000000:\"cpu${i}\""
    outputfilename=cpu${i}
    graphs+=( $outputfilename )
    title="Temperature: CPU ${i}, ${interval} minute interval"
    guidrule=
    write_graph_to_disk
  done
}

# Output graphs of each drive
func_graph_drives_separately () {
  for drdev in ${drivedevs}; do
    defsandlines="DEF:${drdev}=${datafile}:${drdev}:MAX LINE1:${drdev}#000000:${drdev}"
    outputfilename=drive-${drdev}
    graphs+=( $outputfilename )
    guidrule="HRULE:${SAFETEMPMIN}#0000FF:Min-safe-temp-mechanical:dashes HRULE:${SAFETEMPMAX}#FF0000:Max-safe-temp-mechanical:dashes"
    title="Temperature: Drive ${drdev}, ${interval} minute interval"
    write_graph_to_disk
  done
}

# Send generated graphs via email
func_send_email () {
    local logdir=${TMPDIR,/tmp}
    local logfile=$(mktemp ${logdir}/$$.email.XXXXXXX)
    local subject="${interval}m temperature graph report"
    local boundary="dk1p5Q9m3yT47A987n0p"
    ###### Email pre-formatting
    ### Set email headers
    (
        echo "From: ${email}"
        echo "To: ${email}"
        echo "Subject: ${subject}"
        echo "MIME-Version: 1.0"
        echo "Content-Type: multipart/mixed; boundary=${boundary}"
    ) > "$logfile"

    (
        echo "--${boundary}"
        echo "Content-Type: text/html"
    ) >> $logfile
    for i in ${graphs[@]}; do
        (
            echo "$i graphs" 
        ) >> $logfile
        # attach graph
        outputfilename=$i
        filename=${outputprefix}-${outputfilename}.png
        fullpath=${CWD}/${filename}
        (
            # Write MIME section header for file attachment (encoded with base64)
            echo "--${boundary}"
            echo "Content-Type: image/png"
            echo "Content-Transfer-Encoding: base64"
            echo "Content-Disposition: attachment; filename=${filename}"
            base64 "${fullpath}"
            # Write MIME section header for html content to come below
            echo "--${boundary}"
            echo "Content-Type: text/html"
        ) >> "$logfile"
    done

    ### Send report
    sendmail -t -oi < "$logfile"
    rm "$logfile"
}

############
# What graphs to output. Uncomment the ones you want

# func_graph_everything_together
func_graph_cpus_together
func_graph_drives_together
# func_graph_cpus_separately
# func_graph_drives_separately
if [ -n "${email}" ]; then
    func_send_email
fi