Runs specified scenario, stores data and generates report.
usage: performa [-h] [--book BOOK] [--config-dir DIR] [--config-file PATH]
[--debug] [--log-config-append PATH]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--mongo-db MONGO_DB]
[--mongo-url MONGO_URL] [--nodebug] [--nouse-syslog]
[--noverbose] [--nowatch-log-file] [--remote-user REMOTE_USER]
[--scenario SCENARIO]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--tag TAG]
[--use-syslog] [--vars VARS] [--verbose] [--version]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
--book BOOK Generate report in ReST format and store it into the
specified folder, defaults to env[PERFORMA_BOOK].
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a
predictable parse order if individual options are
over-ridden. The set is parsed after the file(s)
specified via previous --config-file, arguments hence
over-ridden options in the directory take precedence.
--config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. Defaults to None.
--debug, -d If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
--log-config-append PATH, --log_config PATH
The name of a logging configuration file. This file is
appended to any existing logging configuration files.
For details about logging configuration files, see the
Python logging module documentation. Note that when
logging configuration files are used then all logging
configuration is set in the configuration file and
other logging configuration options are ignored (for
example, logging_context_format_string).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log
records. Default: None . This option is ignored if
log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative
log_file paths. This option is ignored if
log_config_append is set.
--log-file PATH, --logfile PATH
(Optional) Name of log file to send logging output to.
If no default is set, logging will go to stderr as
defined by use_stderr. This option is ignored if
log_config_append is set.
--mongo-db MONGO_DB Mongo DB, defaults to env[PERFORMA_MONGO_DB].
--mongo-url MONGO_URL
Mongo URL, defaults to env[PERFORMA_MONGO_URL].
--nodebug The inverse of --debug
--nouse-syslog The inverse of --use-syslog
--noverbose The inverse of --verbose
--nowatch-log-file The inverse of --watch-log-file
--remote-user REMOTE_USER
User for connecting to remote systems, defaults to
env[PERFORMA_REMOTE_USER].
--scenario SCENARIO Scenario to play. Can be a file name or one of
aliases: "db/sysbench", "mq/rabbitmq-ha-call", "mq
/rabbitmq-ha-cast", "mq/rabbitmq-ha-notify",
"mq/rabbitmq". Defaults to env[PERFORMA_SCENARIO].
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is
ignored if log_config_append is set.
--tag TAG Tag the execution, defaults to env[PERFORMA_TAG].
--use-syslog Use syslog for logging. Existing syslog format is
DEPRECATED and will be changed later to honor RFC5424.
This option is ignored if log_config_append is set.
--vars VARS Variables that are injected into scenario template.
Can be specified via env[PERFORMA_VARS].
--verbose, -v If set to false, the logging level will be set to
WARNING instead of the default INFO level.
--version show program's version number and exit
--watch-log-file Uses logging handler designed to watch file system.
When log file is moved or removed this handler will
open a new log file with specified path
instantaneously. It makes sense only if log_file
option is specified and Linux platform is used. This
option is ignored if log_config_append is set.
Generates report based on previously collected data.