9e3afbf14c
The deprecation for this was merged on aug 1, 2015 in review: https://review.openstack.org/#/c/206437/ That was a long time ago so it should be possible to remove it now. This was already merged once but had to be reverted because some projects were still relying on it. Let's try again, this time using INFO default not WARNING, thanks dtantsur! Depends-On: I713e9e5107a64ec29c220d1150c1bf5fcf6f1135 Depends-On: I102e8c7bca508b17ce2987b33148e99c79d0c147 Change-Id: I9e2bf358a0b7a2413388007b33902b91de522b22
181 lines
8.2 KiB
Python
181 lines
8.2 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from oslo_config import cfg
|
|
|
|
from oslo_log import versionutils
|
|
|
|
_DEFAULT_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
|
|
|
|
DEFAULT_LOG_LEVELS = ['amqp=WARN', 'amqplib=WARN', 'boto=WARN',
|
|
'qpid=WARN', 'sqlalchemy=WARN', 'suds=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']
|
|
|
|
_IGNORE_MESSAGE = "This option is ignored if log_config_append is set."
|
|
|
|
common_cli_opts = [
|
|
cfg.BoolOpt('debug',
|
|
short='d',
|
|
default=False,
|
|
mutable=True,
|
|
help='If set to true, the logging level will be set to '
|
|
'DEBUG instead of the default INFO level.'),
|
|
]
|
|
|
|
logging_cli_opts = [
|
|
cfg.StrOpt('log-config-append',
|
|
metavar='PATH',
|
|
deprecated_name='log-config',
|
|
mutable=True,
|
|
help='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).'),
|
|
cfg.StrOpt('log-date-format',
|
|
default=_DEFAULT_LOG_DATE_FORMAT,
|
|
metavar='DATE_FORMAT',
|
|
help='Defines the format string for %%(asctime)s in log '
|
|
'records. Default: %(default)s . '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.StrOpt('log-file',
|
|
metavar='PATH',
|
|
deprecated_name='logfile',
|
|
help='(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. '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.StrOpt('log-dir',
|
|
deprecated_name='logdir',
|
|
help='(Optional) The base directory used for relative log_file '
|
|
' paths. '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.BoolOpt('watch-log-file',
|
|
default=False,
|
|
help='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. '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.BoolOpt('use-syslog',
|
|
default=False,
|
|
help='Use syslog for logging. '
|
|
'Existing syslog format is DEPRECATED '
|
|
'and will be changed later to honor RFC5424. '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.StrOpt('syslog-log-facility',
|
|
default='LOG_USER',
|
|
help='Syslog facility to receive log lines. '
|
|
+ _IGNORE_MESSAGE),
|
|
]
|
|
|
|
generic_log_opts = [
|
|
cfg.BoolOpt('use_stderr',
|
|
default=False,
|
|
help='Log output to standard error. '
|
|
+ _IGNORE_MESSAGE),
|
|
]
|
|
|
|
log_opts = [
|
|
cfg.StrOpt('logging_context_format_string',
|
|
default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s '
|
|
'%(name)s [%(request_id)s %(user_identity)s] '
|
|
'%(instance)s%(message)s',
|
|
help='Format string to use for log messages with context.'),
|
|
cfg.StrOpt('logging_default_format_string',
|
|
default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s '
|
|
'%(name)s [-] %(instance)s%(message)s',
|
|
help='Format string to use for log messages when context is '
|
|
'undefined.'),
|
|
cfg.StrOpt('logging_debug_format_suffix',
|
|
default='%(funcName)s %(pathname)s:%(lineno)d',
|
|
help='Additional data to append to log message when logging '
|
|
'level for the message is DEBUG.'),
|
|
cfg.StrOpt('logging_exception_prefix',
|
|
default='%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s '
|
|
'%(instance)s',
|
|
help='Prefix each line of exception output with this format.'),
|
|
cfg.StrOpt('logging_user_identity_format',
|
|
default='%(user)s %(tenant)s '
|
|
'%(domain)s %(user_domain)s %(project_domain)s',
|
|
help='Defines the format string for %(user_identity)s that '
|
|
'is used in logging_context_format_string.'),
|
|
cfg.ListOpt('default_log_levels',
|
|
default=DEFAULT_LOG_LEVELS,
|
|
help='List of package logging levels in logger=LEVEL pairs. '
|
|
+ _IGNORE_MESSAGE),
|
|
cfg.BoolOpt('publish_errors',
|
|
default=False,
|
|
help='Enables or disables publication of error events.'),
|
|
|
|
# NOTE(mikal): there are two options here because sometimes we are handed
|
|
# a full instance (and could include more information), and other times we
|
|
# are just handed a UUID for the instance.
|
|
cfg.StrOpt('instance_format',
|
|
default='[instance: %(uuid)s] ',
|
|
help='The format for an instance that is passed with the log '
|
|
'message.'),
|
|
cfg.StrOpt('instance_uuid_format',
|
|
default='[instance: %(uuid)s] ',
|
|
help='The format for an instance UUID that is passed with the '
|
|
'log message.'),
|
|
|
|
cfg.IntOpt('rate_limit_interval',
|
|
default=0,
|
|
help='Interval, number of seconds, of log rate limiting.'),
|
|
cfg.IntOpt('rate_limit_burst',
|
|
default=0,
|
|
help='Maximum number of logged messages per '
|
|
'rate_limit_interval.'),
|
|
cfg.StrOpt('rate_limit_except_level',
|
|
default='CRITICAL',
|
|
help='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.'),
|
|
]
|
|
|
|
|
|
def list_opts():
|
|
"""Returns a list of oslo.config options available in the library.
|
|
|
|
The returned list includes all oslo.config options which may be registered
|
|
at runtime by the library.
|
|
|
|
Each element of the list is a tuple. The first element is the name of the
|
|
group under which the list of elements in the second element will be
|
|
registered. A group name of None corresponds to the [DEFAULT] group in
|
|
config files.
|
|
|
|
The purpose of this is to allow tools like the Oslo sample config file
|
|
generator (oslo-config-generator) to discover the options exposed to users
|
|
by this library.
|
|
|
|
:returns: a list of (group_name, opts) tuples
|
|
"""
|
|
return [(None, (common_cli_opts + logging_cli_opts +
|
|
generic_log_opts + log_opts +
|
|
versionutils.deprecated_opts))]
|