Tar Archive: /hpux/Misc/libmemcached-0.46/libmemcached-0.46-hppa_32-11.23.depot.gz
Filename: libmemcached/libmemcached-MAN/usr/local/share/man/man1/memslap.1
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MEMSLAP.POP 1"
.TH MEMSLAP.POP 1 "2010-06-28" "" "memslap"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
memslap \- Load testing and benchmarking tool for memcached
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& memslap [options]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBmemslap\fR is a load generation and benchmark tool for \fImemcached\fR\|(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 supports data
verification, expire-time verification, \s-1UDP\s0, binary protocol, facebook test,
replication test, multi-get and reconnection, etc.
.PP
Memslap manages network connections like memcached with
libevent. Each thread of memslap is bound with a \s-1CPU\s0 core, all
the threads don't 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.
.PP
You can specify servers via the \fB\-\-servers\fR option or via the
environment variable \f(CW\*(C`MEMCACHED_SERVERS\*(C'\fR.
.SH "FEATURES"
.IX Header "FEATURES"
Memslap is developed to for the following purposes:
.IP "Manages network connections with libevent asynchronously." 4
.IX Item "Manages network connections with libevent asynchronously."
.PD 0
.IP "Set both \s-1TCP\s0 and \s-1UDP\s0 up to use non-blocking \s-1IO\s0." 4
.IX Item "Set both TCP and UDP up to use non-blocking IO."
.IP "Improves parallelism: higher performance in multi-threads environments." 4
.IX Item "Improves parallelism: higher performance in multi-threads environments."
.IP "Improves time efficiency: faster processing speed." 4
.IX Item "Improves time efficiency: faster processing speed."
.IP "Generates key and value more efficiently; key size distribution and value size distribution are configurable." 4
.IX Item "Generates key and value more efficiently; key size distribution and value size distribution are configurable."
.IP "Supports get, multi-get, and set commands; command distribution is configurable." 4
.IX Item "Supports get, multi-get, and set commands; command distribution is configurable."
.IP "Supports controllable miss rate and overwrite rate." 4
.IX Item "Supports controllable miss rate and overwrite rate."
.IP "Supports data and expire-time verification." 4
.IX Item "Supports data and expire-time verification."
.IP "Supports dumping statistic information periodically." 4
.IX Item "Supports dumping statistic information periodically."
.IP "Supports thousands of \s-1TCP\s0 connections." 4
.IX Item "Supports thousands of TCP connections."
.IP "Supports binary protocol." 4
.IX Item "Supports binary protocol."
.IP "Supports facebook test (set with \s-1TCP\s0 and multi-get with \s-1UDP\s0) and replication test." 4
.IX Item "Supports facebook test (set with TCP and multi-get with UDP) and replication test."
.PD
.SH "DETAILS"
.IX Header "DETAILS"
.SS "Effective implementation of network."
.IX Subsection "Effective implementation of network."
For memslap, both \s-1TCP\s0 and \s-1UDP\s0 use non-blocking network \s-1IO\s0. All
the network events are managed by libevent as memcached. The network module
of memslap is similar to memcached. Libevent can ensure
memslap can handle network very efficiently.
.SS "Effective implementation of multi-threads and concurrency"
.IX Subsection "Effective implementation of multi-threads and concurrency"
Memslap has the similar implementation of multi-threads to
memcached. Memslap creates one or more self-governed threads;
each thread is bound with one \s-1CPU\s0 core if the system supports setting \s-1CPU\s0
core affinity.
.PP
In addition, each thread has a libevent to manage the events of the network;
each thread has one or more self-governed concurrencies; and each
concurrency has one or more socket connections. All the concurrencies dona\*^XXt
communicate with each other even though they are in the same thread.
.PP
Memslap can create thousands of socket connections, and each
concurrency has tens of socket connections. Each concurrency randomly or
sequentially selects one socket connection from its socket connection pool
to run, so memslap can ensure each concurrency handles one
socket connection at any given time. Users can specify the number of
concurrency and socket connections of each concurrency according to their
expected workload.
.SS "Effective implementation of generating key and value"
.IX Subsection "Effective implementation of generating key and value"
In order to improve time efficiency and space efficiency,
memslap creates a random characters table with 10M characters. All the
suffixes of keys and values are generated from this random characters table.
.PP
Memslap uses the offset in the character table and the length
of the string to identify a string. It can save much memory.
Each key contains two parts, a prefix and a suffix. The prefix is an
uint64_t, 8 bytes. In order to verify the data set before,
memslap need to ensure each key is unique, so it uses the prefix to identify
a key. The prefix cannot include illegal characters, such as a\*^XX\era\*^XX, a\*^XX\ena\*^XX,
a\*^XX\e0a\*^XX and a\*^XX a\*^XX. And memslap has an algorithm to ensure that.
.PP
Memslap doesna\*^XXt generate all the objects (key-value pairs) at
the beginning. It only generates enough objects to fill the task window
(default 10K objects) of each concurrency. Each object has the following
basic information, key prefix, key suffix offset in the character table, key
length, value offset in the character table, and value length.
.PP
In the work process, each concurrency sequentially or randomly selects an
object from the window to do set operation or get operation. At the same
time, each concurrency kicks objects out of its window and adds new object
into it.
.SS "Simple but useful task scheduling"
.IX Subsection "Simple but useful task scheduling"
Memslap uses libevent to schedule all the concurrencies of
threads, and each concurrency schedules tasks based on the local task
window. Memslap assumes that if each concurrency keeps the same
key distribution, value distribution and commands distribution, from
outside, memslap keeps all the distribution as a whole.
Each task window includes a lot of objects, each object stores its basic
information, such as key, value, expire time, and so on. At any time, all
the objects in the window keep the same and fixed key and value
distribution. If an object is overwritten, the value of the object will be
updated. Memslap verifies the data or expire-time according to
the object information stored in the task window.
.PP
Libevent selects which concurrency to handle based on a specific network
event. Then the concurrency selects which command (get or set) to operate
based on the command distribution. If it needs to kick out an old object and
add a new object, in order to keep the same key and value distribution, the
new object must have the same key length and value length.
.PP
If memcached server has two cache layers (memory and \s-1SSD\s0), running
memslap with different window sizes can get different cache
miss rates. If memslap adds enough objects into the windows at
the beginning, and the cache of memcached cannot store all the objects
initialized, then memslap will get some objects from the second
cache layer. It causes the first cache layer to miss. So the user can
specify the window size to get the expected miss rate of the first cache
layer.
.SS "Useful implementation of multi-servers , \s-1UDP\s0, \s-1TCP\s0, multi-get and binary protocol"
.IX Subsection "Useful implementation of multi-servers , UDP, TCP, multi-get and binary protocol"
Because each thread is self-governed, memslap can assign
different threads to handle different memcached servers. This is just one of
the ways in which memslap supports multiple servers. The only
limitation is that the number of servers cannot be greater than the number
of threads. The other way to support multiple servers is for replication
test. Each concurrency has one socket connection to each memcached server.
For the implementation, memslap can set some objects to one
memcached server, and get these objects from the other servers.
.PP
By default, Memslap does single get. If the user specifies
multi-get option, memslap will collect enough get commands and
pack and send the commands together.
.PP
Memslap supports both the \s-1ASCII\s0 protocol and binary protocol,
but it runs on the \s-1ASCII\s0 protocol by default.
Memslap by default runs on the \s-1TCP\s0 protocol, but it also
supports \s-1UDP\s0. Because \s-1UDP\s0 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
get lost, the waiting timeout mechanism can ensure half-baked packages will
be discarded and the next command will be sent.
.SH "USAGE"
.IX Header "USAGE"
Below are some usage samples:
.IP "memslap \-s 127.0.0.1:11211 \-S 5s" 4
.IX Item "memslap -s 127.0.0.1:11211 -S 5s"
.PD 0
.IP "memslap \-s 127.0.0.1:11211 \-t 2m \-v 0.2 \-e 0.05 \-b" 4
.IX Item "memslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b"
.IP "memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-w 40k \-S 20s \-o 0.2" 4
.IX Item "memslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2"
.IP "memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-T 4 \-c 128 \-d 20 \-P 40k" 4
.IX Item "memslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k"
.IP "memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-d 50 \-a \-n 40" 4
.IX Item "memslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40"
.IP "memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m" 4
.IX Item "memslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m"
.IP "memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2" 4
.IX Item "memslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2"
.PD
.PP
The user must specify one server at least to run memslap. The
rest of the parameters have default values, as shown below:
.PP
Thread number = 1 Concurrency = 16
.PP
Run time = 600 seconds Configuration file = \s-1NULL\s0
.PP
Key size = 64 Value size = 1024
.PP
Get/set = 9:1 Window size = 10k
.PP
Execute number = 0 Single get = true
.PP
Multi-get = false Number of sockets of each concurrency = 1
.PP
Reconnect = false Data verification = false
.PP
Expire-time verification = false \s-1ASCII\s0 protocol = true
.PP
Binary protocol = false Dumping statistic information
.PP
periodically = false
.PP
Overwrite proportion = 0% \s-1UDP\s0 = false
.PP
\&\s-1TCP\s0 = true Limit throughput = false
.PP
Facebook test = false Replication test = false
.SS "Key size, value size and command distribution."
.IX Subsection "Key size, value size and command distribution."
All the distributions are read from the configuration file specified by user
with a\*^XXa\*^XXcfg_cmda\*^XX option. If the user does not specify a configuration file,
memslap will run with the default distribution (key size = 64,
value size = 1024, get/set = 9:1). For information on how to edit the
configuration file, refer to the a\*^XXConfiguration Filea\*^XX section.
.PP
The minimum key size is 16 bytes; the maximum key size is 250 bytes. The
precision of proportion is 0.001. The proportion of distribution will be
rounded to 3 decimal places.
.PP
The minimum value size is 1 bytes; the maximum value size is 1M bytes. The
precision of proportion is 0.001. The proportion of distribution will be
rounded to 3 decimal places.
Currently, memslap only supports set and get commands. And it
supports 100% set and 100% get. For 100% get, it will preset some objects to
the server.
.SS "Multi-thread and concurrency"
.IX Subsection "Multi-thread and concurrency"
The high performance of memslap benefits from the special
schedule of thread and concurrency. Ita\*^XXs important to specify the proper
number of them. The default number of threads is 1; the default number of
concurrency is 16. The user can use a\*^XXa\*^XXthreadsa\*^XX and a\*^XX\*(--concurrencya\*^XX to
specify these variables.
.PP
If the system supports setting \s-1CPU\s0 affinity and the number of threads
specified by the user is greater than 1, memslap will try to
bind each thread to a different \s-1CPU\s0 core. So if you want to get the best
performance memslap, it is better to specify the number of
thread equal to the number of \s-1CPU\s0 cores. The number of threads specified by
the user can also be less or greater than the number of \s-1CPU\s0 cores. Because
of the limitation of implementation, the number of concurrencies could be
the multiple of the number of threads.
.PP
1. For 8 \s-1CPU\s0 cores system
.PP
For example:
.PP
\&\-\-threads=2 \-\-concurrency=128
.PP
\&\-\-threads=8 \-\-concurrency=128
.PP
\&\-\-threads=8 \-\-concurrency=256
.PP
\&\-\-threads=12 \-\-concurrency=144
.PP
2. For 16 \s-1CPU\s0 cores system
.PP
For example:
.PP
\&\-\-threads=8 \-\-concurrency=128
.PP
\&\-\-threads=16 \-\-concurrency=256
.PP
\&\-\-threads=16 \-\-concurrency=512
.PP
\&\-\-threads=24 \-\-concurrency=288
.PP
The memslap performs very well, when
used to test the performance of memcached servers.
Most of the time, the bottleneck is the network or
the server. If for some reason the user wants to
limit the performance of memslap, there
are two ways to do this:
.PP
Decrease the number of threads and concurrencies.
Use the option a\*^XX\*(--tpsa\*^XX that memslap
provides to limit the throughput. This option allows
the user to get the expected throughput. For
example, assume that the maximum throughput is 50
kops/s for a specific configuration, you can specify
the throughput equal to or less than the maximum
throughput using a\*^XX\*(--tpsa\*^XX option.
.SS "Window size"
.IX Subsection "Window size"
Most of the time, the user does not need to specify the window size. The
default window size is 10k. For Schooner Memcached, the user can specify
different window sizes to get different cache miss rates based on the test
case. Memslap supports cache miss rate between 0% and 100%.
If you use this utility to test the performance of Schooner Memcached, you
can specify a proper window size to get the expected cache miss rate. The
formula for calculating window size is as follows:
.PP
Assume that the key size is 128 bytes, and the value size is 2048 bytes, and
concurrency=128.
.PP
1. Small cache cache_size=1M, 100% cache miss (all data get from \s-1SSD\s0).
win_size=10k
.PP
2. cache_size=4G
.PP
(1). cache miss rate 0%
.PP
win_size=8k
.PP
(2). cache miss rate 5%
.PP
win_size=11k
.PP
3. cache_size=16G
.PP
(1). cache miss rate 0%
.PP
win_size=32k
.PP
(2). cache miss
.PP
rate 5%
.PP
win_size=46k
.PP
The formula for calculating window size for cache miss rate 0%:
.PP
cache_size / concurrency / (key_size + value_size) * 0.5
.PP
The formula for calculating window size for cache miss rate 5%:
.PP
cache_size / concurrency / (key_size + value_size) * 0.7
.SS "Verification"
.IX Subsection "Verification"
Memslap supports both data verification and expire-time
verification. The user can use \*(L"\-\-verify=\*(R" or \*(L"\-v\*(R" to specify the proportion
of data verification. In theory, it supports 100% data verification. The
user can use \*(L"\-\-exp_verify=\*(R" or \*(L"\-e\*(R" to specify the proportion of
expire-time verification. In theory, it supports 100% expire-time
verification. Specify the \*(L"\-\-verbose\*(R" options to get more detailed error
information.
.PP
For example: \-\-exp_verify=0.01 a\*^XXverify=0.1 , it means that 1% of the objects
set with expire-time, 10% of the objects gotten will be verified. If the
objects are gotten, memslap will verify the expire-time and
value.
.SS "multi-servers and multi-clients"
.IX Subsection "multi-servers and multi-clients"
Memslap supports multi-servers based on self-governed thread.
There is a limitation that the number of servers cannot be greater than the
number of threads. Memslap assigns one thread to handle one
server at least. The user can use the \*(L"\-\-servers=\*(R" or \*(L"\-s\*(R" option to specify
multi-servers.
.PP
For example:
.PP
\&\-\-servers=10.1.1.1:11211,10.1.1.2:11212,10.1.1.3:11213 \-\-threads=6 \-\-concurrency=36
.PP
The above command means that there are 6 threads, with each thread having 6
concurrencies and that threads 0 and 3 handle server 0 (10.1.1.1); threads 1
and 4 handle server 1 (10.1.1.2); and thread 2 and 5 handle server 2
(10.1.1.3).
.PP
All the threads and concurrencies in memslap are self-governed.
.PP
So is memslap. The user can start up several
memslap instances. The user can run memslap on different client
machines to communicate with the same memcached server at the same. It is
recommended that the user start different memslap on different
machines using the same configuration.
.SS "Run with execute number mode or time mode"
.IX Subsection "Run with execute number mode or time mode"
The default memslap runs with time mode. The default run time
is 10 minutes. If it times out, memslap will exit. Do not
specify both execute number mode and time mode at the same time; just
specify one instead.
.PP
For example:
.PP
\&\-\-time=30s (It means the test will run 30 seconds.)
.PP
\&\-\-execute_number=100000 (It means that after running 100000 commands, the test will exit.)
.SS "Dump statistic information periodically."
.IX Subsection "Dump statistic information periodically."
The user can use \*(L"\-\-stat_freq=\*(R" or \*(L"\-S\*(R" to specify the frequency.
.PP
For example:
.PP
\&\-\-stat_freq=20s
.PP
Memslap will dump the statistics of the commands (get and set) at the frequency of every 20
seconds.
.PP
For more information on the format of dumping statistic information, refer to a\*^XXFormat of Outputa\*^XX section.
.SS "Multi-get"
.IX Subsection "Multi-get"
The user can use \*(L"\-\-division=\*(R" or \*(L"\-d\*(R" to specify multi-get keys count.
Memslap by default does single get with \s-1TCP\s0. Memslap also supports data
verification and expire-time verification for multi-get.
.PP
Memslap supports multi-get with both \s-1TCP\s0 and \s-1UDP\s0. Because of
the different implementation of the \s-1ASCII\s0 protocol and binary protocol,
there are some differences between the two. For the \s-1ASCII\s0 protocol,
memslap sends one a\*^XXmulti\-geta\*^XX to the server once. For the
binary protocol, memslap sends several single get commands
together as a\*^XXmulti\-geta\*^XX to the server.
.SS "\s-1UDP\s0 and \s-1TCP\s0"
.IX Subsection "UDP and TCP"
Memslap supports both \s-1UDP\s0 and \s-1TCP\s0. For \s-1TCP\s0,
memslap does not reconnect the memcached server if socket connections are
lost. If all the socket connections are lost or memcached server crashes,
memslap will exit. If the user specifies the a\*^XX\*(--reconnecta\*^XX
option when socket connections are lost, it will reconnect them.
.PP
User can use a\*^XX\*(--udpa\*^XX to enable the \s-1UDP\s0 feature, but \s-1UDP\s0 comes with some
limitations:
.PP
\&\s-1UDP\s0 cannot set data more than 1400 bytes.
.PP
\&\s-1UDP\s0 is not supported by the binary protocol because the binary protocol of
memcached does not support that.
.PP
\&\s-1UDP\s0 doesna\*^XXt support reconnection.
.SS "Facebook test"
.IX Subsection "Facebook test"
Set data with \s-1TCP\s0 and multi-get with \s-1UDP\s0. Specify the following options:
.PP
\&\*(L"\-\-facebook \-\-division=50\*(R"
.PP
If you want to create thousands of \s-1TCP\s0 connections, specify the
.PP
\&\*(L"\-\-conn_sock=\*(R" option.
.PP
For example: \-\-facebook \-\-division=50 \-\-conn_sock=200
.PP
The above command means that memslap will do facebook test,
each concurrency has 200 socket \s-1TCP\s0 connections and one \s-1UDP\s0 socket.
.PP
Memslap sets objects with the \s-1TCP\s0 socket, and multi-gets 50
objects once with the \s-1UDP\s0 socket.
.PP
If you specify \*(L"\-\-division=50\*(R", the key size must be less that 25 bytes
because the \s-1UDP\s0 packet size is 1400 bytes.
.SS "Replication test"
.IX Subsection "Replication test"
For replication test, the user must specify at least two memcached servers.
The user can use a\*^XXa\*^XXrep_write=a\*^XX option to enable feature.
.PP
For example:
.PP
\&\-\-servers=10.1.1.1:11211,10.1.1.2:11212 a\*^XXrep_write=2
.PP
The above command means that there are 2 replication memcached servers,
memslap will set objects to both server 0 and server 1, get
objects which are set to server 0 before from server 1, and also get objects
which are set to server 1 before from server 0. If server 0 crashes,
memslap will only get objects from server 1. If server 0 comes
back to life again, memslap will reconnect server 0. If both
server 0 and server 1 crash, memslap will exit.
.SS "Supports thousands of \s-1TCP\s0 connections"
.IX Subsection "Supports thousands of TCP connections"
Start memslap with \*(L"\-\-conn_sock=\*(R" or \*(L"\-n\*(R" to enable this
feature. Make sure that your system can support opening thousands of files
and creating thousands of sockets. However, this feature does not support
reconnection if sockets disconnect.
.PP
For example:
.PP
\&\-\-threads=8 \-\-concurrency=128 \-\-conn_sock=128
.PP
The above command means that memslap starts up 8 threads, each
thread has 16 concurrencies, each concurrency has 128 \s-1TCP\s0 socket
connections, and the total number of \s-1TCP\s0 socket connections is 128 * 128 =
16384.
.SS "Supports binary protocol"
.IX Subsection "Supports binary protocol"
Start memslap with \*(L"\-\-binary\*(R" or \*(L"\-B\*(R" options to enable this
feature. It supports all the above features except \s-1UDP\s0, because the latest
memcached 1.3.3 does not implement binary \s-1UDP\s0 protocol.
.PP
For example:
.PP
\&\-\-binary
.PP
Since memcached 1.3.3 doesn't implement binary \s-1UDP\s0 protocol,
memslap does not support \s-1UDP\s0. In addition, memcached 1.3.3 does not support
multi-get. If you specify \*(L"\-\-division=50\*(R" option, it just sends 50 get
commands together as a\*^XXmulit\-geta\*^XX to the server.
.SH "Configuration file"
.IX Header "Configuration file"
This section describes the format of the configuration file. By default
when no configuration file is specified memslap reads the default
one located at ~/.memslap.cnf.
.PP
Below is a sample configuration file:
.PP
.Vb 10
\& ***************************************************************************
\& #comments should start with \*(Aq#\*(Aq
\& #key
\& #start_len end_len proportion
\& #
\& #key length range from start_len to end_len
\& #start_len must be equal to or greater than 16
\& #end_len must be equal to or less than 250
\& #start_len must be equal to or greater than end_len
\& #memslap will generate keys according to the key range
\& #proportion: indicates keys generated from one range accounts for the total
\& generated keys
\& #
\& #example1: key range 16~100 accounts for 80%
\& # key range 101~200 accounts for 10%
\& # key range 201~250 accounts for 10%
\& # total should be 1 (0.8+0.1+0.1 = 1)
\& #
\& # 16 100 0.8
\& # 101 200 0.1
\& # 201 249 0.1
\& #
\& #example2: all keys length are 128 bytes
\& #
\& # 128 128 1
\& key
\& 128 128 1
\& #value
\& #start_len end_len proportion
\& #
\& #value length range from start_len to end_len
\& #start_len must be equal to or greater than 1
\& #end_len must be equal to or less than 1M
\& #start_len must be equal to or greater than end_len
\& #memslap will generate values according to the value range
\& #proportion: indicates values generated from one range accounts for the
\& total generated values
\& #
\& #example1: value range 1~1000 accounts for 80%
\& # value range 1001~10000 accounts for 10%
\& # value range 10001~100000 accounts for 10%
\& # total should be 1 (0.8+0.1+0.1 = 1)
\& #
\& # 1 1000 0.8
\& # 1001 10000 0.1
\& # 10001 100000 0.1
\& #
\& #example2: all value length are 128 bytes
\& #
\& # 128 128 1
\& value
\& 2048 2048 1
\& #cmd
\& #cmd_type cmd_proportion
\& #
\& #currently memslap only supports get and set command.
\& #
\& #cmd_type
\& #set 0
\& #get 1
\& #
\& #example: set command accounts for 50%
\& # get command accounts for 50%
\& # total should be 1 (0.5+0.5 = 1)
\& #
\& # cmd
\& # 0 0.5
\& # 1 0.5
\& cmd
\& 0 0.1
\& 1.0 0.9
.Ve
.SH "Format of output"
.IX Header "Format of output"
At the beginning, memslap displays some configuration information as follows:
.IP "servers : 127.0.0.1:11211" 4
.IX Item "servers : 127.0.0.1:11211"
.PD 0
.IP "threads count: 1" 4
.IX Item "threads count: 1"
.IP "concurrency: 16" 4
.IX Item "concurrency: 16"
.IP "run time: 20s" 4
.IX Item "run time: 20s"
.IP "windows size: 10k" 4
.IX Item "windows size: 10k"
.IP "set proportion: set_prop=0.10" 4
.IX Item "set proportion: set_prop=0.10"
.IP "get proportion: get_prop=0.90" 4
.IX Item "get proportion: get_prop=0.90"
.PD
.SS "Where"
.IX Subsection "Where"
.ie n .IP "servers : ""servers""" 4
.el .IP "servers : ``servers''" 4
.IX Item "servers : servers"
The servers used by memslap.
.IP "threads count" 4
.IX Item "threads count"
The number of threads memslap runs with.
.IP "concurrency" 4
.IX Item "concurrency"
The number of concurrencies memslap runs with.
.IP "run time" 4
.IX Item "run time"
How long to run memslap.
.IP "windows size" 4
.IX Item "windows size"
The task window size of each concurrency.
.IP "set proportion" 4
.IX Item "set proportion"
The proportion of set command.
.IP "get proportion" 4
.IX Item "get proportion"
The proportion of get command.
.PP
The output of dynamic statistics is something like this:
.PP
.Vb 8
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& Get Statistics
\& Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
\& Avg(us) Std_dev Geo_dist
\& Period 5 345826 69165 65.3 0 27 2198 203
\& 95.43 177.29
\& Global 20 1257935 62896 71.8 0 26 3791 224
\& 117.79 192.60
\&
\&
\& Set Statistics
\& Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
\& Avg(us) Std_dev Geo_dist
\& Period 5 38425 7685 7.3 0 42 628 240
\& 88.05 220.21
\& Global 20 139780 6989 8.0 0 37 3790 253
\& 117.93 224.83
\&
\&
\& Total Statistics
\& Type Time(s) Ops TPS(ops/s) Net(M/s) Get_miss Min(us) Max(us)
\& Avg(us) Std_dev Geo_dist
\& Period 5 384252 76850 72.5 0 27 2198 207
\& 94.72 181.18
\& Global 20 1397720 69886 79.7 0 26 3791 227
\& 117.93 195.60
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.Ve
.SS "Where"
.IX Subsection "Where"
.IP "Get Statistics" 4
.IX Item "Get Statistics"
Statistics information of get command
.IP "Set Statistics" 4
.IX Item "Set Statistics"
Statistics information of set command
.IP "Total Statistics" 4
.IX Item "Total Statistics"
Statistics information of both get and set command
.IP "Period" 4
.IX Item "Period"
Result within a period
.IP "Global" 4
.IX Item "Global"
Accumulated results
.IP "Ops" 4
.IX Item "Ops"
Total operations
.IP "\s-1TPS\s0" 4
.IX Item "TPS"
Throughput, operations/second
.IP "Net" 4
.IX Item "Net"
The rate of network
.IP "Get_miss" 4
.IX Item "Get_miss"
How many objects cana\*^XXt be gotten
.IP "Min" 4
.IX Item "Min"
The minimum response time
.IP "Max" 4
.IX Item "Max"
The maximum response time
.IP "Avg:" 4
.IX Item "Avg:"
The average response time
.IP "Std_dev" 4
.IX Item "Std_dev"
Standard deviation of response time
.IP "Geo_dist" 4
.IX Item "Geo_dist"
Geometric distribution based on natural exponential function
.PP
At the end, memslap will output something like this:
.PP
.Vb 11
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\& Get Statistics (1257956 events)
\& Min: 26
\& Max: 3791
\& Avg: 224
\& Geo: 192.60
\& Std: 116.23
\& Log2 Dist:
\& 4: 0 10 84490 215345
\& 8: 484890 459823 12543 824
\& 12: 31
\&
\& Set Statistics (139782 events)
\& Min: 37
\& Max: 3790
\& Avg: 253
\& Geo: 224.84
\& Std: 116.83
\& Log2 Dist:
\& 4: 0 0 4200 16988
\& 8: 50784 65574 2064 167
\& 12: 5
\&
\& Total Statistics (1397738 events)
\& Min: 26
\& Max: 3791
\& Avg: 227
\& Geo: 195.60
\& Std: 116.60
\& Log2 Dist:
\& 4: 0 10 88690 232333
\& 8: 535674 525397 14607 991
\& 12: 36
\&
\& cmd_get: 1257969
\& cmd_set: 139785
\& get_misses: 0
\& verify_misses: 0
\& verify_failed: 0
\& expired_get: 0
\& unexpired_unget: 0
\& written_bytes: 242516030
\& read_bytes: 1003702556
\& object_bytes: 152086080
\& packet_disorder: 0
\& packet_drop: 0
\& udp_timeout: 0
\&
\& Run time: 20.0s Ops: 1397754 TPS: 69817 Net_rate: 59.4M/s
\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.Ve
.SS "Where"
.IX Subsection "Where"
.IP "Get Statistics" 4
.IX Item "Get Statistics"
Get statistics of response time
.IP "Set Statistics" 4
.IX Item "Set Statistics"
Set statistics of response time
.IP "Total Statistics" 4
.IX Item "Total Statistics"
Both get and set statistics of response time
.IP "Min" 4
.IX Item "Min"
The accumulated and minimum response time
.IP "Max" 4
.IX Item "Max"
The accumulated and maximum response time
.IP "Avg" 4
.IX Item "Avg"
The accumulated and average response time
.IP "Std" 4
.IX Item "Std"
Standard deviation of response time
.IP "Log2 Dist" 4
.IX Item "Log2 Dist"
Geometric distribution based on logarithm 2
.IP "cmd_get" 4
.IX Item "cmd_get"
Total get commands done
.IP "cmd_set" 4
.IX Item "cmd_set"
Total set commands done
.IP "get_misses" 4
.IX Item "get_misses"
How many objects cana\*^XXt be gotten from server
.IP "verify_misses" 4
.IX Item "verify_misses"
How many objects need to verify but cana\*^XXt get them
.IP "verify_failed" 4
.IX Item "verify_failed"
How many objects with insistent value
.IP "expired_get" 4
.IX Item "expired_get"
How many objects are expired but we get them
.IP "unexpired_unget" 4
.IX Item "unexpired_unget"
How many objects are unexpired but we cana\*^XXt get them
.IP "written_bytes" 4
.IX Item "written_bytes"
Total written bytes
.IP "read_bytes" 4
.IX Item "read_bytes"
Total read bytes
.IP "object_bytes" 4
.IX Item "object_bytes"
Total object bytes
.IP "packet_disorder" 4
.IX Item "packet_disorder"
How many \s-1UDP\s0 packages are disorder
.IP "packet_drop" 4
.IX Item "packet_drop"
How many \s-1UDP\s0 packages are lost
.IP "udp_timeout" 4
.IX Item "udp_timeout"
How many times \s-1UDP\s0 time out happen
.IP "Run time" 4
.IX Item "Run time"
Total run time
.IP "Ops" 4
.IX Item "Ops"
Total operations
.IP "\s-1TPS\s0" 4
.IX Item "TPS"
Throughput, operations/second
.IP "Net_rate" 4
.IX Item "Net_rate"
The average rate of network
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\-s, \-\-servers=
List one or more servers to connect. Servers count must be less than
threads count. e.g.: \-\-servers=localhost:1234,localhost:11211
.PP
\&\-T, \-\-threads=
Number of threads to startup, better equal to \s-1CPU\s0 numbers. Default 8.
.PP
\&\-c, \-\-concurrency=
Number of concurrency to simulate with load. Default 128.
.PP
\&\-n, \-\-conn_sock=
Number of \s-1TCP\s0 socks per concurrency. Default 1.
.PP
\&\-x, \-\-execute_number=
Number of operations(get and set) to execute for the
given test. Default 1000000.
.PP
\&\-t, \-\-time=
How long the test to run, suffix: s\-seconds, m\-minutes, h\-hours,
d\-days e.g.: \-\-time=2h.
.PP
\&\-F, \-\-cfg_cmd=
Load the configure file to get command,key and value distribution list.
.PP
\&\-w, \-\-win_size=
Task window size of each concurrency, suffix: K, M e.g.: \-\-win_size=10k.
Default 10k.
.PP
\&\-X, \-\-fixed_size=
Fixed length of value.
.PP
\&\-v, \-\-verify=
The proportion of date verification, e.g.: \-\-verify=0.01
.PP
\&\-d, \-\-division=
Number of keys to multi-get once. Default 1, means single get.
.PP
\&\-S, \-\-stat_freq=
Frequency of dumping statistic information. suffix: s\-seconds,
m\-minutes, e.g.: \-\-resp_freq=10s.
.PP
\&\-e, \-\-exp_verify=
The proportion of objects with expire time, e.g.: \-\-exp_verify=0.01.
Default no object with expire time
.PP
\&\-o, \-\-overwrite=
The proportion of objects need overwrite, e.g.: \-\-overwrite=0.01.
Default never overwrite object.
.PP
\&\-R, \-\-reconnect
Reconnect support, when connection is closed it will be reconnected.
.PP
\&\-U, \-\-udp
\s-1UDP\s0 support, default memslap uses \s-1TCP\s0, \s-1TCP\s0 port and \s-1UDP\s0 port of
server must be same.
.PP
\&\-a, \-\-facebook
Whether it enables facebook test feature, set with \s-1TCP\s0 and multi-get with \s-1UDP\s0.
.PP
\&\-B, \-\-binary
Whether it enables binary protocol. Default with \s-1ASCII\s0 protocol.
.PP
\&\-P, \-\-tps=
Expected throughput, suffix: K, e.g.: \-\-tps=10k.
.PP
\&\-p, \-\-rep_write=
The first nth servers can write data, e.g.: \-\-rep_write=2.
.PP
\&\-b, \-\-verbose
Whether it outputs detailed information when verification fails.
.PP
\&\-h, \-\-help
Display this message and then exit.
.PP
\&\-V, \-\-version
Display the version of the application and then exit.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
memslap \-s 127.0.0.1:11211 \-S 5s
.PP
memslap \-s 127.0.0.1:11211 \-t 2m \-v 0.2 \-e 0.05 \-b
.PP
memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-w 40k \-S 20s \-o 0.2
.PP
memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-T 4 \-c 128 \-d 20 \-P 40k
.PP
memslap \-s 127.0.0.1:11211 \-F config \-t 2m \-d 50 \-a \-n 40
.PP
memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m
.PP
memslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2
.SH "HOME"
.IX Header "HOME"
To find out more information please check:
.SH "AUTHORS"
.IX Header "AUTHORS"
Mingqiang Zhuang (Schooner Technolgy)
Brian Aker,
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fImemcached\fR\|(1) \fIlibmemcached\fR\|(3)