arangobench Startup Options

The startup options of the arangobench executable

Usage: arangobench [<options>]

Examples

Run the version test case with 1000 requests, without threads:

arangobench --test-case version --requests 1000 --threads 1

Run the document test case with 2000 requests, with two concurrent threads:

arangobench --test-case document --requests 1000 --threads 2

Run the document test case with 2000 requests, with threads 2, with async requests:

arangobench --test-case document --requests 1000 --threads 2 --async true

Run the document test case with 2000 requests, with threads 2, using batch requests:

arangobench --test-case document --requests 1000 --threads 2 --batch-size 10

General

`--async`

Type: boolean

Send asynchronous requests.

This option can be specified without a value to enable it.

`--batch-size`

Type: uint64

The number of operations in one batch (0 = disable batching)

`--check-configuration`

Type: boolean

Check the configuration and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

`--collection`

Type: string

The collection name to use in tests (if they involve collections).

Default: ArangoBenchmark

`--complexity`

Type: uint64

The complexity parameter for the test (meaning depends on test case).

Default: 1

`--config`

Type: string

The configuration file or “none”.

`--configuration`

Type: string

The configuration file or “none”.

`--create-collection`

Introduced in: v3.10.0

Type: boolean

Whether to create the collection specified via the --collection option.

This option can be specified without a value to enable it.

Default: true

`--create-database`

Type: boolean

Whether to create the database specified via the --server.database option.

This option can be specified without a value to enable it.

`--custom-query`

Introduced in: v3.8.0

Type: string

The query to be used in the “custom-query” test case.

`--custom-query-bindvars`

Introduced in: v3.10.0

Type: string

The bind parameters to be used in the “custom-query” test case.

`--custom-query-file`

Introduced in: v3.8.0

Type: string

A path to the file with the query to use in the “custom-query” test case. If --custom-query is specified as well, it has higher priority.

`--define`

Type: string…

Define a value for a @key@ entry in the configuration file using the syntax "key=value".

`--delay`

Type: boolean

Use a startup delay (necessary only when run in series).

This option can be specified without a value to enable it.

`--dump-dependencies`

Type: boolean

Dump the dependency graph of the feature phases (internal) and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

`--dump-options`

Type: boolean

Dump all available startup options in JSON format and exit.

This is a command, no value needs to be specified. The process terminates after executing the command.

`--duration`

Type: uint64

Test for a duration of this many seconds instead of a fixed test count.

`--honor-nsswitch`

Type: boolean

Allow hostname lookup configuration via /etc/nsswitch.conf if on Linux/glibc.

This option can be specified without a value to enable it.

`--json-report-file`

Type: string

The filename to write a report in JSON format to.

`--junit-report-file`

Type: string

The filename to write junit-style report to.

`--keep-alive`

Type: boolean

Use HTTP keep-alive.

This option can be specified without a value to enable it.

Default: true

`--log`

Deprecated in: v3.5.0

Type: string…

Set the topic-specific log level, using --log level for the general topic or --log topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.

Default: info

`--number-of-shards`

Type: uint64

The number of shards of created collections (cluster only).

Default: 1

`--progress`

Type: boolean

Log intermediate progress.

This option can be specified without a value to enable it.

Default: true

`--quiet`

Type: boolean

suppress status messages

This option can be specified without a value to enable it.

`--replication-factor`

Type: uint64

The replication factor of created collections (cluster only).

Default: 1

`--requests`

Type: uint64

The total number of operations.

Default: 1000

`--runs`

Type: uint64

Run test this many times (and calculate statistics based on the median).

Default: 1

`--test-case`

Type: string

The test case to use.

Default: version

Possible values: “aqlinsert”, “collection”, “crud”, “crud-append”, “crud-write-read”, “custom-query”, “document”, “edge”, “import-document”, “persistent-index”, “version”

`--threads`

Introduced in: v3.10.0

Type: uint64

The number of parallel threads and connections.

Default: 8

`--use-splice-syscall`

Introduced in: v3.9.4

Type: boolean

Use the splice() syscall for file copying (may not be supported on all filesystems).

This option can be specified without a value to enable it.

Default: true

Available on Linux only.

