memtier_benchmark.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
.TH MEMTIER_BENCHMARK "1" "August 2013" "memtier_benchmark 1.0.2" "User Commands"
.SH NAME
memtier_benchmark \- NoSQL benchmark tool
.SH SYNOPSIS
.B memtier_benchmark
[\fIoptions\fR]
.SH DESCRIPTION
A memcache/redis NoSQL traffic generator and performance benchmarking tool.
.SS "Connection and General Options:"
.TP
\fB\-s\fR, \fB\-\-server\fR=\fIADDR\fR
Server address (default: localhost)
.TP
\fB\-p\fR, \fB\-\-port\fR=\fIPORT\fR
Server port (default: 6379)
.TP
\fB\-S\fR, \fB\-\-unix\-socket\fR=\fISOCKET\fR
UNIX Domain socket name (default: none)
.TP
\fB\-P\fR, \fB\-\-protocol\fR=\fIPROTOCOL\fR
Protocol to use (default: redis).  Other
supported protocols are memcache_text,
memcache_binary.
.TP
\fB\-x\fR, \fB\-\-run\-count\fR=\fINUMBER\fR
Number of full\-test iterations to perform
.TP
\fB\-D\fR, \fB\-\-debug\fR
Print debug output
.TP
\fB\-\-client\-stats\fR=\fIFILE\fR
Produce per\-client stats file
.TP
\fB\-\-out\-file\fR=\fIFILE\fR
Name of output file (default: stdout)
.TP
\fB\-\-show\-config\fR
Print detailed configuration before running
.SS "Test Options:"
.TP
\fB\-n\fR, \fB\-\-requests\fR=\fINUMBER\fR
Number of total requests per client (default: 10000)
.TP
\fB\-c\fR, \fB\-\-clients\fR=\fINUMBER\fR
Number of clients per thread (default: 50)
.TP
\fB\-t\fR, \fB\-\-threads\fR=\fINUMBER\fR
Number of threads (default: 4)
.TP
\fB\-\-test\-time\fR=\fISECS\fR
Number of seconds to run the test
.TP
\fB\-\-ratio\fR=\fIRATIO\fR
Set:Get ratio (default: 1:10)
.TP
\fB\-\-pipeline\fR=\fINUMBER\fR
Number of concurrent pipelined requests (default: 1)
.TP
\fB\-\-reconnect\-interval\fR=\fINUM\fR
Number of requests after which re\-connection is performed
.TP
\fB\-\-multi\-key\-get\fR=\fINUM\fR
Enable multi\-key get commands, up to NUM keys (default: 0)
.TP
\fB\-a\fR, \fB\-\-authenticate\fR=\fICREDENTIALS\fR Authenticate to redis using CREDENTIALS, which depending
on the protocol can be PASSWORD or USER:PASSWORD.
.TP
\fB\-\-select\-db\fR=\fIDB\fR
DB number to select, when testing a redis server
.SS "Object Options:"
.TP
\fB\-d\fR  \fB\-\-data\-size\fR=\fISIZE\fR
Object data size (default: 32)
.TP
\fB\-R\fR  \fB\-\-random\-data\fR
Indicate that data should be randomized
.TP
\fB\-\-data\-size\-range\fR=\fIRANGE\fR
Use random\-sized items in the specified range (min\-max)
.TP
\fB\-\-data\-size\-list\fR=\fILIST\fR
Use sizes from weight list (size1:weight1,..sizeN:weightN)
.TP
\fB\-\-expiry\-range\fR=\fIRANGE\fR
Use random expiry values from the specified range
.SS "Imported Data Options:"
.TP
\fB\-\-data\-import\fR=\fIFILE\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=\fIPREFIX\fR
Prefix for keys (default: "memtier\-")
.TP
\fB\-\-key\-minimum\fR=\fINUMBER\fR
Key ID minimum value (default: 0)
.TP
\fB\-\-key\-maximum\fR=\fINUMBER\fR
Key ID maximum value (default: 10000000)
.TP
\fB\-\-key\-pattern\fR=\fIPATTERN\fR
Set:Get pattern (default: R:R)
.TP
\fB\-\-help\fR
Display this help
.TP
\fB\-\-version\fR
Display version information
.SH COPYRIGHT
Copyright \(co 2011\-2013 Garantia Data 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.