FreeBSD Manual Pages

CBC-PILLOWFIGHT(1) CBC-PILLOWFIGHT(1)

NAME
cbc-pillowfight - Stress Test for Couchbase Client and Cluster

SYNOPSIS
cbc-pillowfight [OPTIONS]

DESCRIPTION
cbc-pillowfight creates a specified number of threads each looping and
performing get and set operations within the cluster.

The stress test operates in the following order

1. It will pre-load the items in the cluster (set by the --num-items
option)

2. Once the items are all loaded into the cluster, it will access all
the items (within the --num-items) specification, using a combina-
tion of storage and retrieval operations (the proportion of re-
trieval and storage operations are controlled via the --set-pct op-
tion).

3. Operations are scheduled in batches. The batches represent a single
pipeline (or network buffer) which is filled with a certain amount
of operations (see the --batch-size option). These batch sizes are
then sent over to the cluster and the requests are serviced by it.

Tuning
Getting the right benchmark numbers highly depends on the type of envi-
ronment the client is being run in. The following provides some infor-
mation about specific settings which may make pillowfight generate more
operations.

o Increasing the batch size will typically speed up operations, but
increasing the batch size too much will actually slow it down. Ad-
ditionally, very high batch sizes will cause high memory usage.

o Adding additional threads will create additional client objects and
connections, potentially increasing performance. Adding too many
threads will cause local and network resource congestion.

o Decreasing the item sizes (the --min-size and --max-size options)
will always yield higher performance in terms of opera-
tiond-per-second.

o Limiting the working set (i.e. --num-items) will decrease the work-
ing set within the cluster, thereby increasing the chance that a
given item will be inside the server's CPU cache (which is ex-
tremely fast), rather than in main memory (slower), or disk (much
slower)

The benchmark tool sets up SIGQUIT (CTRL-/) handler and dumps useful
diagnostics and metrics to STDERR on this signal.

OPTIONS
Options may be read either from the command line, or from a configura-
tion file (see cbcrc(4)):

The following options control workload generation:

-B, --batch-size=BATCHSIZE
This controls how many commands are scheduled per cycles. To
simulate one operation at a time, set this value to 1.

-I, --num-items=NUMITEMS
Set the total number of items the workload will access within
the cluster. This will also determine the working set size at
the server and may affect disk latencies if set to a high num-
ber.

-p, --key-prefix=PREFIX
Set the prefix to prepend to all keys in the cluster. Useful if
you do not wish the items to conflict with existing data.

-t, --num-threads=NTHREADS
Set the number of threads (and thus the number of client in-
stances) to run concurrently. Each thread is assigned its own
client object.

-r, --set-pct=PERCENTAGE
The percentage of operations which should be mutations. A value
of 100 means only mutations while a value of 0 means only re-
trievals.

-n, --no-population
By default cbc-pillowfight will load all the items (see
--num-items) into the cluster and then begin performing the nor-
mal workload. Specifying this option bypasses this stage. Useful
if the items have already been loaded in a previous run.

--populate-only
Stop after population. Useful to populate buckets with large
amounts of data.

-m, --min-size=MINSIZE:

-M, --max-size=MAXSIZE
Specify the minimum and maximum value sizes to be stored into
the cluster. This is typically a range, in which case each value
generated will be between --min-size and --max-size bytes.

-E, --pause-at-end
When the workload completes, do not exit immediately, but wait
for user input. This is helpful for analyzing open socket con-
nections and state.

-c, --num-cycles
Specify the number of times the workload should cycle. During
each cycle an amount of --batch-size operations are executed.
Setting this to -1 will cause the workload to run infinitely.

--sequential
Specify that the access pattern should be done in a sequential
manner. This is useful for bulk-loading many documents in a sin-
gle server.

--start-at
This specifies the starting offset for the items. The items by
default are generated with the key prefix (--key-prefix) up to
the number of items (--num-items). The --start-at value will in-
crease the lower limit of the items. This is useful to resume a
previously cancelled load operation.

-T, --timings
Enabled timing recorded. Timing histogram will be dumped to
STDERR on SIGQUIT (CTRL-/). When specified second time, it will
dump a histogram of command timings and latencies to the screen
every second.

