← Back to branch summary

~ubuntu-branches/ubuntu/trusty/mongodb/trusty-proposed

« back to all changes in this revision

Viewing changes to debian/mongoperf.1

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2013-08-27 15:40:16 UTC
  • Revision ID: package-import@ubuntu.com-20130827154016-xrafijucy0hpuxkd
Tags: 1:2.4.6-0ubuntu3
debian/*: Drop upstream debian changes accidentally merged in
1:2.4.6-0ubuntu1. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mongoperf.1
1
 
.TH "MONGOPERF" "1" "March 14, 2013" "2.2.3" "mongodb-manual"
2
 
.SH NAME
3
 
mongoperf \- MongoDB
4
 
.
5
 
.nr rst2man-indent-level 0
6
 
.
7
 
.de1 rstReportMargin
8
 
\\$1 \\n[an-margin]
9
 
level \\n[rst2man-indent-level]
10
 
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11
 
-
12
 
\\n[rst2man-indent0]
13
 
\\n[rst2man-indent1]
14
 
\\n[rst2man-indent2]
15
 
..
16
 
.de1 INDENT
17
 
.\" .rstReportMargin pre:
18
 
. RS \\$1
19
 
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
 
. nr rst2man-indent-level +1
21
 
.\" .rstReportMargin post:
22
 
..
23
 
.de UNINDENT
24
 
. RE
25
 
.\" indent \\n[an-margin]
26
 
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27
 
.nr rst2man-indent-level -1
28
 
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
 
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30
 
..
31
 
.\" Man page generated from reStructuredText.
32
 
.
33
 
.SH SYNOPSIS
34
 
.sp
35
 
\fI\%mongoperf\fP is a utility to check disk I/O performance
36
 
independently of MongoDB.
37
 
.sp
38
 
It times tests of random disk I/O and presents the results. You can
39
 
use \fI\%mongoperf\fP for any case apart from MongoDB. The
40
 
\fI\%mmf\fP \fBtrue\fP mode is completely generic. In
41
 
that mode is it somewhat analogous to tools such as \fI\%bonnie++\fP (albeit mongoperf is
42
 
simpler).
43
 
.sp
44
 
Specify options to \fI\%mongoperf\fP using a JavaScript document.
45
 
.IP "See also"
46
 
.INDENT 0.0
47
 
.IP \(bu 2
48
 
\fI\%bonnie\fP
49
 
.IP \(bu 2
50
 
\fI\%bonnie++\fP
51
 
.IP \(bu 2
52
 
\fI\%Output from an example run\fP
53
 
.IP \(bu 2
54
 
\fI\%Checking Disk Performance with the mongoperf Utility\fP
55
 
.UNINDENT
56
 
.RE
57
 
.SH OPTIONS
58
 
.INDENT 0.0
59
 
.TP
60
 
.B mongoperf
61
 
.UNINDENT
62
 
.INDENT 0.0
63
 
.TP
64
 
.B \-\-help
65
 
Displays the options to \fI\%mongoperf\fP.  Specify options to
66
 
\fI\%mongoperf\fP with a JSON document described in the
67
 
\fI\%Configuration Fields\fP section.
68
 
.UNINDENT
69
 
.INDENT 0.0
70
 
.TP
71
 
.B <jsonconfig>
72
 
\fI\%mongoperf\fP accepts configuration options in the form of a
73
 
file that holds a \fIJSON\fP document. You must stream the
74
 
content of this file into \fI\%mongoperf\fP, as in the following
75
 
operation:
76
 
.sp
77
 
.nf
78
 
.ft C
79
 
mongoperf < config
80
 
.ft P
81
 
.fi
82
 
.sp
83
 
In this example \fBconfig\fP is the name of a file that holds a JSON
84
 
document that resembles the following example:
85
 
.sp
86
 
.nf
87
 
.ft C
88
 
{
89
 
  nThreads:<n>,
90
 
  fileSizeMB:<n>,
91
 
  sleepMicros:<n>,
92
 
  mmf:<bool>,
93
 
  r:<bool>,
94
 
  w:<bool>,
95
 
  recSizeKB:<n>,
96
 
  syncDelay:<n>
97
 
}
98
 
.ft P
99
 
.fi
100
 
.sp
101
 
See the \fI\%Configuration Fields\fP section for documentation of each
102
 
of these fields.
103
 
.UNINDENT
104
 
.SH CONFIGURATION FIELDS
105
 
.INDENT 0.0
106
 
.TP
107
 
.B mongoperf.nThreads
108
 
\fIType:\fP Integer.
109
 
.sp
110
 
\fIDefault:\fP 1
111
 
.sp
112
 
Defines the number of threads \fI\%mongoperf\fP will use in the
113
 
test. To saturate your system\(aqs storage system you will need
114
 
multiple threads. Consider setting \fI\%nThreads\fP to \fB16\fP.
115
 
.UNINDENT
116
 
.INDENT 0.0
117
 
.TP
118
 
.B mongoperf.fileSizeMB
119
 
\fIType:\fP Integer.
120
 
.sp
121
 
\fIDefault:\fP 1 megabyte (i.e. 1024\s-2\u2\d\s0 bytes)
122
 
.sp
123
 
Test file size.
124
 
.UNINDENT
125
 
.INDENT 0.0
126
 
.TP
127
 
.B mongoperf.sleepMicros
128
 
\fIType:\fP Integer.
129
 
.sp
130
 
\fIDefault:\fP 0
131
 
.sp
132
 
\fI\%mongoperf\fP will pause for the number of specified
133
 
\fI\%sleepMicros\fP divided by the
134
 
\fI\%nThreads\fP between each operation.
135
 
.UNINDENT
136
 
.INDENT 0.0
137
 
.TP
138
 
.B mongoperf.mmf
139
 
\fIType:\fP Boolean.
140
 
.sp
141
 
\fIDefault:\fP \fBfalse\fP
142
 
.sp
143
 
Set \fI\%mmf\fP to \fBtrue\fP to use memory mapped
144
 
files for the tests.
145
 
.sp
146
 
Generally:
147
 
.INDENT 7.0
148
 
.IP \(bu 2
149
 
when \fI\%mmf\fP is \fBfalse\fP, \fI\%mongoperf\fP
150
 
tests direct, physical, I/O, without caching. Use a large file
151
 
size to test heavy random I/O load and to avoid I/O coalescing.
152
 
.IP \(bu 2
153
 
when \fI\%mmf\fP is \fBtrue\fP, \fI\%mongoperf\fP
154
 
runs tests of the caching system, and can use normal file system
155
 
cache. Use \fBmmf\fP in this mode to test file system cache
156
 
behavior with memory mapped files.
157
 
.UNINDENT
158
 
.UNINDENT
159
 
.INDENT 0.0
160
 
.TP
161
 
.B mongoperf.r
162
 
\fIType:\fP Boolean.
163
 
.sp
164
 
\fIDefault:\fP \fBfalse\fP
165
 
.sp
166
 
Set \fI\%r\fP to \fBtrue\fP to perform reads as part of
167
 
the tests.
168
 
.sp
169
 
Either \fI\%r\fP or \fI\%w\fP must be \fBtrue\fP.
170
 
.UNINDENT
171
 
.INDENT 0.0
172
 
.TP
173
 
.B mongoperf.w
174
 
\fIType:\fP Boolean.
175
 
.sp
176
 
\fIDefault:\fP \fBfalse\fP
177
 
.sp
178
 
Set \fI\%w\fP to \fBtrue\fP to perform writes as part of
179
 
the tests.
180
 
.sp
181
 
Either \fI\%r\fP or \fI\%w\fP must be \fBtrue\fP.
182
 
.UNINDENT
183
 
.INDENT 0.0
184
 
.TP
185
 
.B mongoperf.syncDelay
186
 
\fIType:\fP Integer.
187
 
.sp
188
 
\fIDefault:\fP 0
189
 
.sp
190
 
Seconds between disk flushes. \fI\%syncDelay\fP is
191
 
similar to \fBsyncDelay\fP for \fBmongod\fP.
192
 
.sp
193
 
The \fI\%syncDelay\fP controls how frequently
194
 
\fI\%mongoperf\fP performs an asynchronous disk flush the memory
195
 
mapped file used for testing. By default, \fBmongod\fP
196
 
performs this operation every every 60 seconds. Use
197
 
\fI\%syncDelay\fP to test basic system performance of
198
 
this type of operation.
199
 
.sp
200
 
Only use \fI\%syncDelay\fP in conjunction with
201
 
\fI\%mmf\fP set to \fBtrue\fP.
202
 
.sp
203
 
The default value of \fB0\fP disables this
204
 
.UNINDENT
205
 
.SH USE
206
 
.sp
207
 
.nf
208
 
.ft C
209
 
mongoperf < jsonconfigfile
210
 
.ft P
211
 
.fi
212
 
.sp
213
 
Replace \fBjsonconfigfile\fP with the path to the \fI\%mongoperf\fP
214
 
configuration. You may also invoke \fI\%mongoperf\fP in the
215
 
following form:
216
 
.sp
217
 
.nf
218
 
.ft C
219
 
echo "{nThreads:16,fileSizeMB:1000,r:true}" | ./mongoperf
220
 
.ft P
221
 
.fi
222
 
.sp
223
 
In this operation:
224
 
.INDENT 0.0
225
 
.IP \(bu 2
226
 
\fI\%mongoperf\fP tests direct physical random read io\(aqs, using
227
 
16 concurrent reader threads.
228
 
.IP \(bu 2
229
 
\fI\%mongoperf\fP  uses a 1 gigabyte test file.
230
 
.UNINDENT
231
 
.sp
232
 
Consider using \fBiostat\fP, as invoked in the following example to
233
 
monitor I/O performance during the test.
234
 
.sp
235
 
.nf
236
 
.ft C
237
 
iostat \-xm 2
238
 
.ft P
239
 
.fi
240
 
.SH AUTHOR
241
 
MongoDB Documentation Project
242
 
.SH COPYRIGHT
243
 
2011-2013, 10gen, Inc.
244
 
.\" Generated by docutils manpage writer.
245
 
.