diff --git a/etc/rally/rally.conf.sample b/etc/rally/rally.conf.sample index 63e219490b..a0b24c1767 100644 --- a/etc/rally/rally.conf.sample +++ b/etc/rally/rally.conf.sample @@ -14,8 +14,8 @@ # 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). (string value) +# configuration options are ignored (for example, log-date-format). +# (string value) # Note: This option can be changed without restarting. # Deprecated group/name - [DEFAULT]/log_config #log_config_append = @@ -67,28 +67,65 @@ # log_config_append is set. (boolean value) #use_stderr = true -# Format string to use for log messages with context. (string value) +# Log output to Windows Event Log. (boolean value) +#use_eventlog = false + +# The amount of time before the log files are rotated. This option is +# ignored unless log_rotation_type is setto "interval". (integer +# value) +#log_rotate_interval = 1 + +# Rotation interval type. The time of the last file change (or the +# time when the service was started) is used when scheduling the next +# rotation. (string value) +# Possible values: +# Seconds - +# Minutes - +# Hours - +# Days - +# Weekday - +# Midnight - +#log_rotate_interval_type = days + +# Maximum number of rotated log files. (integer value) +#max_logfile_count = 30 + +# Log file maximum size in MB. This option is ignored if +# "log_rotation_type" is not set to "size". (integer value) +#max_logfile_size_mb = 200 + +# Log rotation type. (string value) +# Possible values: +# interval - Rotate logs at predefined time intervals. +# size - Rotate logs once they reach a predefined size. +# none - Do not rotate log files. +#log_rotation_type = none + +# Format string to use for log messages with context. Used by +# oslo_log.formatters.ContextFormatter (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s # Format string to use for log messages when context is undefined. -# (string value) +# Used by oslo_log.formatters.ContextFormatter (string value) #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s # Additional data to append to log message when logging level for the -# message is DEBUG. (string value) +# message is DEBUG. Used by oslo_log.formatters.ContextFormatter +# (string value) #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d -# Prefix each line of exception output with this format. (string -# value) +# Prefix each line of exception output with this format. Used by +# oslo_log.formatters.ContextFormatter (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s # Defines the format string for %(user_identity)s that is used in -# logging_context_format_string. (string value) +# logging_context_format_string. Used by +# oslo_log.formatters.ContextFormatter (string value) #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s # List of package logging levels in logger=LEVEL pairs. This option is # ignored if log_config_append is set. (list value) -#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,oslo_policy=INFO,dogpile.core.dogpile=INFO # Enables or disables publication of error events. (boolean value) #publish_errors = false @@ -121,6 +158,13 @@ # From rally # +# A mktemp(1)-like format string that will be used to pattern the +# generated random string. It must contain two separate segments of at +# least three 'X's; the first one will be replaced by a portion of the +# owner ID (i.e task/subtask ID), and the second will be replaced with +# a random string. (string value) +#context_resource_name_format = + # Print debugging output only for Rally. Off-site components stay # quiet. (boolean value) #rally_debug = false @@ -129,6 +173,13 @@ # Minimum value: 1 #raw_result_chunk_size = 1000 +# A mktemp(1)-like format string that will be used to pattern the +# generated random string. It must contain two separate segments of at +# least three 'X's; the first one will be replaced by a portion of the +# owner ID (i.e task/subtask ID), and the second will be replaced with +# a random string. (string value) +#scenario_resource_name_format = + [database] @@ -174,12 +225,6 @@ # Deprecated group/name - [sql]/idle_timeout #connection_recycle_time = 3600 -# Minimum number of SQL connections to keep open in a pool. (integer -# value) -# Deprecated group/name - [DEFAULT]/sql_min_pool_size -# Deprecated group/name - [DATABASE]/sql_min_pool_size -#min_pool_size = 1 - # Maximum number of SQL connections to keep open in a pool. Setting a # value of 0 indicates no limit. (integer value) # Deprecated group/name - [DEFAULT]/sql_max_pool_size @@ -239,3 +284,7 @@ # error is raised. Set to -1 to specify an infinite retry count. # (integer value) #db_max_retries = 20 + +# Optional URL parameters to append onto the connection URL at connect +# time; specify as param1=value1¶m2=value2&... (string value) +#connection_parameters = diff --git a/rally/common/opts.py b/rally/common/opts.py index b2c415a68e..53101a6b19 100644 --- a/rally/common/opts.py +++ b/rally/common/opts.py @@ -16,7 +16,9 @@ import importlib from rally.common import cfg from rally.common import logging +from rally.task import context from rally.task import engine +from rally.task import scenario CONF = cfg.CONF @@ -24,8 +26,10 @@ CONF = cfg.CONF def list_opts(): merged_opts = {"DEFAULT": []} + merged_opts["DEFAULT"].extend(context.CONF_OPTS) merged_opts["DEFAULT"].extend(logging.DEBUG_OPTS) merged_opts["DEFAULT"].extend(engine.TASK_ENGINE_OPTS) + merged_opts["DEFAULT"].extend(scenario.CONF_OPTS) return merged_opts.items() diff --git a/rally/task/context.py b/rally/task/context.py index c7d294f555..998738985a 100644 --- a/rally/task/context.py +++ b/rally/task/context.py @@ -31,8 +31,11 @@ CONF = cfg.CONF CONF_OPTS = [ cfg.StrOpt( "context_resource_name_format", - help="Template is used to generate random names of resources. X is " - "replaced with random latter, amount of X can be adjusted") + help="A mktemp(1)-like format string that will be used to pattern " + "the generated random string. It must contain two separate " + "segments of at least three 'X's; the first one will be replaced " + "by a portion of the owner ID (i.e task/subtask ID), and the " + "second will be replaced with a random string.") ] CONF.register_opts(CONF_OPTS) diff --git a/rally/task/scenario.py b/rally/task/scenario.py index f815dcc590..d05b478654 100644 --- a/rally/task/scenario.py +++ b/rally/task/scenario.py @@ -32,8 +32,11 @@ CONF = cfg.CONF CONF_OPTS = [ cfg.StrOpt( "scenario_resource_name_format", - help="Template is used to generate random names of resources. X is " - "replaced with random latter, amount of X can be adjusted") + help="A mktemp(1)-like format string that will be used to pattern " + "the generated random string. It must contain two separate " + "segments of at least three 'X's; the first one will be replaced " + "by a portion of the owner ID (i.e task/subtask ID), and the " + "second will be replaced with a random string.") ] CONF.register_opts(CONF_OPTS)