-e, --expiry=SECONDS
Set the expiration time on the document for SECONDS when per-
forming each operation. Note that setting this too low may cause
not-found errors to appear on the screen.

-U, --spec=SPEC
A string describing the cluster to connect to. The string is in
a URI-like syntax, and may also contain other options. See the
EXAMPLES section for information. Typically such a URI will look
like couchbase://host1,host2,host3/bucket.

The default for this option is couchbase://localhost/default

-u, --username=USERNAME
Specify the username for the bucket. Since Couchbase 5.x this is
mandatory switch, and it must specify the name of the user ex-
isiting on cluster (read more at "Security/Authorization" sec-
tion of the server manual). For older servers this field should
be either left empty or set to the name of the bucket itself.

-P, --password=PASSWORD:

-P -, --password=-
Specify the password for the bucket. As for servers before 5.x
this was only needed if the bucket is protected with a password.
For cluster version after 5.x, the password is mandatory, and
should match the selected account (read more at "Security/Autho-
rization" section of the server manual).

Specifying the - as the password indicates that the program
should prompt for the password. You may also specify the pass-
word on the commandline, directly, but is insecure as command
line arguments are visible via commands such as ps.

-T, --timings
Dump command timings at the end of execution. This will display
a histogram showing the latencies for the commands executed.

-v, --verbose
Specify more information to standard error about what the client
is doing. You may specify this option multiple times for in-
creased output detail.

-D, --cparam=OPTION=VALUE
Provide additional client options. Acceptable options can also
be placed in the connection string, however this option is pro-
vided as a convenience. This option may be specified multiple
times, each time specifying a key=value pair (for example, -Dop-
eration_timeout=10 -Dconfig_cache=/foo/bar/baz). See ADDITIONAL
OPTIONS for more information

-y, --compress
Enable compressing of documents. When the library is compiled
with compression support, this option will enable Snappy com-
pression for outgoing data. Incoming compressed data handled au-
tomatically regardless of this option. Note, that because the
compression support have to be negotiated with the server, first
packets might be sent uncompressed even when this switch was
specified. This is because the library might queue data commands
before socket connection has been established, and the library
will negotiate compression feature. If it is known that all
server support compression repeating the switch (like -yy) will
force compression for all outgoing mutations, even scheduled be-
fore establishing connection.

--truststorepath=PATH
The path to the server's SSL certificate. This is typically re-
quired for SSL connectivity unless the certificate has already
been added to the OpenSSL installation on the system (only ap-
plicable with couchbases:// scheme)

--certpath=PATH
The path to the server's SSL certificate. This is typically re-
quired for SSL connectivity unless the certificate has already
been added to the OpenSSL installation on the system (only ap-
plicable with couchbases:// scheme). This also should contain
client certificate when certificate authentication used, and in
this case other public certificates could be extracted into
truststorepath chain.

--keypath=PATH
The path to the client SSL private key. This is typically re-
quired for SSL client certificate authentication. The certifi-
cate itself have to go first in chain specified by certpath
(only applicable with couchbases:// scheme)

--dump Dump verbose internal state after operations are done.

p, --persist-to=NUMNODES
Wait until the item has been persisted to at least NUMNODES
nodes' disk. If NUMNODES is 1 then wait until only the master
node has persisted the item for this key. You may not specify a
number greater than the number of nodes actually in the cluster.
-1 is special value, which mean to use all available nodes.

r --replicate-to=NREPLICAS
Wait until the item has been replicated to at least NREPLICAS
replica nodes. The bucket must be configured with at least one
replica, and at least NREPLICAS replica nodes must be online. -1
is special value, which mean to use all available replicas.

--lock=TIME
This will retrieve and lock an item before update, making it in-
accessible for modification until the update completed, or TIME
has passed.

--json Make pillowfight store document as JSON rather than binary. This
will allow the documents to nominally be analyzed by other
Couchbase services such as Query and MapReduce.

JSON documents are created by creating an empty JSON object ({})
and then repeated populating it with Field_%d property names
(where %d is 1 and higher), and setting its value to a repeating
asterisk * up to 16 times:

{
"Field_1": "****************",
"Field_2": "****************",
"Field_3": "****************",
"Field_4": "****************",
"Field_5": "********"
}

When using document size constraints, be aware that the minimum and
maximum sizes (--min-size and --max-size) are not strict limits, and
that the resultant sizes may be bigger or smaller by a few bytes in or-
der to satisfy the requirements of proper JSON syntax.

--noop
Use couchbase NOOP operations when running the workload. This mode ig-
nores population, and all other document operations. Useful as the most
lightweight workload.

--subdoc
Use couchbase sub-document operations when running the workload. In
this mode pillowfight will use Couchbase sub-document operations
http://blog.couchbase.com/2016/february/subdoc-explained to perform
gets and sets of data. This option must be used with --json

--pathcount
Specify the number of paths a single sub-document operation should con-
tain. By default, each subdoc operation operates on only a single path
within the document. You can specify multiple paths to atomically exe-
cuted multiple subdoc operations within a single command.

This option does not affect the --batch-size option as a subdoc command
is considered as a single command (with respect to batching) regardless
of how many operations it contains.

ADDITIONAL OPTIONS
The following options may be included in the connection string (via the
-U option) as URI-style query params (e.g. couchbase://host/bucket?op-
tion1=value1&option2=value2) or as individual key=value pairs passed to
the -D switch (e.g. -Doption1=value1 -Doption2=value). The -D will in-
ternally build the connection string, and is provided as a convenience
for options to be easily passed on the command-line

o operation_timeout=SECONDS: Specify the operation timeout in sec-
onds. This is the time the client will wait for an operation to
complete before timing it out. The default is 2.5

o config_cache=PATH: Enables the client to make use of a file based
configuration cache rather than connecting for the bootstrap opera-
tion. If the file does not exist, the client will first connect to
the cluster and then cache the bootstrap information in the file.

o truststorepath=PATH: The path to the server's SSL certificate. This
is typically required for SSL connectivity unless the certificate
has already been added to the OpenSSL installation on the system
(only applicable with couchbases:// scheme)

o certpath=PATH: The path to the server's SSL certificate. This is
typically required for SSL connectivity unless the certificate has
already been added to the OpenSSL installation on the system (only
applicable with couchbases:// scheme). This also should contain
client certificate when certificate authentication used, and in
this case other public certificates could be extracted into trust-
storepath chain.

o keypath=PATH: The path to the client SSL private key. This is typi-
cally required for SSL client certificate authentication. The cer-
tificate itself have to go first in chain specified by certpath
(only applicable with couchbases:// scheme)

o ssl=no_verify: Temporarily disable certificate verification for SSL
(only applicable with couchbases:// scheme). This should only be
used for quickly debugging SSL functionality.

o sasl_mech_force=MECHANISM: Force a specific SASL mechanism to be
used when performing the initial connection. This should only need
to be modified for debugging purposes. The currently supported
mechanisms are PLAIN and CRAM-MD5

o bootstrap_on=<both,http,cccp>: Specify the bootstrap protocol the
client should use when attempting to connect to the cluster. Op-
tions are: cccp: Bootstrap using the Memcached protocol (supported
on clusters 2.5 and greater); http: Bootstrap using the HTTP REST
protocol (supported on any cluster version); and both: First at-
tempt bootstrap over the Memcached protocol, and use the HTTP pro-
tocol if Memcached bootstrap fails. The default is both

o enable_tracing=true/false: Activate/deactivate end-to-end tracing.

o tracing_orphaned_queue_flush_interval=SECONDS: Flush interval for
orphaned spans queue in default tracer. This is the time the tracer
will wait between repeated attempts to flush most recent orphaned
spans. Default value is 10 seconds.

o tracing_orphaned_queue_size=NUMBER: Size of orphaned spans queue in
default tracer. Queues in default tracer has fixed size, and it
will remove information about older spans, when the limit will be
reached before flushing time. Default value is 128.

o tracing_threshold_queue_flush_interval=SECONDS: Flush interval for
spans with total time over threshold in default tracer. This is the
time the tracer will wait between repeated attempts to flush
threshold queue. Default value is 10 seconds.

o tracing_threshold_queue_size=NUMBER: Size of threshold queue in de-
fault tracer. Queues in default tracer has fixed size, and it will
remove information about older spans, when the limit will be
reached before flushing time. Default value is 128.

o tracing_threshold_kv=SECONDS: Minimum time for the tracing span of
KV service to be considered by threshold tracer. Default value is
0.5 seconds.

o tracing_threshold_n1ql=SECONDS: Minimum time for the tracing span
of N1QL service to be considered by threshold tracer. Default value
is 1 second.

o tracing_threshold_view=SECONDS: Minimum time for the tracing span
of VIEW service to be considered by threshold tracer. Default value
is 1 second.

o tracing_threshold_fts=SECONDS: Minimum time for the tracing span of
FTS service to be considered by threshold tracer. Default value is
1 second.

o tracing_threshold_analytics=SECONDS: Minimum time for the tracing
span of ANALYTICS service to be considered by threshold tracer. De-
fault value is 1 second.

EXAMPLES
CONNECTION EXAMPLES
The following examples show how to connect pillowfight to different
types of cluster configurations.

Connect to a bucket (a_bucket) on a cluster on a remote host (for
servers version 5.x+). It uses account 'myname' and asks password in-
teractively:

cbc-pillowfight -U couchbase://192.168.33.101/a_bucket -u myname -P-

Run against a password-less bucket (a_bucket) on a cluster on a remote
host (for servers older than 5.x):

cbc-pillowfight -U couchbase://192.168.33.101/a_bucket

Connect to an SSL cluster at secure.net. The certificate for the clus-
ter is stored locally at /home/couchbase/couchbase_cert.pem:

cbc-pillowfight -U couchbases://secure.net/topsecret_bucket?certpath=/home/couchbase/couchbase_cert.pem

Connect to an SSL cluster at secure.net, ignoring certificate verifica-
tion. This is insecure but handy for testing:

cbc-pillowfight -U couchbases://secure.net/topsecret_bucket?ssl=no_verify

Connect to a password protected bucket (protected) on a remote host
(for servers older than 5.x):

cbc-pillowfight -U couchbase://remote.host.net/protected -P -
Bucket password:
...

Connect to a password protected bucket (for servers older than 5.x),
specifying the password on the command line (INSECURE, but useful for
testing dummy environments)

cbc-pillowfight -U couchbase://remote.host.net/protected -P t0ps3cr3t

Connect to a bucket running on a cluster with a custom REST API port

cbc-pillowfight -U http://localhost:9000/default

Connec to bucket running on a cluster with a custom memcached port

cbc-pillowfight -U couchbase://localhost:12000/default

Connect to a memcached (http://memcached.org) cluster using the binary
protocol. A vanilla memcached cluster is not the same as a memcached
bucket residing within a couchbase cluster (use the normal couchbase://
scheme for that):

cbc-pillowfight -U memcached://host1,host2,host3,host4

Connect to an SSL cluster at secure.net:

cbc-pillowfight -U couchbases://secure.net/topsecret_bucket

Run against a bucket (a_bucket) on a cluster on a remote host:

cbc-pillowfight -U couchbase://192.168.33.101/a_bucket

BENCHMARK EXAMPLES
The following examples show how to configure different types of work-
loads with pillowfight.

Run with 20 threads/instances, each doing one operation at a time:

cbc-pillowfight -t 20 -B 1

Run 100 iterations of 2MB item sizes, using a dataset of 50 items

cbc-pillowfight -M $(1024*1024) -m $(1024*1024) -c 100 -I 50

Use JSON documents of 100k each

cbc-pillowfight --json -m 100000 -M 100000

Stress-test sub-document mutations

cbc-pillowfight --json --subdoc --set-pct 100

TODO
Rather than spawning threads for multiple instances, offer a way to
have multiple instances function cooperatively inside an event loop.

BUGS
This command's options are subject to change.

Header And Logo

Peripheral Links

Site Navigation

FreeBSD Manual Pages

Header And Logo

Peripheral Links

Search

Site Navigation

FreeBSD Manual Pages