bdd41cde7e
With new option --book Shaker is able to generate report as book in ReST format. The report contains necessary data only. Change-Id: I3bc575214da5cabb7ec9eee7f497a8d5cbb67097
124 lines
7.8 KiB
Plaintext
124 lines
7.8 KiB
Plaintext
usage: shaker-spot [-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] [--log-format FORMAT] [--matrix MATRIX]
|
|
[--no-report-on-error] [--nodebug] [--nono-report-on-error]
|
|
[--nouse-syslog] [--nouse-syslog-rfc-format] [--noverbose]
|
|
[--nowatch-log-file] [--output OUTPUT] [--report REPORT]
|
|
[--report-template REPORT_TEMPLATE] [--scenario SCENARIO]
|
|
[--subunit SUBUNIT]
|
|
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
|
|
[--use-syslog-rfc-format] [--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[SHAKER_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. The default files used are: None.
|
|
--debug, -d Print debugging output (set logging level to DEBUG
|
|
instead of 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, log_format).
|
|
--log-date-format DATE_FORMAT
|
|
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 output to. If no
|
|
default is set, logging will go to stdout. This option
|
|
is ignored if log_config_append is set.
|
|
--log-format FORMAT DEPRECATED. A logging.Formatter log message format
|
|
string which may use any of the available
|
|
logging.LogRecord attributes. This option is
|
|
deprecated. Please use logging_context_format_string
|
|
and logging_default_format_string instead. This option
|
|
is ignored if log_config_append is set.
|
|
--matrix MATRIX Set the matrix of parameters for the scenario. The
|
|
value is specified in YAML format. E.g. to override
|
|
the scenario duration one may provide: "{time: 10}",
|
|
or to override list of hosts: "{host:[ping.online.net,
|
|
iperf.eenet.ee]}". When several parameters are
|
|
overridden all combinations are tested
|
|
--no-report-on-error Do not generate report for failed scenarios
|
|
--nodebug The inverse of --debug
|
|
--nono-report-on-error
|
|
The inverse of --no-report-on-error
|
|
--nouse-syslog The inverse of --use-syslog
|
|
--nouse-syslog-rfc-format
|
|
The inverse of --use-syslog-rfc-format
|
|
--noverbose The inverse of --verbose
|
|
--nowatch-log-file The inverse of --watch-log-file
|
|
--output OUTPUT File for output in JSON format, defaults to
|
|
env[SHAKER_OUTPUT].
|
|
--report REPORT Report file name, defaults to env[SHAKER_REPORT].
|
|
--report-template REPORT_TEMPLATE
|
|
Template for report. Can be a file name or one of
|
|
aliases: "interactive", "json". Defaults to
|
|
"interactive".
|
|
--scenario SCENARIO Scenario to play. Can be a file name or one of
|
|
aliases: "misc/instance_metadata",
|
|
"misc/static_agent", "misc/static_agents_pair",
|
|
"networking/cross_az/full_l2",
|
|
"networking/cross_az/full_l3_east_west",
|
|
"networking/cross_az/full_l3_north_south",
|
|
"networking/cross_az/perf_l2",
|
|
"networking/cross_az/perf_l3_east_west",
|
|
"networking/cross_az/perf_l3_north_south",
|
|
"networking/cross_az/udp_l2",
|
|
"networking/cross_az/udp_l2_mss8950",
|
|
"networking/cross_az/udp_l3_east_west",
|
|
"networking/dense_l2",
|
|
"networking/dense_l3_east_west",
|
|
"networking/dense_l3_north_south",
|
|
"networking/full_l2", "networking/full_l3_east_west",
|
|
"networking/full_l3_north_south",
|
|
"networking/perf_l2", "networking/perf_l3_east_west",
|
|
"networking/perf_l3_north_south", "networking/udp_l2",
|
|
"networking/udp_l3_east_west",
|
|
"networking/udp_l3_north_south", "spot/tcp",
|
|
"spot/udp". Defaults to env[SHAKER_SCENARIO].
|
|
--subunit SUBUNIT Subunit stream file name, defaults to
|
|
env[SHAKER_SUBUNIT].
|
|
--syslog-log-facility SYSLOG_LOG_FACILITY
|
|
Syslog facility to receive log lines. This option is
|
|
ignored if log_config_append is set.
|
|
--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.
|
|
--use-syslog-rfc-format
|
|
(Optional) Enables or disables syslog rfc5424 format
|
|
for logging. If enabled, prefixes the MSG part of the
|
|
syslog message with APP-NAME (RFC5424). The format
|
|
without the APP-NAME is deprecated in Kilo, and will
|
|
be removed in Mitaka, along with this option. This
|
|
option is ignored if log_config_append is set.
|
|
--verbose, -v If set to false, will disable INFO logging level,
|
|
making WARNING the default.
|
|
--version show program's version number and exit
|
|
--watch-log-file (Optional) 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.
|