blkiomon: I/O monitor
[blktrace.git] / 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 ] [ \-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
21 There are options for binary output and human-readable output to files and
22 stdout. Output to a message queue is supported as well.
23
24 There is no need to use blkparse with blkiomon. blkiomon is capable of
25 consuming binary output written to stdout by blktrace.
26
27
28 .SH OPTIONS
29
30 \-I \fIinterval\fR
31 .br
32 \-\-interval=\fIinterval\fR
33 .RS
34 Set sample interval
35 .RE
36
37 \-h \fIfile\fR
38 .br
39 \-\-human\-readable=\fIfile\fR
40 .RS
41 Human-readable output file. Use '\-' for stdout.
42 .RE
43
44 \-b \fIfile\fR
45 .br
46 \-\-binary=\fIfile\fR
47 .RS
48 Binary output file. Use '\-' for stdout.
49 .RE
50
51 \-D \fIfile\fR
52 .br
53 \-\-debug=\fIfile\fR
54 .RS
55 Output file for debugging data. Use '\-' for stdout.
56 .RE
57
58 \-Q \fIpath_name\fR
59 .br
60 \-\-msg\-queue\-name=\fIpath_name\fR
61 .RS
62 Sets \fIpath_name\fR as path name for existing message queue to be used
63 for binary output.
64 .RE
65
66 \-q \fImsg_queue_id\fR
67 .br
68 \-\-msg\-queue\-id=\fImsg_queue_id\fR
69 .RS
70 Sets \fImsg_queue_id\fR as ID for an existing message queue to be used
71 for binary output.
72 .RE
73
74 \-m \fImsg_id\fR
75 .br
76 \-\-msg\-id=\fImsg_id\fR
77 .RS
78 Sets \fImsg_id\fR as message identifier to be used for binary output
79 messages written to an existing message queue.
80 .RE
81
82 \-V
83 .br
84 \-\-version
85 .RS
86 Print program version.
87 .RE
88
89
90 .SH EXAMPLES
91 To get I/O statistics for /dev/sdw every 10 seconds for a period of one hour,
92 use the following command:
93
94     % blktrace /dev/sdw -a issue -a complete -w 3600 -o - | blkiomon -I 10 -h -
95
96
97 .SH AUTHORS
98 blkiomon and this man page were written by Martin Peschke.
99
100
101 .SH "REPORTING BUGS"
102 Report bugs to <linux\-btrace@vger.kernel.org>
103
104
105 .SH COPYRIGHT
106 Copyright \(co 2008 IBM Corp.
107 .br
108 This is free software.  You may redistribute copies of it under the terms of
109 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
110 There is NO WARRANTY, to the extent permitted by law.
111
112
113 .SH "SEE ALSO"
114 btrace (8), blktrace (8), blkparse (1), verify_blkparse (1), blkrawverify (1),
115 btt (1)
116