Python 中的 logging 模块


最简单的用法

import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')

logger 流程
c563a7ee487c395283da502061e15020a15d2a5ac07a6ed429eea0c16de70de0.jpg
logging 模块记录日志涉及四个主要类:

  • logger 提供了应用程序可以直接使用的接口
  • handler 将日志记录发送到合适的目的输出
  • filter 提供了细度设备来决定输出哪条日志记录
  • formatter 决定日志记录的最终输出格式

Logger:
Logging.getLogger([name]):返回一个 logger 对象,通常对应了程序的模块名,如果没有指定名字将返回 root logger
Logger.setLevel(lel):指定最低的日志级别,低于 lel 的级别将被忽略。debug 是最低的内置级别,critical 为最高

LevelNumeric value
CRITICAL50
ERROR40
WARNING30
INFO20
DEBUG10
NOTSET0

共有几个等级,每个等级对应一个 int 型整数。
每个等级都会有一个方法与之对应,这样输出的内容就有了不同的等级。
NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL
如果把 looger 的级别设置为 INFO,那么小于 INFO 级别的日志都不输出,大于等于 INFO 级别的日志都输出。
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的 filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr):增加或删除指定的 handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以设置的日志级别。

Handlers:
Handler 对象负责发送相关的信息到指定目的地。
Python 的日志系统有多种 Handler 可以使用。有些 Handler 可以把信息输出到控制台,有些 Logger 可以把信息输出到文件,还有些 Handler 可以把信息发送到网络上。如果觉得不够用,还可以编写自己的 Handler。可以通过 addHandler() 方法添加多个 Handler。
Handler.setLevel(lel):指定被处理的信息级别,低于 lel 级别的信息将被忽略
Handler.setFormatter():给这个 Handler 选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt):新增或删除一个 filter 对象

  1. Logging.StreamHandler
    使用这个 Handler 可以向类似与 sys.stdout 或者 sys.stderr 的任何文件对象 file object 输出信息。

它的构造函数是:StreamHandler([strm])
其中 strm 参数是一个文件对象。默认是 sys.stderr

  1. Logging.FileHandler
    和 StreamHandler 类似,用于向一个文件输出日志信息。不过 FileHandler 会帮你打开这个文件。

它的构造函数是:FileHandler(filename[,mode])
filename 是文件名,必须指定一个文件名。mode 是文件的打开方式。默认是'a',即添加到文件末尾。

  1. Logging.handlers.RotatingFileHandler
    这个 Handler 类似于上面的 FileHandler,但是它可以管理文件大小。当文件达到一定大小之后,它会自动将当前日志文件改名,然后创建一个新的同名日志文件继续输出。

比如日志文件是 chat.log。当 chat.log 达到指定的大小之后,RotatingFileHandler 自动把文件改名为 chat.log.1。不过如果 chat.log.1 已经存在,会先把 chat.log.1 重命名为 chat.log.2。最后重新创建 chat.log,继续输出日志信息。
它的构造函数是:RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中 filename 和 mode 两个参数和 FileHandler 一样。maxBytes 用于指定日志文件的最大文件大小。如果 maxBytes 为 0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。backupCount 用于指定保留的备份文件的个数。如果指定为 2,当上面描述的重命名过程发生时,原有的 chat.log.2 并不会被更名,而是被删除。

  1. Logging.handlers.TimedRotatingFileHandler
    这个 Handler 和 RotatingFileHandler 类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。重命名的过程与 RotatingFileHandler 类似,不过新的文件不是附加数字,而是当前时间。

它的构造函数是:TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中 filename 参数和 backupCount 参数和 RotatingFileHandler 具有相同的意义。interval 是时间间隔。when 参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值:S 秒、M 分、H 小时、D 天、W 每星期(interval==0时代表星期一)、midnight 每天凌晨

  1. Logging.handlers.SocketHandler
  2. Logging.handlers.DatagramHandler
    以上两个 Handler 类似,都是将日志信息发送到网络。不同的是前者使用 TCP 协议,后者使用 UDP 协议。

它的构造函数是:Handler(host, port)
其中 host 是主机名,port 是端口名

  1. Logging.handlers.SysLogHandler
  2. Logging.handlers.NTEventLogHandler
  3. Logging.handlers.SMTPHandler
  4. Logging.handlers.MemoryHandler
  5. Logging.handlers.HTTPHandler

Formatters:
Formatter 对象设置日志信息最后的规则、结构和内容,默认的时间格式为 %Y-%m-%d %H:%M:%S

StrInfo
%(name)sLogger 的名字
%(levelno)s数字形式的日志级别
%(levelname)s文本形式的日志级别
%(pathname)s调用日志输出函数的模块的完整路径名
%(filename)s调用日志输出函数的模块的文件名
%(module)s调用日志输出函数的模块名
%(funcName)s调用日志输出函数的函数名
%(lineno)d调用日志输出函数的语句所在的代码行
%(created)f当前时间,用 UNIX 标准的表示时间的浮点数表示
%(relativeCreated)d输出日志信息时,自 Logger 创建以来的毫秒数
%(asctime)s字符串形式的当前时间。默认格式是 "2003-07-08 16:49:45,896" 逗号后面的是毫秒
%(thread)d线程 ID
%(threadName)s线程名
%(process)d进程 ID
%(message)s用户输出的消息
分享:

评论