# cbc-pillowfight - Simple Workload Generator {#cbc-pillowfight} ### NAME `cbc pillowfight` - run workload generator ### SYNOPSIS `cbc pillowfight [options] ...`
`cbc pillowfight (-h|--help)` ### DESCRIPTION Run simple workload generator that sends GET/UPSERT requests with optional N1QL queries. ### OPTIONS
`-h|--help`
Show this screen.
`--verbose`
Include more context and information where it is applicable.
`--bucket-name=STRING`
Name of the bucket. [default: `default`]
`--scope-name=STRING`
Name of the scope. [default: `_default`]
`--collection-name=STRING`
Name of the collection. [default: `_default`]
`--batch-size=INTEGER`
Number of the operations in single batch. [default: `100`]
`--batch-wait=DURATION`
Time to wait after the batch. [default: `0ms`]
`--number-of-io-threads=INTEGER`
Number of the IO threads. [default: `1`]
`--number-of-worker-threads=INTEGER`
Number of the IO threads. [default: `1`]
`--chance-of-get=FLOAT`
The probability of get operation (where 1 means only get, and 0 - only upsert). [default: `0.6`]
`--hit-chance-for-get=FLOAT`
The probability of using existing ID for get operation. [default: `1`]
`--hit-chance-for-upsert=FLOAT`
The probability of using existing ID for upsert operation. [default: `0.5`]
`--chance-of-query=FLOAT`
The probability of N1QL query will be send on after get/upsert. [default: `0`]
`--query-statement=STRING`
The N1QL query statement to use ({bucket_name}, {scope_name} and {collection_name} will be substituted). [default: SELECT COUNT(*) FROM \`{bucket_name}\` WHERE type = "fake_profile"]
`--incompressible-body`
Use random characters to fill generated document value (by default uses 'x' to fill the body).
`--document-body-size=INTEGER`
Size of the body (if zero, it will use predefined document). [default: `0`]
`--number-of-keys-to-populate=INTEGER`
Preload keys before running workload, so that the worker will not generate new keys afterwards. [default: `1000`]
`--operations-limit=INTEGER`
Stop and exit after the number of the operations reaches this limit. (zero for running indefinitely) [default: `0`]
### LOGGER OPTIONS
`--log-level=LEVEL`
Log level (allowed values are: `trace`, `debug`, `info`, `warning`, `error`, `critical`, `off`). [default: `off`]
`--log-output=PATH`
File to send logs (when is not set, logs will be written to STDERR).
### CONNECTION OPTIONS
`--connection-string=STRING`
Connection string for the cluster. [default: `couchbase://localhost`]
`--username=STRING`
Username for the cluster. [default: `Administrator`]
`--password=STRING`
Password for the cluster. [default: `password`]
`--certificate-path=STRING`
Path to the certificate.
`--key-path=STRING`
Path to the key.
`--ldap-compatible`
Whether to select authentication mechanism that is compatible with LDAP.
`--configuration-profile=STRING`
Apply configuration profile. (available profiles: `wan_development`)
### SECURITY OPTIONS
`--disable-tls`
Whether to disable TLS.
`--trust-certificate-path=STRING`
Path to the trust certificate bundle.
`--tls-verify-mode=MODE`
Path to the certificate (allowed values: peer, none). [default: `peer`]
### TIMEOUT OPTIONS
`--bootstrap-timeout=DURATION`
Timeout for overall bootstrap of the SDK. [default: `10000ms`]
`--connect-timeout=DURATION`
Timeout for socket connection. [default: `10000ms`]
`--resolve-timeout=DURATION`
Timeout to resolve DNS address for the sockets. [default: `2000ms`]
`--key-value-timeout=DURATION`
Timeout for Key/Value operations. [default: `2500ms`]
`--key-value-durable-timeout=DURATION`
Timeout for Key/Value durable operations. [default: `10000ms`]
`--query-timeout=DURATION`
Timeout for Query service. [default: `75000ms`]
`--search-timeout=DURATION`
Timeout for Search service. [default: `75000ms`]
`--eventing-timeout=DURATION`
Timeout for Eventing service. [default: `75000ms`]
`--analytics-timeout=DURATION`
Timeout for Analytics service. [default: `75000ms`]
`--view-timeout=DURATION`
Timeout for View service. [default: `75000ms`]
`--management-timeout=DURATION`
Timeout for management operations. [default: `75000ms`]
### COMPRESSION OPTIONS
`--disable-compression`
Whether to disable compression.
`--compression-minimum-size=INTEGER`
The minimum size of the document (in bytes), that will be compressed. [default: `32`]
`--compression-minimum-ratio=FLOAT`
The minimum compression ratio to allow compressed form to be used. [default: `0.83`]
### DNS-SRV OPTIONS
`--dns-srv-timeout=DURATION`
Timeout for DNS SRV requests. [default: `500ms`]
`--dns-srv-nameserver=STRING`
Hostname of the DNS server where the DNS SRV requests will be sent.
`--dns-srv-port=INTEGER`
Port of the DNS server where the DNS SRV requests will be sent.
### NETWORK OPTIONS
`--tcp-keep-alive-interval=DURATION`
Interval for TCP keep alive. [default: `60000ms`]
`--config-poll-interval=DURATION`
How often the library should poll for new configuration. [default: `2500ms`]
`--idle-http-connection-timeout=DURATION`
Period to wait before calling HTTP connection idle. [default: `4500ms`]
### TRANSACTIONS OPTIONS
`--transactions-durability-level=LEVEL`
Durability level of the transaction (allowed values: `none`, `majority`, `majority_and_persist_to_active`, `persist_to_majority`). [default: `majority`]
`--transactions-expiration-time=DURATION`
Expiration time of the transaction. [default: `15000ms`]
`--transactions-key-value-timeout=DURATION`
Override Key/Value timeout just for the transaction.
`--transactions-metadata-bucket=STRING`
Bucket name where transaction metadata is stored.
`--transactions-metadata-scope=STRING`
Scope name where transaction metadata is stored. [default: `_default`]
`--transactions-metadata-collection=STRING`
Collection name where transaction metadata is stored. [default: `_default`]
`--transactions-query-scan-consistency=MODE`
Scan consistency for queries in transactions (allowed values: `not_bounded`, `request_plus`). [default: `request_plus`]
`--transactions-cleanup-ignore-lost-attempts`
Do not cleanup lost attempts.
`--transactions-cleanup-ignore-client-attempts`
Do not cleanup client attempts.
`--transactions-cleanup-window=DURATION`
Cleanup window. [default: `60000ms`]
### METRICS OPTIONS
`--disable-metrics`
Disable collecting and reporting metrics.
`--metrics-emit-interval=DURATION`
Interval to emit metrics report on INFO log level. [default: `600000ms`]
### TRACING OPTIONS
`--disable-tracing`
Disable collecting and reporting trace information.
`--tracing-orphaned-emit-interval=DURATION`
Interval to emit report about orphan operations. [default: `10000ms`]
`--tracing-orphaned-sample-size=INTEGER`
Size of the sample of the orphan report. [default: `64`]
`--tracing-threshold-emit-interval=DURATION`
Interval to emit report about operations exceeding threshold. [default: `10000ms`]
`--tracing-threshold-sample-size=INTEGER`
Size of the sample of the threshold report. [default: `64`]
`--tracing-threshold-key-value=DURATION`
Threshold for Key/Value service. [default: `500ms`]
`--tracing-threshold-query=DURATION`
Threshold for Query service. [default: `1000ms`]
`--tracing-threshold-search=DURATION`
Threshold for Search service. [default: `1000ms`]
`--tracing-threshold-analytics=DURATION`
Threshold for Analytics service. [default: `1000ms`]
`--tracing-threshold-management=DURATION`
Threshold for Management operations. [default: `1000ms`]
`--tracing-threshold-eventing=DURATION`
Threshold for Eventing service. [default: `1000ms`]
`--tracing-threshold-view=DURATION`
Threshold for View service. [default: `1000ms`]
### BEHAVIOR OPTIONS
`--user-agent-extra=STRING`
Append extra string SDK identifiers. [default: `cbc`].
`--show-queries`
Log queries on INFO level.
`--enable-clustermap-notifications`
Allow server to send notifications when cluster configuration changes.
`--disable-mutation-tokens`
Do not request Key/Value service to send mutation tokens.
`--disable-unordered-execution`
Disable unordered execution for Key/Value service.
### ENVIRONMENT
CBC_LOG_LEVEL
Overrides default value for `--log-level`.
CBC_CONNECTION_STRING
Overrides default value for `--connection-string`.
CBC_USERNAME
Overrides default value for `--username`.
CBC_PASSWORD
Overrides default value for `--password`.
### SEE ALSO [cbc](md_docs_2cbc).