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