159bd35d2f
agent instance. Issue: Some of our complex test requires to reboot compute nodes. In that scenario, if agent instances are on those computes then those instances will also be rebooted and running shaker test(s) will be stopped. At this time this commit is specifically for shaker's shell class execution as it writes execution script in /tmp directory and we know that if system/instance is being rebooted then whatever /tmp directory contains that will be wiped out. So, if user has a choice to copy that execution script in some specific directory which is not being impacted (i.e /mnt, /opt etc) after reboot then through custom test scripts above condition can be handled Change-Id: I41f824561e36329d07afc9e798eab44b72aeb01a
97 lines
6.1 KiB
Plaintext
97 lines
6.1 KiB
Plaintext
usage: shaker-agent [-h] [--agent-dir AGENT_DIR] [--agent-id AGENT_ID]
|
|
[--agent-socket-conn-retries AGENT_SOCKET_CONN_RETRIES]
|
|
[--agent-socket-recv-timeout AGENT_SOCKET_RECV_TIMEOUT]
|
|
[--agent-socket-send-timeout AGENT_SOCKET_SEND_TIMEOUT]
|
|
[--config-dir DIR] [--config-file PATH] [--debug]
|
|
[--log-config-append PATH] [--log-date-format DATE_FORMAT]
|
|
[--log-dir LOG_DIR] [--log-file PATH] [--nodebug]
|
|
[--nouse-journal] [--nouse-json] [--nouse-syslog]
|
|
[--nowatch-log-file] [--polling-interval POLLING_INTERVAL]
|
|
[--server-endpoint SERVER_ENDPOINT]
|
|
[--syslog-log-facility SYSLOG_LOG_FACILITY]
|
|
[--use-journal] [--use-json] [--use-syslog]
|
|
[--watch-log-file]
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
--agent-dir AGENT_DIR
|
|
If specified, directs Shaker to write execution script
|
|
for the shell class in agent(s) instance defined
|
|
directory. Defaults to /tmp directory.
|
|
--agent-id AGENT_ID Agent unique id, defaults to MAC of primary interface.
|
|
--agent-socket-conn-retries AGENT_SOCKET_CONN_RETRIES
|
|
Prior to exiting, the number of reconnects the Agent
|
|
will attempt with the server upon socket operation
|
|
errors.
|
|
--agent-socket-recv-timeout AGENT_SOCKET_RECV_TIMEOUT
|
|
The amount of time the socket will wait for a response
|
|
from a sent message, in milliseconds.
|
|
--agent-socket-send-timeout AGENT_SOCKET_SEND_TIMEOUT
|
|
The amount of time the socket will wait until a sent
|
|
message is accepted, in milliseconds.
|
|
--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.
|
|
This option must be set from the command-line.
|
|
--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. This option must be set
|
|
from the command-line.
|
|
--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, --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-date-format).
|
|
--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.
|
|
--nodebug The inverse of --debug
|
|
--nouse-journal The inverse of --use-journal
|
|
--nouse-json The inverse of --use-json
|
|
--nouse-syslog The inverse of --use-syslog
|
|
--nowatch-log-file The inverse of --watch-log-file
|
|
--polling-interval POLLING_INTERVAL
|
|
How frequently the agent polls server, in seconds
|
|
--server-endpoint SERVER_ENDPOINT
|
|
Address for server connections (host:port), defaults
|
|
to env[SHAKER_SERVER_ENDPOINT].
|
|
--syslog-log-facility SYSLOG_LOG_FACILITY
|
|
Syslog facility to receive log lines. This option is
|
|
ignored if log_config_append is set.
|
|
--use-journal Enable journald for logging. If running in a systemd
|
|
environment you may wish to enable journal support.
|
|
Doing so will use the journal native protocol which
|
|
includes structured metadata in addition to log
|
|
messages.This option is ignored if log_config_append
|
|
is set.
|
|
--use-json Use JSON formatting for logging. 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.
|
|
--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.
|