<None>
Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.
│ │ │ │ │ │ │ │ │ │ │ │boolean
│ │ │ │True
Some periodic tasks can be run in a separate process. Should we run them here?
│ │ │ │ -string
│ │ │ │ +False
<None>
This option can be changed without restarting.
│ │ │ │Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.
│ │ │ │ +If set to true, the logging level will be set to DEBUG instead of the default INFO level.
│ │ │ │string
│ │ │ │<None>
This option can be changed without restarting.
│ │ │ │ +Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.
│ │ │ │ +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).
│ │ │ │ +Group |
│ │ │ │ +Name |
│ │ │ │ +
|---|---|
DEFAULT |
│ │ │ │ +log-config |
│ │ │ │ +
DEFAULT |
│ │ │ │ +log_config |
│ │ │ │ +
boolean
│ │ │ │ +string
│ │ │ │True
%Y-%m-%d %H:%M:%S
Enables or disables logging values of all registered options when starting a service (at DEBUG level).
│ │ │ │ +Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │60
<None>
Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
│ │ │ │ +(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.
│ │ │ │ +Group |
│ │ │ │ +Name |
│ │ │ │ +
|---|---|
DEFAULT |
│ │ │ │ +logfile |
│ │ │ │ +
string
│ │ │ │api-paste.ini
<None>
File name for the paste.deploy config for api service
│ │ │ │ +(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
│ │ │ │ +Group |
│ │ │ │ +Name |
│ │ │ │ +
|---|---|
DEFAULT |
│ │ │ │ +logdir |
│ │ │ │ +
string
│ │ │ │ +boolean
│ │ │ │%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f
False
A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
│ │ │ │ +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.
│ │ │ │integer
│ │ │ │ +boolean
│ │ │ │600
False
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
│ │ │ │ +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.
│ │ │ │integer
│ │ │ │ +boolean
│ │ │ │100
False
Size of the pool of greenthreads used by wsgi
│ │ │ │ +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.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │16384
LOG_USER
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).
│ │ │ │ +Syslog facility to receive log lines. This option is ignored if log_config_append is set.
│ │ │ │boolean
│ │ │ │True
False
If False, closes the client socket connection explicitly.
│ │ │ │ +Use JSON formatting for logging. This option is ignored if log_config_append is set.
│ │ │ │integer
│ │ │ │ +boolean
│ │ │ │900
False
Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.
│ │ │ │ +Log output to standard error. This option is ignored if log_config_append is set.
│ │ │ │boolean
│ │ │ │False
True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.
│ │ │ │ +Log output to Windows Event Log.
│ │ │ │integer
│ │ │ │30
1
│ │ │ │ +1
Size of RPC connection pool.
│ │ │ │ -Group |
│ │ │ │ -Name |
│ │ │ │ -
|---|---|
DEFAULT |
│ │ │ │ -rpc_conn_pool_size |
│ │ │ │ -
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │2
days
Seconds, Minutes, Hours, Days, Weekday, Midnight
│ │ │ │The pool size limit for connections expiration policy
│ │ │ │ +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.
│ │ │ │integer
│ │ │ │1200
30
The time-to-live in sec of idle connections in the pool
│ │ │ │ +Maximum number of rotated log files.
│ │ │ │integer
│ │ │ │64
200
Size of executor thread pool when executor is threading or eventlet.
│ │ │ │ -Group |
│ │ │ │ -Name |
│ │ │ │ -
|---|---|
DEFAULT |
│ │ │ │ -rpc_thread_pool_size |
│ │ │ │ -
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │60
none
interval, size, none
│ │ │ │ +Log rotation type.
│ │ │ │ +Possible values
│ │ │ │ +Rotate logs at predefined time intervals.
│ │ │ │ +Rotate logs once they reach a predefined size.
│ │ │ │ +Do not rotate log files.
│ │ │ │Seconds to wait for a response from a call.
│ │ │ │string
│ │ │ │rabbit://
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s
The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:
│ │ │ │ -driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
│ │ │ │ -Example: rabbit://rabbitmq:password@127.0.0.1:5672//
│ │ │ │ -For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
│ │ │ │ +Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
│ │ │ │string
│ │ │ │openstack
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
│ │ │ │ +Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
│ │ │ │boolean
│ │ │ │ +string
│ │ │ │False
%(funcName)s %(pathname)s:%(lineno)d
Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
│ │ │ │ +Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
│ │ │ │boolean
│ │ │ │ +string
│ │ │ │False
This option can be changed without restarting.
│ │ │ │ +%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
│ │ │ │ +Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
│ │ │ │string
│ │ │ │<None>
This option can be changed without restarting.
│ │ │ │ +%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s
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).
│ │ │ │ -Group |
│ │ │ │ -Name |
│ │ │ │ -
|---|---|
DEFAULT |
│ │ │ │ -log-config |
│ │ │ │ -
DEFAULT |
│ │ │ │ -log_config |
│ │ │ │ -
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
│ │ │ │string
│ │ │ │ +list
│ │ │ │%Y-%m-%d %H:%M:%S
['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']
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
│ │ │ │ +List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
│ │ │ │string
│ │ │ │ +boolean
│ │ │ │<None>
False
(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.
│ │ │ │ -Group |
│ │ │ │ -Name |
│ │ │ │ -
|---|---|
DEFAULT |
│ │ │ │ -logfile |
│ │ │ │ -
Enables or disables publication of error events.
│ │ │ │string
│ │ │ │<None>
"[instance: %(uuid)s] "
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
│ │ │ │ -Group |
│ │ │ │ -Name |
│ │ │ │ -
|---|---|
DEFAULT |
│ │ │ │ -logdir |
│ │ │ │ -
The format for an instance that is passed with the log message.
│ │ │ │boolean
│ │ │ │ +string
│ │ │ │False
"[instance: %(uuid)s] "
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.
│ │ │ │ +The format for an instance UUID that is passed with the log message.
│ │ │ │boolean
│ │ │ │ +integer
│ │ │ │False
0
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.
│ │ │ │ +Interval, number of seconds, of log rate limiting.
│ │ │ │boolean
│ │ │ │ +integer
│ │ │ │False
0
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.
│ │ │ │ +Maximum number of logged messages per rate_limit_interval.
│ │ │ │string
│ │ │ │LOG_USER
CRITICAL
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
│ │ │ │ +Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
│ │ │ │boolean
│ │ │ │False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
│ │ │ │ +Enables or disables fatal status of deprecations.
│ │ │ │boolean
│ │ │ │False
True
Log output to standard error. This option is ignored if log_config_append is set.
│ │ │ │ +Some periodic tasks can be run in a separate process. Should we run them here?
│ │ │ │boolean
│ │ │ │ +string
│ │ │ │False
<None>
Log output to Windows Event Log.
│ │ │ │ +Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │1
<None>
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
│ │ │ │ +Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.
│ │ │ │string
│ │ │ │ +boolean
│ │ │ │days
Seconds, Minutes, Hours, Days, Weekday, Midnight
│ │ │ │ +True
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.
│ │ │ │ +Enables or disables logging values of all registered options when starting a service (at DEBUG level).
│ │ │ │integer
│ │ │ │30
60
Maximum number of rotated log files.
│ │ │ │ +Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │200
api-paste.ini
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
│ │ │ │ +File name for the paste.deploy config for api service
│ │ │ │string
│ │ │ │none
interval, size, none
│ │ │ │ +%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f
Log rotation type.
│ │ │ │ -Possible values
│ │ │ │ -Rotate logs at predefined time intervals.
│ │ │ │ -Rotate logs once they reach a predefined size.
│ │ │ │ +A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
│ │ │ │ +integer
│ │ │ │Do not rotate log files.
│ │ │ │ +600
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
│ │ │ │string
│ │ │ │ +integer
│ │ │ │%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s
100
Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
│ │ │ │ +Size of the pool of greenthreads used by wsgi
│ │ │ │string
│ │ │ │ +integer
│ │ │ │%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
16384
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
│ │ │ │ +Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).
│ │ │ │string
│ │ │ │ +boolean
│ │ │ │%(funcName)s %(pathname)s:%(lineno)d
True
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
│ │ │ │ +If False, closes the client socket connection explicitly.
│ │ │ │string
│ │ │ │ +integer
│ │ │ │%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
900
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
│ │ │ │ +Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.
│ │ │ │string
│ │ │ │ +boolean
│ │ │ │%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s
False
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
│ │ │ │ +True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.
│ │ │ │list
│ │ │ │ +integer
│ │ │ │['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']
30
1
│ │ │ │List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
│ │ │ │ +Size of RPC connection pool.
│ │ │ │ +Group |
│ │ │ │ +Name |
│ │ │ │ +
|---|---|
DEFAULT |
│ │ │ │ +rpc_conn_pool_size |
│ │ │ │ +
boolean
│ │ │ │ +integer
│ │ │ │False
2
Enables or disables publication of error events.
│ │ │ │ +The pool size limit for connections expiration policy
│ │ │ │string
│ │ │ │ +integer
│ │ │ │"[instance: %(uuid)s] "
1200
The format for an instance that is passed with the log message.
│ │ │ │ +The time-to-live in sec of idle connections in the pool
│ │ │ │string
│ │ │ │ +integer
│ │ │ │"[instance: %(uuid)s] "
64
The format for an instance UUID that is passed with the log message.
│ │ │ │ +Size of executor thread pool when executor is threading or eventlet.
│ │ │ │ +Group |
│ │ │ │ +Name |
│ │ │ │ +
|---|---|
DEFAULT |
│ │ │ │ +rpc_thread_pool_size |
│ │ │ │ +
integer
│ │ │ │0
60
Interval, number of seconds, of log rate limiting.
│ │ │ │ +Seconds to wait for a response from a call.
│ │ │ │integer
│ │ │ │ +string
│ │ │ │0
rabbit://
Maximum number of logged messages per rate_limit_interval.
│ │ │ │ +The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:
│ │ │ │ +driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
│ │ │ │ +Example: rabbit://rabbitmq:password@127.0.0.1:5672//
│ │ │ │ +For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
│ │ │ │string
│ │ │ │CRITICAL
openstack
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
│ │ │ │ +The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
│ │ │ │boolean
│ │ │ │False
Enables or disables fatal status of deprecations.
│ │ │ │ +Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
│ │ │ │