forked from RedisLabs/memtier_benchmark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
memtier_benchmark.1
232 lines (232 loc) · 7.04 KB
/
memtier_benchmark.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.1.
.TH MEMTIER_BENCHMARK "1" "June 2023" "memtier_benchmark 2.0.0" "User Commands"
.SH NAME
memtier_benchmark \- NoSQL benchmark tool
.SH SYNOPSIS
.B memtier_benchmark
[\fI\,options\/\fR]
.SH DESCRIPTION
A memcache/redis NoSQL traffic generator and performance benchmarking tool.
.SS "Connection and General Options:"
.TP
\fB\-h\fR, \fB\-\-host\fR=\fI\,ADDR\/\fR
Server address (default: localhost)
.TP
\fB\-s\fR, \fB\-\-server\fR=\fI\,ADDR\/\fR
Same as \fB\-\-host\fR
.TP
\fB\-p\fR, \fB\-\-port\fR=\fI\,PORT\/\fR
Server port (default: 6379)
.TP
\fB\-S\fR, \fB\-\-unix\-socket\fR=\fI\,SOCKET\/\fR
UNIX Domain socket name (default: none)
.TP
\fB\-4\fR, \fB\-\-ipv4\fR
Force IPv4 address resolution.
.TP
\fB\-6\fR \fB\-\-ipv6\fR
Force IPv6 address resolution.
.TP
\fB\-P\fR, \fB\-\-protocol\fR=\fI\,PROTOCOL\/\fR
Protocol to use (default: redis).
other supported protocols are resp2, resp3, memcache_text and memcache_binary.
when using one of resp2 or resp3 the redis protocol version will be set via HELLO command.
.TP
\fB\-a\fR, \fB\-\-authenticate\fR=\fI\,CREDENTIALS\/\fR Authenticate using specified credentials.
A simple password is used for memcache_text
and Redis <= 5.x. <USER>:<PASSWORD> can be
specified for memcache_binary or Redis 6.x
or newer with ACL user support.
.TP
\fB\-\-tls\fR
Enable SSL/TLS transport security
.TP
\fB\-\-cert\fR=\fI\,FILE\/\fR
Use specified client certificate for TLS
.TP
\fB\-\-key\fR=\fI\,FILE\/\fR
Use specified private key for TLS
.TP
\fB\-\-cacert\fR=\fI\,FILE\/\fR
Use specified CA certs bundle for TLS
.TP
\fB\-\-tls\-skip\-verify\fR
Skip verification of server certificate
.TP
\fB\-\-sni\fR=\fI\,STRING\/\fR
Add an SNI header
.TP
\fB\-x\fR, \fB\-\-run\-count\fR=\fI\,NUMBER\/\fR
Number of full\-test iterations to perform
.TP
\fB\-D\fR, \fB\-\-debug\fR
Print debug output
.TP
\fB\-\-client\-stats\fR=\fI\,FILE\/\fR
Produce per\-client stats file
.TP
\fB\-o\fR, \fB\-\-out\-file\fR=\fI\,FILE\/\fR
Name of output file (default: stdout)
.TP
\fB\-\-json\-out\-file\fR=\fI\,FILE\/\fR
Name of JSON output file, if not set, will not print to json
.TP
\fB\-\-hdr\-file\-prefix\fR=\fI\,FILE\/\fR
Prefix of HDR Latency Histogram output files, if not set, will not save latency histogram files
.TP
\fB\-\-show\-config\fR
Print detailed configuration before running
.TP
\fB\-\-hide\-histogram\fR
Don't print detailed latency histogram
.TP
\fB\-\-print\-percentiles\fR
Specify which percentiles info to print on the results table (by default prints percentiles: 50,99,99.9)
.TP
\fB\-\-cluster\-mode\fR
Run client in cluster mode
.TP
\fB\-h\fR, \fB\-\-help\fR
Display this help
.TP
\fB\-v\fR, \fB\-\-version\fR
Display version information
.SS "Test Options:"
.TP
\fB\-n\fR, \fB\-\-requests\fR=\fI\,NUMBER\/\fR
Number of total requests per client (default: 10000)
use 'allkeys' to run on the entire key\-range
.TP
\fB\-c\fR, \fB\-\-clients\fR=\fI\,NUMBER\/\fR
Number of clients per thread (default: 50)
.TP
\fB\-t\fR, \fB\-\-threads\fR=\fI\,NUMBER\/\fR
Number of threads (default: 4)
.TP
\fB\-\-test\-time\fR=\fI\,SECS\/\fR
Number of seconds to run the test
.TP
\fB\-\-ratio\fR=\fI\,RATIO\/\fR
Set:Get ratio (default: 1:10)
.TP
\fB\-\-pipeline\fR=\fI\,NUMBER\/\fR
Number of concurrent pipelined requests (default: 1)
.TP
\fB\-\-reconnect\-interval\fR=\fI\,NUM\/\fR
Number of requests after which re\-connection is performed
.TP
\fB\-\-multi\-key\-get\fR=\fI\,NUM\/\fR
Enable multi\-key get commands, up to NUM keys (default: 0)
.TP
\fB\-\-select\-db\fR=\fI\,DB\/\fR
DB number to select, when testing a redis server
.TP
\fB\-\-distinct\-client\-seed\fR
Use a different random seed for each client
.TP
\fB\-\-randomize\fR
random seed based on timestamp (default is constant value)
.SS "Arbitrary command:"
.TP
\fB\-\-command\fR=\fI\,COMMAND\/\fR
Specify a command to send in quotes.
Each command that you specify is run with its ratio and key\-pattern options.
For example: \fB\-\-command=\fR"set __key__ 5" \fB\-\-command\-ratio\fR=\fI\,2\/\fR \fB\-\-command\-key\-pattern\fR=\fI\,G\/\fR
To use a generated key or object, enter:
.TP
__key__: Use key generated from Key Options.
__data__: Use data generated from Object Options.
.TP
\fB\-\-command\-ratio\fR
The number of times the command is sent in sequence.(default: 1)
.TP
\fB\-\-command\-key\-pattern\fR
Key pattern for the command (default: R):
G for Gaussian distribution.
R for uniform Random.
S for Sequential.
P for Parallel (Sequential were each client has a subset of the key\-range).
.SS "Object Options:"
.TP
\fB\-d\fR \fB\-\-data\-size\fR=\fI\,SIZE\/\fR
Object data size in bytes (default: 32)
.TP
\fB\-\-data\-offset\fR=\fI\,OFFSET\/\fR
Actual size of value will be data\-size + data\-offset
Will use SETRANGE / GETRANGE (default: 0)
.TP
\fB\-R\fR \fB\-\-random\-data\fR
Indicate that data should be randomized
.TP
\fB\-\-data\-size\-range\fR=\fI\,RANGE\/\fR
Use random\-sized items in the specified range (min\-max)
.TP
\fB\-\-data\-size\-list\fR=\fI\,LIST\/\fR
Use sizes from weight list (size1:weight1,..sizeN:weightN)
.TP
\fB\-\-data\-size\-pattern\fR=\fI\,R\/\fR|S
Use together with data\-size\-range
when set to R, a random size from the defined data sizes will be used,
when set to S, the defined data sizes will be evenly distributed across
the key range, see \fB\-\-key\-maximum\fR (default R)
.TP
\fB\-\-expiry\-range\fR=\fI\,RANGE\/\fR
Use random expiry values from the specified range
.SS "Imported Data Options:"
.TP
\fB\-\-data\-import\fR=\fI\,FILE\/\fR
Read object data from file
.TP
\fB\-\-data\-verify\fR
Enable data verification when test is complete
.TP
\fB\-\-verify\-only\fR
Only perform \fB\-\-data\-verify\fR, without any other test
.TP
\fB\-\-generate\-keys\fR
Generate keys for imported objects
.TP
\fB\-\-no\-expiry\fR
Ignore expiry information in imported data
.SS "Key Options:"
.TP
\fB\-\-key\-prefix\fR=\fI\,PREFIX\/\fR
Prefix for keys (default: "memtier\-")
.TP
\fB\-\-key\-minimum\fR=\fI\,NUMBER\/\fR
Key ID minimum value (default: 0)
.TP
\fB\-\-key\-maximum\fR=\fI\,NUMBER\/\fR
Key ID maximum value (default: 10000000)
.TP
\fB\-\-key\-pattern\fR=\fI\,PATTERN\/\fR
Set:Get pattern (default: R:R)
G for Gaussian distribution.
R for uniform Random.
S for Sequential.
P for Parallel (Sequential were each client has a subset of the key\-range).
.TP
\fB\-\-key\-stddev\fR
The standard deviation used in the Gaussian distribution
(default is key range / 6)
.TP
\fB\-\-key\-median\fR
The median point used in the Gaussian distribution
(default is the center of the key range)
.SS "WAIT Options:"
.TP
\fB\-\-wait\-ratio\fR=\fI\,RATIO\/\fR
Set:Wait ratio (default is no WAIT commands \- 1:0)
.TP
\fB\-\-num\-slaves\fR=\fI\,RANGE\/\fR
WAIT for a random number of slaves in the specified range
.TP
\fB\-\-wait\-timeout\fR=\fI\,RANGE\/\fR
WAIT for a random number of milliseconds in the specified range (normal
distribution with the center in the middle of the range)
.SH COPYRIGHT
Copyright \(co 2011\-2022 Redis Ltd.
.br
This is free software. You may redistribute copies of it under the terms of
the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.