Python logging模块

96 阅读5分钟

logging模块

用来记录用户的行为或者代码执行的过程

普通日志

  • 日志级别
logging.debug # 调试
logging.info # 信息提示
logging.warning # 警告
logging.error # 出错
logging.critical # 严重出错

默认生成的root logger的level是logging.WARNING,低于该级别的就不输出了

  • 级别排序

CRITICAL > ERROR > WARNING > INFO > DEBUG

  • 模块方法
logging.debug(msg, *args, **kwargs)	# 创建一条严重级别为DEBUG的日志记录
logging.info(msg, *args, **kwargs)	# 创建一条严重级别为INFO的日志记录
logging.warning(msg, *args, **kwargs)	# 创建一条严重级别为WARNING的日志记录
logging.error(msg, *args, **kwargs)	# 创建一条严重级别为ERROR的日志记录
logging.critical(msg, *args, **kwargs)	# 创建一条严重级别为CRITICAL的日志记录
logging.log(level, *args, **kwargs)	# 创建一条严重级别为level的日志记录
logging.basicConfig(**kwargs)	# 对root logger进行一次性配置

默认情况下Python的logging模块将日志打印到了标准输出中

  • 调整日志级别
logging.basicConfig() # 函数调整日志级别、输出格式等
logging.basicConfig(
  	level=logging.DEBUG,
  	format="%(asctime)s %(name)s %(levelname)s %(message)s",
  	datefmt = '%Y-%m-%d  %H:%M:%S %a'    
)
参数名称描述
filename指定日志输出目标文件的文件名(可以写文件名也可以写文件的完整的绝对路径,写文件名日志放执行文件目录下,写完整路径按照完整路径生成日志文件),指定该设置项后日志信心就不会被输出到控制台了
filemode指定日志文件的打开模式,默认为'a'。需要注意的是,该选项要在filename指定时才有效
format指定日志格式字符串,即指定日志输出时所包含的字段信息以及它们的顺序。logging模块定义的格式字段下面会列出。
datefmt指定日期/时间格式。需要注意的是,该选项要在format中包含时间字段%(asctime)s时才有效
level指定日志器的日志级别
stream指定日志输出目标stream,如sys.stdout、sys.stderr以及网络stream。需要说明的是,stream和filename不能同时提供,否则会引发 ValueError异常
stylePython 3.2中新添加的配置项。指定format格式字符串的风格,可取值为'%'、'{'和'$',默认为'%'
handlersPython 3.3中新添加的配置项。该选项如果被指定,它应该是一个创建了多个Handler的可迭代对象,这些handler将会被添加到root logger。需要说明的是:filename、stream和handlers这三个配置项只能有一个存在,不能同时出现2个或3个,否则会引发ValueError异常。
  • logging模块中定义好的可以用于format格式字符串说明
字段/属性名称使用格式描述
asctime%(asctime)s将日志的时间构造成可读的形式,默认情况下是‘2016-02-08 12:00:00,123’精确到毫秒
name%(name)s所使用的日志器名称,默认是'root',因为默认使用的是 rootLogger
filename%(filename)s调用日志输出函数的模块的文件名; pathname的文件名部分,包含文件后缀
funcName%(funcName)s由哪个function发出的log, 调用日志输出函数的函数名
levelname%(levelname)s日志的最终等级(被filter修改后的)
message%(message)s日志信息, 日志记录的文本内容
lineno%(lineno)d当前日志的行号, 调用日志输出函数的语句所在的代码行
levelno%(levelno)s该日志记录的数字形式的日志级别(10, 20, 30, 40, 50)
pathname%(pathname)s完整路径 ,调用日志输出函数的模块的完整路径名,可能没有
process%(process)s当前进程, 进程ID。可能没有
processName%(processName)s进程名称,Python 3.1新增
thread%(thread)s当前线程, 线程ID。可能没有
threadName%(thread)s线程名称
module%(module)s调用日志输出函数的模块名, filename的名称部分,不包含后缀即不包含文件后缀的文件名
created%(created)f当前时间,用UNIX标准的表示时间的浮点数表示; 日志事件发生的时间--时间戳,就是当时调用time.time()函数返回的值
relativeCreated%(relativeCreated)d输出日志信息时的,自Logger创建以 来的毫秒数; 日志事件发生的时间相对于logging模块加载时间的相对毫秒数
msecs%(msecs)d日志事件发生事件的毫秒部分。logging.basicConfig()中用了参数datefmt,将会去掉asctime中产生的毫秒部分,可以用这个加上
import logging
LOG_FORMAT = "%(asctime)s %(name)s %(levelname)s %(pathname)s %(message)s "#配置输出日志格式
DATE_FORMAT = '%Y-%m-%d  %H:%M:%S %a ' #配置输出时间的格式,注意月份和天数不要搞乱了
logging.basicConfig(
  	level = logging.DEBUG,
	format = LOG_FORMAT,
	datefmt = DATE_FORMAT ,
    filename="test.log" #有了filename参数就不会直接输出显示到控制台,而是直接写入文件
)
logging.debug("msg1")
logging.info("msg2")
logging.warning("msg3> ")
logging.error("msg4")
logging.critical("msg5")	

一段生产环境所使用的日志封装的demo,为了避免每日产生的接口日志较大,这里使用的是根据时间日期切换的方式

class Logging:
    def __init__(self, log_folder, log_filename, log_ident):
        self.formatter = logging.Formatter(LOG_FORMAT, LOG_FORMAT_TIME)
        self.logger = None
        self.handler = None

        self.log_folder = log_folder
        self.log_filename = log_filename
        self.log_ident = log_ident

    def init(self):
        # 路径检查
        self.log_folder = os.path.join(
            os.path.dirname(BASE_DIR), self.log_folder)
        if not os.path.exists(self.log_folder):
            os.mkdir(self.log_folder)

        # 日志路径
        self.log_filename = os.path.join(self.log_folder, self.log_filename)

        # 日志类初始化
        self.logger = logging.getLogger(self.log_ident)

    def rotating_handler(self, when, count):
        # TimedRotatingFileHandler 所生成的日志对象为 根据when 时间进行切换的
        self.handler = TimedRotatingFileHandler(
            filename=self.log_filename,
            when=when,
            backupCount=count,
            encoding='utf-8'
        )
        self.handler.suffix = "%m-%d_%H-%M"