tornado.log — 日志支持

Tornado 的日志支持。

Tornado 使用三个日志流

  • tornado.access: 针对 Tornado 的 HTTP 服务器(以及将来可能的其他服务器)的每个请求日志

  • tornado.application: 记录来自应用程序代码的错误(例如,回调中未捕获的异常)

  • tornado.general: 通用日志记录,包括来自 Tornado 本身的任何错误或警告。

可以使用标准库的 logging 模块独立配置这些流。例如,您可能希望将 tornado.access 日志发送到单独的文件以进行分析。

class tornado.log.LogFormatter(fmt: str = '%(color)s[%(levelname)1.1s %(asctime)s %(module)s:%(lineno)d]%(end_color)s %(message)s', datefmt: str = '%y%m%d %H:%M:%S', style: str = '%', color: bool = True, colors: Dict[int, int] = {10: 4, 20: 2, 30: 3, 40: 1, 50: 5})[source]

Tornado 中使用的日志格式化器。

此格式化器的关键功能是

  • 当日志记录到支持它的终端时,提供颜色支持。

  • 每条日志行上的时间戳。

  • 对 str/字节编码问题具有鲁棒性。

此格式化器由 tornado.options.parse_command_linetornado.options.parse_config_file 自动启用(除非使用 --logging=none)。

通过使用 colorama 库,在不支持 ANSI 颜色代码的 Windows 版本上启用了颜色支持。希望使用此功能的应用程序必须首先通过调用 colorama.init 初始化 colorama。有关详细信息,请参阅 colorama 文档。

在版本 4.5 中更改: 添加了对 colorama 的支持。更改了构造函数签名以与 logging.config.dictConfig 兼容。

参数
  • color (bool) – 启用颜色支持。

  • fmt (str) – 日志消息格式。它将应用于日志记录的属性字典。如果颜色支持已启用,则 %(color)s%(end_color)s 之间的文本将根据级别着色。

  • colors (dict) – 从日志记录级别到终端颜色代码的颜色映射

  • datefmt (str) – 日期时间格式。用于在 prefix_fmt 中格式化 (asctime) 占位符。

在版本 3.2 中更改: 添加了 fmtdatefmt 参数。

tornado.log.enable_pretty_logging(options: Optional[Any] = None, logger: Optional[Logger] = None) None[source]

打开根据配置格式化的日志输出。

此方法由 tornado.options.parse_command_linetornado.options.parse_config_file 自动调用。

tornado.log.define_logging_options(options: Optional[Any] = None) None[source]

options 添加与日志记录相关的标志。

这些选项在默认选项实例上自动存在;如果您创建了自己的 OptionParser,则此方法仅在必要时使用。

在版本 4.2 中添加: 此函数在之前的版本中存在,但在 4.2 之前是损坏且未记录的。