Format	Example	Description
`timestamp`	1553766923000	Unix timestamps, in seconds
`timestamp-millis`	1553766923000.123	Unix timestamps, in seconds, with millisecond precision
`timestamp-micros`	1553766923000.123456	Unix timestamps, in seconds, with microsecond precision
`uptime`	987654	seconds since server start
`uptime-millis`	987654.123	seconds since server start, with millisecond precision
`uptime-micros`	987654.123456	seconds since server start, with microsecond precision
`utc-datestring`	2019-03-28T09:55:23Z	UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ
`utc-datestring-millis`	2019-03-28T09:55:23.123Z	like `utc-datestring`, but with millisecond precision
`local-datestring`	2019-03-28T10:55:23	local date and time in format YYYY-MM-DDTHH:MM:SS

Key	Value
`time`	date/time of log message, in format specified by `--log.time-format`
`prefix`	only emitted if `--log.prefix` is set
`pid`	process id, only emitted if `--log.process` is set
`tid`	thread id, only emitted if `--log.thread` is set
`thread`	thread name, only emitted if `--log.thread-name` is set
`role`	server role (1 character), only emitted if `--log.role` is set
`level`	log level (e.g. `"WARN"`, `"INFO"`)
`file`	source file name of log message, only emitted if `--log.line-number` is set
`line`	source file line of log message, only emitted if `--log.line-number` is set
`function`	source file function name, only emitted if `--log.line-number` is set
`topic`	log topic name
`id`	log id (5 digit hexadecimal string), only emitted if `--log.ids` is set
`hostname`	hostname if `--log.hostname` is set
`message`	the actual log message payload

arangobench Startup Options

General

--async

--batch-size

--check-configuration

--collection

--complexity

--config

--configuration

--create-collection

--create-database

--custom-query

--custom-query-bindvars

--custom-query-file

--define

--delay

--dump-dependencies

--dump-options

--duration

--honor-nsswitch

--json-report-file

--junit-report-file

--keep-alive

--log

--number-of-shards

--progress

--quiet

--replication-factor

--requests

--runs

--test-case

--threads

--use-splice-syscall

--version

--version-json

--wait-for-sync

histogram

--histogram.generate

--histogram.interval-size

--histogram.num-intervals

--histogram.percentiles

log

--log.color

--log.escape-control-chars

--log.escape-unicode-chars

--log.file

--log.file-group

--log.file-mode

--log.force-direct

--log.foreground-tty

--log.hostname

--log.ids

--log.level

--log.line-number

--log.max-entry-length

--log.max-queued-entries

--log.output

--log.performance

--log.prefix

--log.process

--log.request-parameters

--log.role

--log.shorten-filenames

--log.structured-param

--log.thread

--log.thread-name

--log.time-format

--log.use-json-format

--log.use-local-time

--log.use-microtime

random

--random.generator

server

--server.authentication

--server.connection-timeout

--server.database

--server.endpoint

--server.max-packet-size

--server.password

--server.request-timeout

`--async`

`--batch-size`

`--check-configuration`

`--collection`

`--complexity`

`--config`

`--configuration`

`--create-collection`

`--create-database`

`--custom-query`

`--custom-query-bindvars`

`--custom-query-file`

`--define`

`--delay`

`--dump-dependencies`

`--dump-options`

`--duration`

`--honor-nsswitch`

`--json-report-file`

`--junit-report-file`

`--keep-alive`

`--log`

`--number-of-shards`

`--progress`

`--quiet`

`--replication-factor`

`--requests`

`--runs`

`--test-case`

`--threads`

`--use-splice-syscall`

`--version`

`--version-json`

`--wait-for-sync`

`--histogram.generate`

`--histogram.interval-size`

`--histogram.num-intervals`

`--histogram.percentiles`

`--log.color`

`--log.escape-control-chars`

`--log.escape-unicode-chars`

`--log.file`

`--log.file-group`

`--log.file-mode`

`--log.force-direct`

`--log.foreground-tty`

`--log.hostname`

`--log.ids`

`--log.level`

`--log.line-number`

`--log.max-entry-length`

`--log.max-queued-entries`

`--log.output`

`--log.performance`

`--log.prefix`

`--log.process`

`--log.request-parameters`

`--log.role`

`--log.shorten-filenames`

`--log.structured-param`

`--log.thread`

`--log.thread-name`

`--log.time-format`

`--log.use-json-format`

`--log.use-local-time`

`--log.use-microtime`

`--random.generator`

`--server.authentication`

`--server.connection-timeout`

`--server.database`

`--server.endpoint`

`--server.max-packet-size`

`--server.password`

`--server.request-timeout`

`--server.username`

`--ssl.protocol`

`--temp.path`