oslo_log.log

OpenStack 日志处理程序。

此模块通过在调用各种日志方法时添加指定上下文对象的选项来增强日志功能。如果未指定上下文对象,则使用默认格式。 此外,可以将实例 UUID 作为日志消息的一部分传递,旨在方便管理员查找与特定实例相关的消息。

它还允许通过 conf 设置格式信息。

class oslo_log.log.BaseLoggerAdapter(logger, extra=None)

基类: LoggerAdapter

property handlers
trace(msg, *args, **kwargs)
warn(msg, *args, **kwargs)

将警告调用委托给基础记录器。

class oslo_log.log.KeywordArgumentAdapter(logger, extra=None)

基类: BaseLoggerAdapter

日志记录器适配器,用于将关键字参数添加到日志记录的“extra”数据中

传递给日志调用的关键字被添加到传递给基础记录器的“extra”字典中,以便它们与日志消息一起发出,并可用于格式字符串。

特殊关键字

extra

一个现有的额外值字典,将被传递给记录器。如果存在,则复制并扩展该字典。

resource
一个类似字典的对象,包含 name 键或 type

id 键。

process(msg, kwargs)

处理传递给日志调用的日志消息和关键字参数,以插入上下文信息。您可以操作消息本身、关键字参数或两者。返回修改后的消息和关键字参数(或不修改),以满足您的需求。

通常,您只需要覆盖 LoggerAdapter 子类中的此方法来满足您的特定需求。

exception oslo_log.log.LogConfigError(log_config, err_msg)

基础: Exception

message = '加载日志配置 %(log_config)s 时出错:%(err_msg)s'
oslo_log.log.getLogger(name=None, project='unknown', version='unknown')

使用给定的名称构建记录器。

参数:
  • name (string) – 记录器的名称。通常是模块名称,__name__

  • project (string) – 项目的名称,将被注入到日志消息中。例如,'nova'

  • version (string) – 项目的版本,将被注入到日志消息中。例如,'2014.2'

oslo_log.log.get_default_log_levels()

返回 Oslo Logging 默认日志级别。

返回列表的副本,以便应用程序可以更改值,而不会影响 log_opts 配置设置中使用的默认值。

oslo_log.log.get_loggers()

返回 oslo 记录器的字典的副本。

oslo_log.log.is_debug_enabled(conf)

确定是否启用了调试日志记录模式。

oslo_log.log.register_options(conf)

注册 oslo.log 使用的命令行和配置选项。

oslo_log.log.set_defaults(logging_context_format_string=None, default_log_levels=None)

设置 oslo.log 使用的配置选项的默认值。

oslo_log.log.setup(conf, product_name, version='unknown', *, fix_eventlet=True)

设置当前应用程序的日志记录。

oslo_log.log.tempest_set_log_file(filename)

提供一个 API,供 tempest 设置日志文件名。

警告

只有 Tempest 应该使用此函数。

我们不希望应用程序设置默认日志文件,因此我们不希望将其放在 set_defaults() 中。由于 tempest 不使用配置文件,因此我们没有另一种方便的方法来安全地设置日志文件默认值。