X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemaslap.1;h=1ec50730b06189192761a1505c5caf7fa2560562;hb=556d9cca3738f2dcecbe0cda93ba9dd89d1a7a31;hp=ca4926a6a04ea91c29a6116cc0999a737e0e829d;hpb=2a1e29bce497c25fad73b9d74db4a3daf74413b5;p=m6w6%2Flibmemcached diff --git a/docs/man/memaslap.1 b/docs/man/memaslap.1 index ca4926a6..a1b675a4 100644 --- a/docs/man/memaslap.1 +++ b/docs/man/memaslap.1 @@ -1,4 +1,4 @@ -.TH "MEMASLAP" "1" "April 09, 2011" "0.47" "libmemcached" +.TH "MEMASLAP" "1" "April 09, 2012" "1.0.6" "libmemcached" .SH NAME memaslap \- libmemcached Documentation . @@ -31,27 +31,33 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" Man page generated from reStructeredText. . .SH SYNOPSIS +.sp +memaslap [options] .INDENT 0.0 .TP .B \-\-help .UNINDENT +.INDENT 0.0 +.TP +.B MEMCACHED_SERVERS +.UNINDENT .SH DESCRIPTION .sp -\fBmemaslap\fP is a load generation and benchmark tool for memcached(1) -servers. It generates configurable workload such as threads, concurrencies, connections, -run time, overwrite, miss rate, key size, value size, get/set proportion, -expected throughput, and so on. Furthermore, it also testss data +\fBmemaslap\fP is a load generation and benchmark tool for memcached +servers. It generates configurable workload such as threads, concurrencies, +connections, run time, overwrite, miss rate, key size, value size, get/set +proportion, expected throughput, and so on. Furthermore, it also testss data verification, expire\-time verification, UDP, binary protocol, facebook test, replication test, multi\-get and reconnection, etc. .sp -Memslap manages network connections like memcached with +Memaslap manages network connections like memcached with libevent. Each thread of memaslap is bound with a CPU core, all the threads don\(aqt communicate with each other, and there are several socket connections in each thread. Each connection keeps key size distribution, value size distribution, and command distribution by itself. .sp -You can specify servers via the \fB\-\-servers\fP option or via the -environment variable \fBMEMCACHED_SERVERS\fP. +You can specify servers via the \fImemslap \-\-servers\fP option or via the +environment variable \fI\%MEMCACHED_SERVERS\fP. .SH FEATURES .sp Memslap is developed to for the following purposes: @@ -161,9 +167,9 @@ layer. .sp Because each thread is self\-governed, memaslap can assign different threads to handle different memcached servers. This is just one of -the ways in which memaslap testss multiple servers. The only +the ways in which memaslap tests multiple servers. The only limitation is that the number of servers cannot be greater than the number -of threads. The other way to tests multiple servers is for replication +of threads. The other way to test multiple servers is for replication test. Each concurrency has one socket connection to each memcached server. For the implementation, memaslap can set some objects to one memcached server, and get these objects from the other servers. @@ -175,7 +181,7 @@ pack and send the commands together. Memslap testss both the ASCII protocol and binary protocol, but it runs on the ASCII protocol by default. Memslap by default runs on the TCP protocol, but it also -testss UDP. Because UDP is unreliable, dropped packages and out\-of\-order +tests UDP. Because UDP is unreliable, dropped packages and out\-of\-order packages may occur. Memslap creates a memory buffer to handle these problems. Memslap tries to read all the response data of one command from the server and reorders the response data. If some packages @@ -253,7 +259,7 @@ number of them. The default number of threads is 1; the default number of concurrency is 16. The user can use “—threads” and “\-\-concurrency” to specify these variables. .sp -If the system testss setting CPU affinity and the number of threads +If the system tests setting CPU affinity and the number of threads specified by the user is greater than 1, memaslap will try to bind each thread to a different CPU core. So if you want to get the best performance memaslap, it is better to specify the number of @@ -263,7 +269,6 @@ of the limitation of implementation, the number of concurrencies could be the multiple of the number of threads. .INDENT 0.0 .IP 1. 3 -. For 8 CPU cores system .UNINDENT .sp @@ -278,7 +283,6 @@ For example: \-\-threads=12 \-\-concurrency=144 .INDENT 0.0 .IP 2. 3 -. For 16 CPU cores system .UNINDENT .sp @@ -324,7 +328,6 @@ concurrency=128. win_size=10k .INDENT 0.0 .IP 2. 3 -. cache_size=4G .UNINDENT .sp @@ -337,7 +340,6 @@ win_size=8k win_size=11k .INDENT 0.0 .IP 3. 3 -. cache_size=16G .UNINDENT .sp @@ -619,7 +621,6 @@ get proportion: get_prop=0.90 servers : "servers" .INDENT 0.0 .INDENT 3.5 -.sp The servers used by memaslap. .UNINDENT .UNINDENT @@ -627,7 +628,6 @@ The servers used by memaslap. threads count .INDENT 0.0 .INDENT 3.5 -.sp The number of threads memaslap runs with. .UNINDENT .UNINDENT @@ -635,7 +635,6 @@ The number of threads memaslap runs with. concurrency .INDENT 0.0 .INDENT 3.5 -.sp The number of concurrencies memaslap runs with. .UNINDENT .UNINDENT @@ -643,7 +642,6 @@ The number of concurrencies memaslap runs with. run time .INDENT 0.0 .INDENT 3.5 -.sp How long to run memaslap. .UNINDENT .UNINDENT @@ -651,7 +649,6 @@ How long to run memaslap. windows size .INDENT 0.0 .INDENT 3.5 -.sp The task window size of each concurrency. .UNINDENT .UNINDENT @@ -659,7 +656,6 @@ The task window size of each concurrency. set proportion .INDENT 0.0 .INDENT 3.5 -.sp The proportion of set command. .UNINDENT .UNINDENT @@ -667,7 +663,6 @@ The proportion of set command. get proportion .INDENT 0.0 .INDENT 3.5 -.sp The proportion of get command. .UNINDENT .UNINDENT @@ -710,7 +705,6 @@ Global 20 1397720 69886 79.7 0 26 3791 227 Get Statistics .INDENT 0.0 .INDENT 3.5 -.sp Statistics information of get command .UNINDENT .UNINDENT @@ -718,7 +712,6 @@ Statistics information of get command Set Statistics .INDENT 0.0 .INDENT 3.5 -.sp Statistics information of set command .UNINDENT .UNINDENT @@ -726,7 +719,6 @@ Statistics information of set command Total Statistics .INDENT 0.0 .INDENT 3.5 -.sp Statistics information of both get and set command .UNINDENT .UNINDENT @@ -734,7 +726,6 @@ Statistics information of both get and set command Period .INDENT 0.0 .INDENT 3.5 -.sp Result within a period .UNINDENT .UNINDENT @@ -742,7 +733,6 @@ Result within a period Global .INDENT 0.0 .INDENT 3.5 -.sp Accumulated results .UNINDENT .UNINDENT @@ -750,7 +740,6 @@ Accumulated results Ops .INDENT 0.0 .INDENT 3.5 -.sp Total operations .UNINDENT .UNINDENT @@ -758,7 +747,6 @@ Total operations TPS .INDENT 0.0 .INDENT 3.5 -.sp Throughput, operations/second .UNINDENT .UNINDENT @@ -766,7 +754,6 @@ Throughput, operations/second Net .INDENT 0.0 .INDENT 3.5 -.sp The rate of network .UNINDENT .UNINDENT @@ -774,7 +761,6 @@ The rate of network Get_miss .INDENT 0.0 .INDENT 3.5 -.sp How many objects can’t be gotten .UNINDENT .UNINDENT @@ -782,7 +768,6 @@ How many objects can’t be gotten Min .INDENT 0.0 .INDENT 3.5 -.sp The minimum response time .UNINDENT .UNINDENT @@ -790,7 +775,6 @@ The minimum response time Max .INDENT 0.0 .INDENT 3.5 -.sp The maximum response time .UNINDENT .UNINDENT @@ -798,7 +782,6 @@ The maximum response time Avg: .INDENT 0.0 .INDENT 3.5 -.sp The average response time .UNINDENT .UNINDENT @@ -806,7 +789,6 @@ The average response time Std_dev .INDENT 0.0 .INDENT 3.5 -.sp Standard deviation of response time .UNINDENT .UNINDENT @@ -814,7 +796,6 @@ Standard deviation of response time Geo_dist .INDENT 0.0 .INDENT 3.5 -.sp Geometric distribution based on natural exponential function .UNINDENT .UNINDENT @@ -880,7 +861,6 @@ Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s Get Statistics .INDENT 0.0 .INDENT 3.5 -.sp Get statistics of response time .UNINDENT .UNINDENT @@ -888,7 +868,6 @@ Get statistics of response time Set Statistics .INDENT 0.0 .INDENT 3.5 -.sp Set statistics of response time .UNINDENT .UNINDENT @@ -896,7 +875,6 @@ Set statistics of response time Total Statistics .INDENT 0.0 .INDENT 3.5 -.sp Both get and set statistics of response time .UNINDENT .UNINDENT @@ -904,7 +882,6 @@ Both get and set statistics of response time Min .INDENT 0.0 .INDENT 3.5 -.sp The accumulated and minimum response time .UNINDENT .UNINDENT @@ -912,7 +889,6 @@ The accumulated and minimum response time Max .INDENT 0.0 .INDENT 3.5 -.sp The accumulated and maximum response time .UNINDENT .UNINDENT @@ -920,7 +896,6 @@ The accumulated and maximum response time Avg .INDENT 0.0 .INDENT 3.5 -.sp The accumulated and average response time .UNINDENT .UNINDENT @@ -928,7 +903,6 @@ The accumulated and average response time Std .INDENT 0.0 .INDENT 3.5 -.sp Standard deviation of response time .UNINDENT .UNINDENT @@ -936,7 +910,6 @@ Standard deviation of response time Log2 Dist .INDENT 0.0 .INDENT 3.5 -.sp Geometric distribution based on logarithm 2 .UNINDENT .UNINDENT @@ -944,7 +917,6 @@ Geometric distribution based on logarithm 2 cmd_get .INDENT 0.0 .INDENT 3.5 -.sp Total get commands done .UNINDENT .UNINDENT @@ -952,7 +924,6 @@ Total get commands done cmd_set .INDENT 0.0 .INDENT 3.5 -.sp Total set commands done .UNINDENT .UNINDENT @@ -960,7 +931,6 @@ Total set commands done get_misses .INDENT 0.0 .INDENT 3.5 -.sp How many objects can’t be gotten from server .UNINDENT .UNINDENT @@ -968,7 +938,6 @@ How many objects can’t be gotten from server verify_misses .INDENT 0.0 .INDENT 3.5 -.sp How many objects need to verify but can’t get them .UNINDENT .UNINDENT @@ -976,7 +945,6 @@ How many objects need to verify but can’t get them verify_failed .INDENT 0.0 .INDENT 3.5 -.sp How many objects with insistent value .UNINDENT .UNINDENT @@ -984,7 +952,6 @@ How many objects with insistent value expired_get .INDENT 0.0 .INDENT 3.5 -.sp How many objects are expired but we get them .UNINDENT .UNINDENT @@ -992,7 +959,6 @@ How many objects are expired but we get them unexpired_unget .INDENT 0.0 .INDENT 3.5 -.sp How many objects are unexpired but we can’t get them .UNINDENT .UNINDENT @@ -1000,7 +966,6 @@ How many objects are unexpired but we can’t get them written_bytes .INDENT 0.0 .INDENT 3.5 -.sp Total written bytes .UNINDENT .UNINDENT @@ -1008,7 +973,6 @@ Total written bytes read_bytes .INDENT 0.0 .INDENT 3.5 -.sp Total read bytes .UNINDENT .UNINDENT @@ -1016,7 +980,6 @@ Total read bytes object_bytes .INDENT 0.0 .INDENT 3.5 -.sp Total object bytes .UNINDENT .UNINDENT @@ -1024,7 +987,6 @@ Total object bytes packet_disorder .INDENT 0.0 .INDENT 3.5 -.sp How many UDP packages are disorder .UNINDENT .UNINDENT @@ -1032,7 +994,6 @@ How many UDP packages are disorder packet_drop .INDENT 0.0 .INDENT 3.5 -.sp How many UDP packages are lost .UNINDENT .UNINDENT @@ -1040,7 +1001,6 @@ How many UDP packages are lost udp_timeout .INDENT 0.0 .INDENT 3.5 -.sp How many times UDP time out happen .UNINDENT .UNINDENT @@ -1048,7 +1008,6 @@ How many times UDP time out happen Run time .INDENT 0.0 .INDENT 3.5 -.sp Total run time .UNINDENT .UNINDENT @@ -1056,7 +1015,6 @@ Total run time Ops .INDENT 0.0 .INDENT 3.5 -.sp Total operations .UNINDENT .UNINDENT @@ -1064,7 +1022,6 @@ Total operations TPS .INDENT 0.0 .INDENT 3.5 -.sp Throughput, operations/second .UNINDENT .UNINDENT @@ -1072,7 +1029,6 @@ Throughput, operations/second Net_rate .INDENT 0.0 .INDENT 3.5 -.sp The average rate of network .UNINDENT .UNINDENT @@ -1080,109 +1036,86 @@ The average rate of network .INDENT 0.0 .TP .B \-s, \-\-servers= -. List one or more servers to connect. Servers count must be less than threads count. e.g.: \-\-servers=localhost:1234,localhost:11211 .TP .B \-T, \-\-threads= -. Number of threads to startup, better equal to CPU numbers. Default 8. .TP .B \-c, \-\-concurrency= -. Number of concurrency to simulate with load. Default 128. .TP .B \-n, \-\-conn_sock= -. Number of TCP socks per concurrency. Default 1. .TP .B \-x, \-\-execute_number= -. Number of operations(get and set) to execute for the given test. Default 1000000. .TP .B \-t, \-\-time= -. How long the test to run, suffix: s\-seconds, m\-minutes, h\-hours, d\-days e.g.: \-\-time=2h. .TP .B \-F, \-\-cfg_cmd= -. Load the configure file to get command,key and value distribution list. .TP .B \-w, \-\-win_size= -. Task window size of each concurrency, suffix: K, M e.g.: \-\-win_size=10k. Default 10k. .TP .B \-X, \-\-fixed_size= -. Fixed length of value. .TP .B \-v, \-\-verify= -. The proportion of date verification, e.g.: \-\-verify=0.01 .TP .B \-d, \-\-division= -. Number of keys to multi\-get once. Default 1, means single get. .TP .B \-S, \-\-stat_freq= -. Frequency of dumping statistic information. suffix: s\-seconds, m\-minutes, e.g.: \-\-resp_freq=10s. .TP .B \-e, \-\-exp_verify= -. The proportion of objects with expire time, e.g.: \-\-exp_verify=0.01. Default no object with expire time .TP .B \-o, \-\-overwrite= -. The proportion of objects need overwrite, e.g.: \-\-overwrite=0.01. Default never overwrite object. .UNINDENT .INDENT 0.0 .TP .B \-R, \-\-reconnect -. Reconnect tests, when connection is closed it will be reconnected. .TP .B \-U, \-\-udp -. UDP tests, default memaslap uses TCP, TCP port and UDP port of server must be same. .TP .B \-a, \-\-facebook -. Whether it enables facebook test feature, set with TCP and multi\-get with UDP. .TP .B \-B, \-\-binary -. Whether it enables binary protocol. Default with ASCII protocol. .UNINDENT .INDENT 0.0 .TP .B \-P, \-\-tps= -. Expected throughput, suffix: K, e.g.: \-\-tps=10k. .TP .B \-p, \-\-rep_write= -. The first nth servers can write data, e.g.: \-\-rep_write=2. .UNINDENT .INDENT 0.0 .TP .B \-b, \-\-verbose -. Whether it outputs detailed information when verification fails. .TP .B \-h, \-\-help -. Display this message and then exit. .TP .B \-V, \-\-version -. Display the version of the application and then exit. .UNINDENT .SH EXAMPLES @@ -1203,7 +1136,7 @@ memaslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2 .SH HOME .sp To find out more information please check: -\fI\%http://launchpad.org/libmemcached\fP +\fI\%http://libmemcached.org/\fP .SH AUTHORS .sp Mingqiang Zhuang <\fI\%mingqiangzhuang@hengtiansoft.com\fP> (Schooner Technolgy)