Merge in more updates for docs (we are just going to check them all in so that users...
[awesomized/libmemcached] / docs / man / memslap.1
1 .TH "MEMSLAP" "1" "April 07, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memslap \- libmemcached Documentation
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 reStructeredText.
32 .
33 .sp
34 memslap \- Load testing and benchmarking tool for memcached
35 .SH SYNOPSIS
36 .sp
37 .nf
38 .ft C
39 memslap [options]
40 .ft P
41 .fi
42 .SH DESCRIPTION
43 .sp
44 \fBmemslap\fP is a load generation and benchmark tool for memcached(1)
45 servers. It generates configurable workload such as threads, concurrencies, connections,
46 run time, overwrite, miss rate, key size, value size, get/set proportion,
47 expected throughput, and so on. Furthermore, it also supports data
48 verification, expire\-time verification, UDP, binary protocol, facebook test,
49 replication test, multi\-get and reconnection, etc.
50 .sp
51 Memslap manages network connections like memcached with
52 libevent. Each thread of memslap is bound with a CPU core, all
53 the threads don\(aqt communicate with each other, and there are several socket
54 connections in each thread. Each connection keeps key size distribution,
55 value size distribution, and command distribution by itself.
56 .sp
57 You can specify servers via the \fB\-\-servers\fP option or via the
58 environment variable \fBMEMCACHED_SERVERS\fP.
59 .SH FEATURES
60 .sp
61 Memslap is developed to for the following purposes:
62 .sp
63 Manages network connections with libevent asynchronously.
64 .sp
65 Set both TCP and UDP up to use non\-blocking IO.
66 .sp
67 Improves parallelism: higher performance in multi\-threads environments.
68 .sp
69 Improves time efficiency: faster processing speed.
70 .sp
71 Generates key and value more efficiently; key size distribution and value size distribution are configurable.
72 .sp
73 Supports get, multi\-get, and set commands; command distribution is configurable.
74 .sp
75 Supports controllable miss rate and overwrite rate.
76 .sp
77 Supports data and expire\-time verification.
78 .sp
79 Supports dumping statistic information periodically.
80 .sp
81 Supports thousands of TCP connections.
82 .sp
83 Supports binary protocol.
84 .sp
85 Supports facebook test (set with TCP and multi\-get with UDP) and replication test.
86 .SH DETAILS
87 .SS Effective implementation of network.
88 .sp
89 For memslap, both TCP and UDP use non\-blocking network IO. All
90 the network events are managed by libevent as memcached. The network module
91 of memslap is similar to memcached. Libevent can ensure
92 memslap can handle network very efficiently.
93 .SS Effective implementation of multi\-threads and concurrency
94 .sp
95 Memslap has the similar implementation of multi\-threads to
96 memcached. Memslap creates one or more self\-governed threads;
97 each thread is bound with one CPU core if the system supports setting CPU
98 core affinity.
99 .sp
100 In addition, each thread has a libevent to manage the events of the network;
101 each thread has one or more self\-governed concurrencies; and each
102 concurrency has one or more socket connections. All the concurrencies don’t
103 communicate with each other even though they are in the same thread.
104 .sp
105 Memslap can create thousands of socket connections, and each
106 concurrency has tens of socket connections. Each concurrency randomly or
107 sequentially selects one socket connection from its socket connection pool
108 to run, so memslap can ensure each concurrency handles one
109 socket connection at any given time. Users can specify the number of
110 concurrency and socket connections of each concurrency according to their
111 expected workload.
112 .SS Effective implementation of generating key and value
113 .sp
114 In order to improve time efficiency and space efficiency,
115 memslap creates a random characters table with 10M characters. All the
116 suffixes of keys and values are generated from this random characters table.
117 .sp
118 Memslap uses the offset in the character table and the length
119 of the string to identify a string. It can save much memory.
120 Each key contains two parts, a prefix and a suffix. The prefix is an
121 uint64_t, 8 bytes. In order to verify the data set before,
122 memslap need to ensure each key is unique, so it uses the prefix to identify
123 a key. The prefix cannot include illegal characters, such as ‘r’, ‘n’,
124 ‘0’ and ‘ ‘. And memslap has an algorithm to ensure that.
125 .sp
126 Memslap doesn’t generate all the objects (key\-value pairs) at
127 the beginning. It only generates enough objects to fill the task window
128 (default 10K objects) of each concurrency. Each object has the following
129 basic information, key prefix, key suffix offset in the character table, key
130 length, value offset in the character table, and value length.
131 .sp
132 In the work process, each concurrency sequentially or randomly selects an
133 object from the window to do set operation or get operation. At the same
134 time, each concurrency kicks objects out of its window and adds new object
135 into it.
136 .SS Simple but useful task scheduling
137 .sp
138 Memslap uses libevent to schedule all the concurrencies of
139 threads, and each concurrency schedules tasks based on the local task
140 window. Memslap assumes that if each concurrency keeps the same
141 key distribution, value distribution and commands distribution, from
142 outside, memslap keeps all the distribution as a whole.
143 Each task window includes a lot of objects, each object stores its basic
144 information, such as key, value, expire time, and so on. At any time, all
145 the objects in the window keep the same and fixed key and value
146 distribution. If an object is overwritten, the value of the object will be
147 updated. Memslap verifies the data or expire\-time according to
148 the object information stored in the task window.
149 .sp
150 Libevent selects which concurrency to handle based on a specific network
151 event. Then the concurrency selects which command (get or set) to operate
152 based on the command distribution. If it needs to kick out an old object and
153 add a new object, in order to keep the same key and value distribution, the
154 new object must have the same key length and value length.
155 .sp
156 If memcached server has two cache layers (memory and SSD), running
157 memslap with different window sizes can get different cache
158 miss rates. If memslap adds enough objects into the windows at
159 the beginning, and the cache of memcached cannot store all the objects
160 initialized, then memslap will get some objects from the second
161 cache layer. It causes the first cache layer to miss. So the user can
162 specify the window size to get the expected miss rate of the first cache
163 layer.
164 .SS Useful implementation of multi\-servers , UDP, TCP, multi\-get and binary protocol
165 .sp
166 Because each thread is self\-governed, memslap can assign
167 different threads to handle different memcached servers. This is just one of
168 the ways in which memslap supports multiple servers. The only
169 limitation is that the number of servers cannot be greater than the number
170 of threads. The other way to support multiple servers is for replication
171 test. Each concurrency has one socket connection to each memcached server.
172 For the implementation, memslap can set some objects to one
173 memcached server, and get these objects from the other servers.
174 .sp
175 By default, Memslap does single get. If the user specifies
176 multi\-get option, memslap will collect enough get commands and
177 pack and send the commands together.
178 .sp
179 Memslap supports both the ASCII protocol and binary protocol,
180 but it runs on the ASCII protocol by default.
181 Memslap by default runs on the TCP protocol, but it also
182 supports UDP. Because UDP is unreliable, dropped packages and out\-of\-order
183 packages may occur. Memslap creates a memory buffer to handle
184 these problems. Memslap tries to read all the response data of
185 one command from the server and reorders the response data. If some packages
186 get lost, the waiting timeout mechanism can ensure half\-baked packages will
187 be discarded and the next command will be sent.
188 .SH USAGE
189 .sp
190 Below are some usage samples:
191 .sp
192 memslap \-s 127.0.0.1:11211 \-S 5s
193 .sp
194 memslap \-s 127.0.0.1:11211 \-t 2m \-v 0.2 \-e 0.05 \-b
195 .sp
196 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-w 40k \-S 20s \-o 0.2
197 .sp
198 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-T 4 \-c 128 \-d 20 \-P 40k
199 .sp
200 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-d 50 \-a \-n 40
201 .sp
202 memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m
203 .sp
204 memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2
205 .sp
206 The user must specify one server at least to run memslap. The
207 rest of the parameters have default values, as shown below:
208 .sp
209 Thread number = 1 Concurrency = 16
210 .sp
211 Run time = 600 seconds Configuration file = NULL
212 .sp
213 Key size = 64 Value size = 1024
214 .sp
215 Get/set = 9:1 Window size = 10k
216 .sp
217 Execute number = 0 Single get = true
218 .sp
219 Multi\-get = false Number of sockets of each concurrency = 1
220 .sp
221 Reconnect = false Data verification = false
222 .sp
223 Expire\-time verification = false ASCII protocol = true
224 .sp
225 Binary protocol = false Dumping statistic information
226 .sp
227 periodically = false
228 .sp
229 Overwrite proportion = 0% UDP = false
230 .sp
231 TCP = true Limit throughput = false
232 .sp
233 Facebook test = false Replication test = false
234 .SS Key size, value size and command distribution.
235 .sp
236 All the distributions are read from the configuration file specified by user
237 with “—cfg_cmd” option. If the user does not specify a configuration file,
238 memslap will run with the default distribution (key size = 64,
239 value size = 1024, get/set = 9:1). For information on how to edit the
240 configuration file, refer to the “Configuration File” section.
241 .sp
242 The minimum key size is 16 bytes; the maximum key size is 250 bytes. The
243 precision of proportion is 0.001. The proportion of distribution will be
244 rounded to 3 decimal places.
245 .sp
246 The minimum value size is 1 bytes; the maximum value size is 1M bytes. The
247 precision of proportion is 0.001. The proportion of distribution will be
248 rounded to 3 decimal places.
249 Currently, memslap only supports set and get commands. And it
250 supports 100% set and 100% get. For 100% get, it will preset some objects to
251 the server.
252 .SS Multi\-thread and concurrency
253 .sp
254 The high performance of memslap benefits from the special
255 schedule of thread and concurrency. It’s important to specify the proper
256 number of them. The default number of threads is 1; the default number of
257 concurrency is 16. The user can use “—threads” and “\-\-concurrency” to
258 specify these variables.
259 .sp
260 If the system supports setting CPU affinity and the number of threads
261 specified by the user is greater than 1, memslap will try to
262 bind each thread to a different CPU core. So if you want to get the best
263 performance memslap, it is better to specify the number of
264 thread equal to the number of CPU cores. The number of threads specified by
265 the user can also be less or greater than the number of CPU cores. Because
266 of the limitation of implementation, the number of concurrencies could be
267 the multiple of the number of threads.
268 .INDENT 0.0
269 .IP 1. 3
270 .
271 For 8 CPU cores system
272 .UNINDENT
273 .sp
274 For example:
275 .sp
276 \-\-threads=2 \-\-concurrency=128
277 .sp
278 \-\-threads=8 \-\-concurrency=128
279 .sp
280 \-\-threads=8 \-\-concurrency=256
281 .sp
282 \-\-threads=12 \-\-concurrency=144
283 .INDENT 0.0
284 .IP 2. 3
285 .
286 For 16 CPU cores system
287 .UNINDENT
288 .sp
289 For example:
290 .sp
291 \-\-threads=8 \-\-concurrency=128
292 .sp
293 \-\-threads=16 \-\-concurrency=256
294 .sp
295 \-\-threads=16 \-\-concurrency=512
296 .sp
297 \-\-threads=24 \-\-concurrency=288
298 .sp
299 The memslap performs very well, when
300 used to test the performance of memcached servers.
301 Most of the time, the bottleneck is the network or
302 the server. If for some reason the user wants to
303 limit the performance of memslap, there
304 are two ways to do this:
305 .sp
306 Decrease the number of threads and concurrencies.
307 Use the option “\-\-tps” that memslap
308 provides to limit the throughput. This option allows
309 the user to get the expected throughput. For
310 example, assume that the maximum throughput is 50
311 kops/s for a specific configuration, you can specify
312 the throughput equal to or less than the maximum
313 throughput using “\-\-tps” option.
314 .SS Window size
315 .sp
316 Most of the time, the user does not need to specify the window size. The
317 default window size is 10k. For Schooner Memcached, the user can specify
318 different window sizes to get different cache miss rates based on the test
319 case. Memslap supports cache miss rate between 0% and 100%.
320 If you use this utility to test the performance of Schooner Memcached, you
321 can specify a proper window size to get the expected cache miss rate. The
322 formula for calculating window size is as follows:
323 .sp
324 Assume that the key size is 128 bytes, and the value size is 2048 bytes, and
325 concurrency=128.
326 .sp
327 1. Small cache cache_size=1M, 100% cache miss (all data get from SSD).
328 win_size=10k
329 .INDENT 0.0
330 .IP 2. 3
331 .
332 cache_size=4G
333 .UNINDENT
334 .sp
335 (1). cache miss rate 0%
336 .sp
337 win_size=8k
338 .sp
339 (2). cache miss rate 5%
340 .sp
341 win_size=11k
342 .INDENT 0.0
343 .IP 3. 3
344 .
345 cache_size=16G
346 .UNINDENT
347 .sp
348 (1). cache miss rate 0%
349 .sp
350 win_size=32k
351 .sp
352 (2). cache miss
353 .sp
354 rate 5%
355 .sp
356 win_size=46k
357 .sp
358 The formula for calculating window size for cache miss rate 0%:
359 .sp
360 cache_size / concurrency / (key_size + value_size) * 0.5
361 .sp
362 The formula for calculating window size for cache miss rate 5%:
363 .sp
364 cache_size / concurrency / (key_size + value_size) * 0.7
365 .SS Verification
366 .sp
367 Memslap supports both data verification and expire\-time
368 verification. The user can use "\-\-verify=" or "\-v" to specify the proportion
369 of data verification. In theory, it supports 100% data verification. The
370 user can use "\-\-exp_verify=" or "\-e" to specify the proportion of
371 expire\-time verification. In theory, it supports 100% expire\-time
372 verification. Specify the "\-\-verbose" options to get more detailed error
373 information.
374 .sp
375 For example: \-\-exp_verify=0.01 –verify=0.1 , it means that 1% of the objects
376 set with expire\-time, 10% of the objects gotten will be verified. If the
377 objects are gotten, memslap will verify the expire\-time and
378 value.
379 .SS multi\-servers and multi\-clients
380 .sp
381 Memslap supports multi\-servers based on self\-governed thread.
382 There is a limitation that the number of servers cannot be greater than the
383 number of threads. Memslap assigns one thread to handle one
384 server at least. The user can use the "\-\-servers=" or "\-s" option to specify
385 multi\-servers.
386 .sp
387 For example:
388 .sp
389 \-\-servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 \-\-threads=6 \-\-concurrency=36
390 .sp
391 The above command means that there are 6 threads, with each thread having 6
392 concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1
393 and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2
394 (10.1.1.3).
395 .sp
396 All the threads and concurrencies in memslap are self\-governed.
397 .sp
398 So is memslap. The user can start up several
399 memslap instances. The user can run memslap on different client
400 machines to communicate with the same memcached server at the same. It is
401 recommended that the user start different memslap on different
402 machines using the same configuration.
403 .SS Run with execute number mode or time mode
404 .sp
405 The default memslap runs with time mode. The default run time
406 is 10 minutes. If it times out, memslap will exit. Do not
407 specify both execute number mode and time mode at the same time; just
408 specify one instead.
409 .sp
410 For example:
411 .sp
412 \-\-time=30s (It means the test will run 30 seconds.)
413 .sp
414 \-\-execute_number=100000 (It means that after running 100000 commands, the test will exit.)
415 .SS Dump statistic information periodically.
416 .sp
417 The user can use "\-\-stat_freq=" or "\-S" to specify the frequency.
418 .sp
419 For example:
420 .sp
421 \-\-stat_freq=20s
422 .sp
423 Memslap will dump the statistics of the commands (get and set) at the frequency of every 20
424 seconds.
425 .sp
426 For more information on the format of dumping statistic information, refer to “Format of Output” section.
427 .SS Multi\-get
428 .sp
429 The user can use "\-\-division=" or "\-d" to specify multi\-get keys count.
430 Memslap by default does single get with TCP. Memslap also supports data
431 verification and expire\-time verification for multi\-get.
432 .sp
433 Memslap supports multi\-get with both TCP and UDP. Because of
434 the different implementation of the ASCII protocol and binary protocol,
435 there are some differences between the two. For the ASCII protocol,
436 memslap sends one “multi\-get” to the server once. For the
437 binary protocol, memslap sends several single get commands
438 together as “multi\-get” to the server.
439 .SS UDP and TCP
440 .sp
441 Memslap supports both UDP and TCP. For TCP,
442 memslap does not reconnect the memcached server if socket connections are
443 lost. If all the socket connections are lost or memcached server crashes,
444 memslap will exit. If the user specifies the “\-\-reconnect”
445 option when socket connections are lost, it will reconnect them.
446 .sp
447 User can use “\-\-udp” to enable the UDP feature, but UDP comes with some
448 limitations:
449 .sp
450 UDP cannot set data more than 1400 bytes.
451 .sp
452 UDP is not supported by the binary protocol because the binary protocol of
453 memcached does not support that.
454 .sp
455 UDP doesn’t support reconnection.
456 .SS Facebook test
457 .sp
458 Set data with TCP and multi\-get with UDP. Specify the following options:
459 .sp
460 "\-\-facebook \-\-division=50"
461 .sp
462 If you want to create thousands of TCP connections, specify the
463 .sp
464 "\-\-conn_sock=" option.
465 .sp
466 For example: \-\-facebook \-\-division=50 \-\-conn_sock=200
467 .sp
468 The above command means that memslap will do facebook test,
469 each concurrency has 200 socket TCP connections and one UDP socket.
470 .sp
471 Memslap sets objects with the TCP socket, and multi\-gets 50
472 objects once with the UDP socket.
473 .sp
474 If you specify "\-\-division=50", the key size must be less that 25 bytes
475 because the UDP packet size is 1400 bytes.
476 .SS Replication test
477 .sp
478 For replication test, the user must specify at least two memcached servers.
479 The user can use “—rep_write=” option to enable feature.
480 .sp
481 For example:
482 .sp
483 \-\-servers=10.1.1.1:11211,10.1.1.2:11212 –rep_write=2
484 .sp
485 The above command means that there are 2 replication memcached servers,
486 memslap will set objects to both server 0 and server 1, get
487 objects which are set to server 0 before from server 1, and also get objects
488 which are set to server 1 before from server 0. If server 0 crashes,
489 memslap will only get objects from server 1. If server 0 comes
490 back to life again, memslap will reconnect server 0. If both
491 server 0 and server 1 crash, memslap will exit.
492 .SS Supports thousands of TCP connections
493 .sp
494 Start memslap with "\-\-conn_sock=" or "\-n" to enable this
495 feature. Make sure that your system can support opening thousands of files
496 and creating thousands of sockets. However, this feature does not support
497 reconnection if sockets disconnect.
498 .sp
499 For example:
500 .sp
501 \-\-threads=8 \-\-concurrency=128 \-\-conn_sock=128
502 .sp
503 The above command means that memslap starts up 8 threads, each
504 thread has 16 concurrencies, each concurrency has 128 TCP socket
505 connections, and the total number of TCP socket connections is 128 * 128 =
506 16384.
507 .SS Supports binary protocol
508 .sp
509 Start memslap with "\-\-binary" or "\-B" options to enable this
510 feature. It supports all the above features except UDP, because the latest
511 memcached 1.3.3 does not implement binary UDP protocol.
512 .sp
513 For example:
514 .sp
515 \-\-binary
516 .sp
517 Since memcached 1.3.3 doesn\(aqt implement binary UDP protocol,
518 memslap does not support UDP. In addition, memcached 1.3.3 does not support
519 multi\-get. If you specify "\-\-division=50" option, it just sends 50 get
520 commands together as “mulit\-get” to the server.
521 .SH CONFIGURATION FILE
522 .sp
523 This section describes the format of the configuration file. By default
524 when no configuration file is specified memslap reads the default
525 one located at ~/.memslap.cnf.
526 .sp
527 Below is a sample configuration file:
528 .sp
529 .nf
530 .ft C
531 ***************************************************************************
532 #comments should start with \(aq#\(aq
533 #key
534 #start_len end_len proportion
535 #
536 #key length range from start_len to end_len
537 #start_len must be equal to or greater than 16
538 #end_len must be equal to or less than 250
539 #start_len must be equal to or greater than end_len
540 #memslap will generate keys according to the key range
541 #proportion: indicates keys generated from one range accounts for the total
542 generated keys
543 #
544 #example1: key range 16~100 accounts for 80%
545 # key range 101~200 accounts for 10%
546 # key range 201~250 accounts for 10%
547 # total should be 1 (0.8+0.1+0.1 = 1)
548 #
549 # 16 100 0.8
550 # 101 200 0.1
551 # 201 249 0.1
552 #
553 #example2: all keys length are 128 bytes
554 #
555 # 128 128 1
556 key
557 128 128 1
558 #value
559 #start_len end_len proportion
560 #
561 #value length range from start_len to end_len
562 #start_len must be equal to or greater than 1
563 #end_len must be equal to or less than 1M
564 #start_len must be equal to or greater than end_len
565 #memslap will generate values according to the value range
566 #proportion: indicates values generated from one range accounts for the
567 total generated values
568 #
569 #example1: value range 1~1000 accounts for 80%
570 # value range 1001~10000 accounts for 10%
571 # value range 10001~100000 accounts for 10%
572 # total should be 1 (0.8+0.1+0.1 = 1)
573 #
574 # 1 1000 0.8
575 # 1001 10000 0.1
576 # 10001 100000 0.1
577 #
578 #example2: all value length are 128 bytes
579 #
580 # 128 128 1
581 value
582 2048 2048 1
583 #cmd
584 #cmd_type cmd_proportion
585 #
586 #currently memslap only supports get and set command.
587 #
588 #cmd_type
589 #set 0
590 #get 1
591 #
592 #example: set command accounts for 50%
593 # get command accounts for 50%
594 # total should be 1 (0.5+0.5 = 1)
595 #
596 # cmd
597 # 0 0.5
598 # 1 0.5
599 cmd
600 0 0.1
601 1.0 0.9
602 .ft P
603 .fi
604 .SH FORMAT OF OUTPUT
605 .sp
606 At the beginning, memslap displays some configuration information as follows:
607 .sp
608 servers : 127.0.0.1:11211
609 .sp
610 threads count: 1
611 .sp
612 concurrency: 16
613 .sp
614 run time: 20s
615 .sp
616 windows size: 10k
617 .sp
618 set proportion: set_prop=0.10
619 .sp
620 get proportion: get_prop=0.90
621 .SS Where
622 .sp
623 servers : "servers"
624 .INDENT 0.0
625 .INDENT 3.5
626 .sp
627 The servers used by memslap.
628 .UNINDENT
629 .UNINDENT
630 .sp
631 threads count
632 .INDENT 0.0
633 .INDENT 3.5
634 .sp
635 The number of threads memslap runs with.
636 .UNINDENT
637 .UNINDENT
638 .sp
639 concurrency
640 .INDENT 0.0
641 .INDENT 3.5
642 .sp
643 The number of concurrencies memslap runs with.
644 .UNINDENT
645 .UNINDENT
646 .sp
647 run time
648 .INDENT 0.0
649 .INDENT 3.5
650 .sp
651 How long to run memslap.
652 .UNINDENT
653 .UNINDENT
654 .sp
655 windows size
656 .INDENT 0.0
657 .INDENT 3.5
658 .sp
659 The task window size of each concurrency.
660 .UNINDENT
661 .UNINDENT
662 .sp
663 set proportion
664 .INDENT 0.0
665 .INDENT 3.5
666 .sp
667 The proportion of set command.
668 .UNINDENT
669 .UNINDENT
670 .sp
671 get proportion
672 .INDENT 0.0
673 .INDENT 3.5
674 .sp
675 The proportion of get command.
676 .UNINDENT
677 .UNINDENT
678 .sp
679 The output of dynamic statistics is something like this:
680 .sp
681 .nf
682 .ft C
683 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
684 Get Statistics
685 Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
686 Avg(us) Std_dev Geo_dist
687 Period 5 345826 69165 65.3 0 27 2198 203
688 95.43 177.29
689 Global 20 1257935 62896 71.8 0 26 3791 224
690 117.79 192.60
691
692
693 Set Statistics
694 Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
695 Avg(us) Std_dev Geo_dist
696 Period 5 38425 7685 7.3 0 42 628 240
697 88.05 220.21
698 Global 20 139780 6989 8.0 0 37 3790 253
699 117.93 224.83
700
701
702 Total Statistics
703 Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
704 Avg(us) Std_dev Geo_dist
705 Period 5 384252 76850 72.5 0 27 2198 207
706 94.72 181.18
707 Global 20 1397720 69886 79.7 0 26 3791 227
708 117.93 195.60
709 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
710 .ft P
711 .fi
712 .SS Where
713 .sp
714 Get Statistics
715 .INDENT 0.0
716 .INDENT 3.5
717 .sp
718 Statistics information of get command
719 .UNINDENT
720 .UNINDENT
721 .sp
722 Set Statistics
723 .INDENT 0.0
724 .INDENT 3.5
725 .sp
726 Statistics information of set command
727 .UNINDENT
728 .UNINDENT
729 .sp
730 Total Statistics
731 .INDENT 0.0
732 .INDENT 3.5
733 .sp
734 Statistics information of both get and set command
735 .UNINDENT
736 .UNINDENT
737 .sp
738 Period
739 .INDENT 0.0
740 .INDENT 3.5
741 .sp
742 Result within a period
743 .UNINDENT
744 .UNINDENT
745 .sp
746 Global
747 .INDENT 0.0
748 .INDENT 3.5
749 .sp
750 Accumulated results
751 .UNINDENT
752 .UNINDENT
753 .sp
754 Ops
755 .INDENT 0.0
756 .INDENT 3.5
757 .sp
758 Total operations
759 .UNINDENT
760 .UNINDENT
761 .sp
762 TPS
763 .INDENT 0.0
764 .INDENT 3.5
765 .sp
766 Throughput, operations/second
767 .UNINDENT
768 .UNINDENT
769 .sp
770 Net
771 .INDENT 0.0
772 .INDENT 3.5
773 .sp
774 The rate of network
775 .UNINDENT
776 .UNINDENT
777 .sp
778 Get_miss
779 .INDENT 0.0
780 .INDENT 3.5
781 .sp
782 How many objects can’t be gotten
783 .UNINDENT
784 .UNINDENT
785 .sp
786 Min
787 .INDENT 0.0
788 .INDENT 3.5
789 .sp
790 The minimum response time
791 .UNINDENT
792 .UNINDENT
793 .sp
794 Max
795 .INDENT 0.0
796 .INDENT 3.5
797 .sp
798 The maximum response time
799 .UNINDENT
800 .UNINDENT
801 .sp
802 Avg:
803 .INDENT 0.0
804 .INDENT 3.5
805 .sp
806 The average response time
807 .UNINDENT
808 .UNINDENT
809 .sp
810 Std_dev
811 .INDENT 0.0
812 .INDENT 3.5
813 .sp
814 Standard deviation of response time
815 .UNINDENT
816 .UNINDENT
817 .sp
818 Geo_dist
819 .INDENT 0.0
820 .INDENT 3.5
821 .sp
822 Geometric distribution based on natural exponential function
823 .UNINDENT
824 .UNINDENT
825 .sp
826 At the end, memslap will output something like this:
827 .sp
828 .nf
829 .ft C
830 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
831 Get Statistics (1257956 events)
832 Min: 26
833 Max: 3791
834 Avg: 224
835 Geo: 192.60
836 Std: 116.23
837 Log2 Dist:
838 4: 0 10 84490 215345
839 8: 484890 459823 12543 824
840 12: 31
841
842 Set Statistics (139782 events)
843 Min: 37
844 Max: 3790
845 Avg: 253
846 Geo: 224.84
847 Std: 116.83
848 Log2 Dist:
849 4: 0 0 4200 16988
850 8: 50784 65574 2064 167
851 12: 5
852
853 Total Statistics (1397738 events)
854 Min: 26
855 Max: 3791
856 Avg: 227
857 Geo: 195.60
858 Std: 116.60
859 Log2 Dist:
860 4: 0 10 88690 232333
861 8: 535674 525397 14607 991
862 12: 36
863
864 cmd_get: 1257969
865 cmd_set: 139785
866 get_misses: 0
867 verify_misses: 0
868 verify_failed: 0
869 expired_get: 0
870 unexpired_unget: 0
871 written_bytes: 242516030
872 read_bytes: 1003702556
873 object_bytes: 152086080
874 packet_disorder: 0
875 packet_drop: 0
876 udp_timeout: 0
877
878 Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
879 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
880 .ft P
881 .fi
882 .SS Where
883 .sp
884 Get Statistics
885 .INDENT 0.0
886 .INDENT 3.5
887 .sp
888 Get statistics of response time
889 .UNINDENT
890 .UNINDENT
891 .sp
892 Set Statistics
893 .INDENT 0.0
894 .INDENT 3.5
895 .sp
896 Set statistics of response time
897 .UNINDENT
898 .UNINDENT
899 .sp
900 Total Statistics
901 .INDENT 0.0
902 .INDENT 3.5
903 .sp
904 Both get and set statistics of response time
905 .UNINDENT
906 .UNINDENT
907 .sp
908 Min
909 .INDENT 0.0
910 .INDENT 3.5
911 .sp
912 The accumulated and minimum response time
913 .UNINDENT
914 .UNINDENT
915 .sp
916 Max
917 .INDENT 0.0
918 .INDENT 3.5
919 .sp
920 The accumulated and maximum response time
921 .UNINDENT
922 .UNINDENT
923 .sp
924 Avg
925 .INDENT 0.0
926 .INDENT 3.5
927 .sp
928 The accumulated and average response time
929 .UNINDENT
930 .UNINDENT
931 .sp
932 Std
933 .INDENT 0.0
934 .INDENT 3.5
935 .sp
936 Standard deviation of response time
937 .UNINDENT
938 .UNINDENT
939 .sp
940 Log2 Dist
941 .INDENT 0.0
942 .INDENT 3.5
943 .sp
944 Geometric distribution based on logarithm 2
945 .UNINDENT
946 .UNINDENT
947 .sp
948 cmd_get
949 .INDENT 0.0
950 .INDENT 3.5
951 .sp
952 Total get commands done
953 .UNINDENT
954 .UNINDENT
955 .sp
956 cmd_set
957 .INDENT 0.0
958 .INDENT 3.5
959 .sp
960 Total set commands done
961 .UNINDENT
962 .UNINDENT
963 .sp
964 get_misses
965 .INDENT 0.0
966 .INDENT 3.5
967 .sp
968 How many objects can’t be gotten from server
969 .UNINDENT
970 .UNINDENT
971 .sp
972 verify_misses
973 .INDENT 0.0
974 .INDENT 3.5
975 .sp
976 How many objects need to verify but can’t get them
977 .UNINDENT
978 .UNINDENT
979 .sp
980 verify_failed
981 .INDENT 0.0
982 .INDENT 3.5
983 .sp
984 How many objects with insistent value
985 .UNINDENT
986 .UNINDENT
987 .sp
988 expired_get
989 .INDENT 0.0
990 .INDENT 3.5
991 .sp
992 How many objects are expired but we get them
993 .UNINDENT
994 .UNINDENT
995 .sp
996 unexpired_unget
997 .INDENT 0.0
998 .INDENT 3.5
999 .sp
1000 How many objects are unexpired but we can’t get them
1001 .UNINDENT
1002 .UNINDENT
1003 .sp
1004 written_bytes
1005 .INDENT 0.0
1006 .INDENT 3.5
1007 .sp
1008 Total written bytes
1009 .UNINDENT
1010 .UNINDENT
1011 .sp
1012 read_bytes
1013 .INDENT 0.0
1014 .INDENT 3.5
1015 .sp
1016 Total read bytes
1017 .UNINDENT
1018 .UNINDENT
1019 .sp
1020 object_bytes
1021 .INDENT 0.0
1022 .INDENT 3.5
1023 .sp
1024 Total object bytes
1025 .UNINDENT
1026 .UNINDENT
1027 .sp
1028 packet_disorder
1029 .INDENT 0.0
1030 .INDENT 3.5
1031 .sp
1032 How many UDP packages are disorder
1033 .UNINDENT
1034 .UNINDENT
1035 .sp
1036 packet_drop
1037 .INDENT 0.0
1038 .INDENT 3.5
1039 .sp
1040 How many UDP packages are lost
1041 .UNINDENT
1042 .UNINDENT
1043 .sp
1044 udp_timeout
1045 .INDENT 0.0
1046 .INDENT 3.5
1047 .sp
1048 How many times UDP time out happen
1049 .UNINDENT
1050 .UNINDENT
1051 .sp
1052 Run time
1053 .INDENT 0.0
1054 .INDENT 3.5
1055 .sp
1056 Total run time
1057 .UNINDENT
1058 .UNINDENT
1059 .sp
1060 Ops
1061 .INDENT 0.0
1062 .INDENT 3.5
1063 .sp
1064 Total operations
1065 .UNINDENT
1066 .UNINDENT
1067 .sp
1068 TPS
1069 .INDENT 0.0
1070 .INDENT 3.5
1071 .sp
1072 Throughput, operations/second
1073 .UNINDENT
1074 .UNINDENT
1075 .sp
1076 Net_rate
1077 .INDENT 0.0
1078 .INDENT 3.5
1079 .sp
1080 The average rate of network
1081 .UNINDENT
1082 .UNINDENT
1083 .SH OPTIONS
1084 .INDENT 0.0
1085 .TP
1086 .B \-s, \-\-servers=
1087 .
1088 List one or more servers to connect. Servers count must be less than
1089 threads count. e.g.: \-\-servers=localhost:1234,localhost:11211
1090 .TP
1091 .B \-T, \-\-threads=
1092 .
1093 Number of threads to startup, better equal to CPU numbers. Default 8.
1094 .TP
1095 .B \-c, \-\-concurrency=
1096 .
1097 Number of concurrency to simulate with load. Default 128.
1098 .TP
1099 .B \-n, \-\-conn_sock=
1100 .
1101 Number of TCP socks per concurrency. Default 1.
1102 .TP
1103 .B \-x, \-\-execute_number=
1104 .
1105 Number of operations(get and set) to execute for the
1106 given test. Default 1000000.
1107 .TP
1108 .B \-t, \-\-time=
1109 .
1110 How long the test to run, suffix: s\-seconds, m\-minutes, h\-hours,
1111 d\-days e.g.: \-\-time=2h.
1112 .TP
1113 .B \-F, \-\-cfg_cmd=
1114 .
1115 Load the configure file to get command,key and value distribution list.
1116 .TP
1117 .B \-w, \-\-win_size=
1118 .
1119 Task window size of each concurrency, suffix: K, M e.g.: \-\-win_size=10k.
1120 Default 10k.
1121 .TP
1122 .B \-X, \-\-fixed_size=
1123 .
1124 Fixed length of value.
1125 .TP
1126 .B \-v, \-\-verify=
1127 .
1128 The proportion of date verification, e.g.: \-\-verify=0.01
1129 .TP
1130 .B \-d, \-\-division=
1131 .
1132 Number of keys to multi\-get once. Default 1, means single get.
1133 .TP
1134 .B \-S, \-\-stat_freq=
1135 .
1136 Frequency of dumping statistic information. suffix: s\-seconds,
1137 m\-minutes, e.g.: \-\-resp_freq=10s.
1138 .TP
1139 .B \-e, \-\-exp_verify=
1140 .
1141 The proportion of objects with expire time, e.g.: \-\-exp_verify=0.01.
1142 Default no object with expire time
1143 .TP
1144 .B \-o, \-\-overwrite=
1145 .
1146 The proportion of objects need overwrite, e.g.: \-\-overwrite=0.01.
1147 Default never overwrite object.
1148 .UNINDENT
1149 .INDENT 0.0
1150 .TP
1151 .B \-R, \-\-reconnect
1152 .
1153 Reconnect support, when connection is closed it will be reconnected.
1154 .TP
1155 .B \-U, \-\-udp
1156 .
1157 UDP support, default memslap uses TCP, TCP port and UDP port of
1158 server must be same.
1159 .TP
1160 .B \-a, \-\-facebook
1161 .
1162 Whether it enables facebook test feature, set with TCP and multi\-get with UDP.
1163 .TP
1164 .B \-B, \-\-binary
1165 .
1166 Whether it enables binary protocol. Default with ASCII protocol.
1167 .UNINDENT
1168 .INDENT 0.0
1169 .TP
1170 .B \-P, \-\-tps=
1171 .
1172 Expected throughput, suffix: K, e.g.: \-\-tps=10k.
1173 .TP
1174 .B \-p, \-\-rep_write=
1175 .
1176 The first nth servers can write data, e.g.: \-\-rep_write=2.
1177 .UNINDENT
1178 .INDENT 0.0
1179 .TP
1180 .B \-b, \-\-verbose
1181 .
1182 Whether it outputs detailed information when verification fails.
1183 .TP
1184 .B \-h, \-\-help
1185 .
1186 Display this message and then exit.
1187 .TP
1188 .B \-V, \-\-version
1189 .
1190 Display the version of the application and then exit.
1191 .UNINDENT
1192 .SH EXAMPLES
1193 .sp
1194 memslap \-s 127.0.0.1:11211 \-S 5s
1195 .sp
1196 memslap \-s 127.0.0.1:11211 \-t 2m \-v 0.2 \-e 0.05 \-b
1197 .sp
1198 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-w 40k \-S 20s \-o 0.2
1199 .sp
1200 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-T 4 \-c 128 \-d 20 \-P 40k
1201 .sp
1202 memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-d 50 \-a \-n 40
1203 .sp
1204 memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m
1205 .sp
1206 memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2
1207 .SH HOME
1208 .sp
1209 To find out more information please check:
1210 \fI\%http://launchpad.org/libmemcached\fP
1211 .SH AUTHORS
1212 .sp
1213 Mingqiang Zhuang <\fI\%mingqiangzhuang@hengtiansoft.com\fP> (Schooner Technolgy)
1214 Brian Aker, <\fI\%brian@tangent.org\fP>
1215 .SH SEE ALSO
1216 .sp
1217 memcached(1) libmemcached(3)
1218 .SH AUTHOR
1219 Brian Aker
1220 .SH COPYRIGHT
1221 2011, Brian Aker
1222 .\" Generated by docutils manpage writer.
1223 .\"
1224 .