iowatcher/README

   1 iowatcher graphs the results of a blktrace run.  It has a few different modes:
   2
   3 * Graph the result of an existing blktrace
   4
   5 * Start a new blktrace
   6
   7 * Start a new blktrace and a benchmark run
   8
   9 The basic options:
  10
  11         -d controls which device you are string.  You can only trace one device
  12            at a time for now.  It is sent directly to blktrace
  13
  14         -t controls the name of the blktrace file.  iowatcher uses a dump from
  15            blkparse, so -t tries to guess the name of the corresponding
  16            per CPU blktrace data files if the dump file doesn't already exist.
  17
  18            If you want more than one trace in a given graph, you can specify
  19            -t more than once.
  20
  21         -l Sets a label for a trace file.  The labels are added in the same
  22            order the trace files are added.
  23
  24         -T Set a title for the graph.  This goes at the top of the image.
  25
  26         -o output filename.  The default is trace.svg.  iowatcher is
  27            only able to create svg for now.
  28
  29         -r control the duration in seconds for the rolling average.
  30            iowatcher tries to smooth out bumpy graphs by averaging the
  31            current second with seconds from the past.  Longer numbers here
  32            give you flatter graphs.
  33
  34         -O add a single graph to the output.  By default all the graphs
  35            are included, but with -O you get only the graphs you ask for.
  36            -O may be used more than once.
  37
  38         -N remove a single graph from the output.  This may also be used more
  39            than once.
  40
  41         Choices for -O and -N are:
  42            io, tput, latency, queue_depth, iops
  43
  44 Examples:
  45
  46         # generate graph from the existing trace.dump
  47         iowatcher -t trace.dump -o trace.svg
  48
  49         # skip the IO graph
  50         iowatcher -t trace.dump -o trace.svg -N io
  51
  52         # only graph tput and latency
  53         iowatcher -t trace.dump -o trace.svg -O tput -O latency
  54
  55         # generate a graph from two runs, and label them
  56         iowatcher -t ext4.dump -t xfs.dump -l Ext4 -l XFS -o trace.svg
  57
  58         # Run a fio benchmark and store the trace in trace.dump
  59         # add a title to the top.  Use /dev/sda for blktrace
  60         iowatcher -d /dev/sda -t trace.dump -T 'Fio Benchmark' -p 'fio some_job_file'
  61
  62 Please email chris.mason@fusionio.com with any questions