doc/blkiomon.8

   1 .TH BLKIOMON 8 "July 17, 2008" "" ""
   2
   3
   4 .SH NAME
   5 blkiomon \- monitor block device I/O based o blktrace data
   6
   7
   8 .SH SYNOPSIS
   9 .B blkiomon \-I \fIinterval\fR [ \-h \fIfile\fR ] [ \-b \fIfile\fR ]
  10 [ \-d \fIfile\fR ] [ \-D \fIfile\fR ] [ \-Q \fIpath_name\fR
  11 \-q \fImsg_queue_id\fR \-m \fImsg_id\fR ] [ \-V ]
  12 .br
  13
  14
  15 .SH DESCRIPTION
  16 blkiomon is a block device I/O monitor. It periodically generates per-device
  17 request size and request latency statistics from blktrace data. It provides
  18 histograms as well as data that can be used to calculate min, max, average
  19 and variance. For this purpose, it consumes D and C traces read from stdin.
  20 Note, that this doesn't work for logical volumes, as high-level drivers
  21 don't see the completion of the events (C).
  22
  23 There are options for binary output and human-readable output to files and
  24 stdout. Output to a message queue is supported as well.
  25
  26 There is no need to use blkparse with blkiomon. blkiomon is capable of
  27 consuming binary output written to stdout by blktrace.
  28
  29
  30 .SH OPTIONS
  31
  32 \-I \fIinterval\fR
  33 .br
  34 \-\-interval=\fIinterval\fR
  35 .RS
  36 Set sample interval
  37 .RE
  38
  39 \-h \fIfile\fR
  40 .br
  41 \-\-human\-readable=\fIfile\fR
  42 .RS
  43 Human-readable output file. Use '\-' for stdout.
  44 .RE
  45
  46 \-b \fIfile\fR
  47 .br
  48 \-\-binary=\fIfile\fR
  49 .RS
  50 Binary output file. Use '\-' for stdout.
  51 .RE
  52
  53 \-d \fIfile\fR
  54 .br
  55 \-\-dump-lldd=\fIfile\fR
  56 .RS
  57 Output file for data emitted by low level device driver.
  58 .RE
  59
  60 \-D \fIfile\fR
  61 .br
  62 \-\-debug=\fIfile\fR
  63 .RS
  64 Output file for debugging data. Use '\-' for stdout.
  65 .RE
  66
  67 \-Q \fIpath_name\fR
  68 .br
  69 \-\-msg\-queue=\fIpath_name\fR
  70 .RS
  71 Sets \fIpath_name\fR as path name for existing message queue to be used
  72 for binary output.
  73 .RE
  74
  75 \-q \fImsg_queue_id\fR
  76 .br
  77 \-\-msg\-queue\-id=\fImsg_queue_id\fR
  78 .RS
  79 Sets \fImsg_queue_id\fR as ID for an existing message queue to be used
  80 for binary output.
  81 .RE
  82
  83 \-m \fImsg_id\fR
  84 .br
  85 \-\-msg\-id=\fImsg_id\fR
  86 .RS
  87 Sets \fImsg_id\fR as message identifier to be used for binary output
  88 messages written to an existing message queue.
  89 .RE
  90
  91 \-V
  92 .br
  93 \-\-version
  94 .RS
  95 Print program version.
  96 .RE
  97
  98
  99 .SH EXAMPLES
 100 To get I/O statistics for /dev/sdw every 10 seconds for a period of one hour,
 101 use the following command:
 102
 103     % blktrace /dev/sdw -a issue -a complete -w 3600 -o - | blkiomon -I 10 -h -
 104
 105
 106 .SH AUTHORS
 107 blkiomon and this man page were written by Martin Peschke.
 108
 109
 110 .SH "REPORTING BUGS"
 111 Report bugs to <linux\-btrace@vger.kernel.org>
 112
 113
 114 .SH COPYRIGHT
 115 Copyright \(co 2008 IBM Corp.
 116 .br
 117 This is free software.  You may redistribute copies of it under the terms of
 118 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
 119 There is NO WARRANTY, to the extent permitted by law.
 120
 121
 122 .SH "SEE ALSO"
 123 btrace (8), blktrace (8), blkparse (1), verify_blkparse (1), blkrawverify (1),
 124 btt (1)
 125