Updating man page.
[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 simulates loads on memcached server clusters.
13
14 You can specify servers via the B<--servers> option or via the
15 environment variable C<MEMCACHED_SERVERS>.
16
17 -s, --servers=
18 List one or more servers to connect. Servers count must be less than
19 threads count. e.g.: --servers=localhost:1234,localhost:11211
20
21 -T, --threads=
22 Number of threads to startup, better equal to CPU numbers. Default 8.
23
24 -c, --concurrency=
25 Number of concurrency to simulate with load. Default 128.
26
27 -n, --conn_sock=
28 Number of TCP socks per concurrency. Default 1.
29
30 -x, --execute_number=
31 Number of operations(get and set) to execute for the
32 given test. Default 1000000.
33
34 -t, --time=
35 How long the test to run, suffix: s-seconds, m-minutes, h-hours,
36 d-days e.g.: --time=2h.
37
38 -F, --cfg_cmd=
39 Load the configure file to get command,key and value distribution list.
40
41 -w, --win_size=
42 Task window size of each concurrency, suffix: K, M e.g.: --win_size=10k.
43 Default 10k.
44
45 -X, --fixed_size=
46 Fixed length of value.
47
48 -v, --verify=
49 The proportion of date verification, e.g.: --verify=0.01
50
51 -d, --division=
52 Number of keys to multi-get once. Default 1, means single get.
53
54 -S, --stat_freq=
55 Frequency of dumping statistic information. suffix: s-seconds,
56 m-minutes, e.g.: --resp_freq=10s.
57
58 -e, --exp_verify=
59 The proportion of objects with expire time, e.g.: --exp_verify=0.01.
60 Default no object with expire time
61
62 -o, --overwrite=
63 The proportion of objects need overwrite, e.g.: --overwrite=0.01.
64 Default never overwrite object.
65
66 -R, --reconnect
67 Reconnect support, when connection is closed it will be reconnected.
68
69 -U, --udp
70 UDP support, default memslap uses TCP, TCP port and UDP port of
71 server must be same.
72
73 -a, --facebook
74 Whether it enables facebook test feature, set with TCP and multi-get with UDP.
75
76 -B, --binary
77 Whether it enables binary protocol. Default with ASCII protocol.
78
79 -P, --tps=
80 Expected throughput, suffix: K, e.g.: --tps=10k.
81
82 -p, --rep_write=
83 The first nth servers can write data, e.g.: --rep_write=2.
84
85 -b, --verbose
86 Whether it outputs detailed information when verification fails.
87
88 -h, --help
89 Display this message and then exit.
90
91 -V, --version
92 Display the version of the application and then exit.
93
94 =head1 EXAMPLES
95
96 memslap -s 127.0.0.1:11211 -S 5s
97
98 memslap -s 127.0.0.1:11211 -t 2m -v 0.2 -e 0.05 -b
99
100 memslap -s 127.0.0.1:11211 -F config -t 2m -w 40k -S 20s -o 0.2
101
102 memslap -s 127.0.0.1:11211 -F config -t 2m -T 4 -c 128 -d 20 -P 40k
103
104 memslap -s 127.0.0.1:11211 -F config -t 2m -d 50 -a -n 40
105
106 memslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m
107
108 memslap -s 127.0.0.1:11211,127.0.0.1:11212 -F config -t 2m -p 2
109
110 =head1 HOME
111
112 To find out more information please check:
113 L<http://tangent.org/552/libmemcached.html>
114
115 =head1 AUTHORS
116
117 Brian Aker, E<lt>brian@tangent.orgE<gt>
118 Mingqiang Zhuang E<lt>mingqiangzhuang@hengtiansoft.comE<gt>
119
120 =head1 SEE ALSO
121
122 memcached(1) libmemcached(3)
123
124 =cut
125